HyperX.Scripting.Python.Api
The HyperX Scripting Library for Python
Loading...
Searching...
No Matches
hyperx.api.Orthotropic Class Reference

Orthotropic material. More...

Public Member Functions

 __init__ (self, _api.Orthotropic orthotropic)
OrthotropicEquationCorrectionFactor AddEquationCorrectionFactor (self, types.CorrectionProperty propertyId, types.CorrectionId correctionId, types.CorrectionEquation equationId)
 Adds an equation-based correction factor for this material.
OrthotropicLaminateAllowable AddLaminateAllowable (self, types.AllowablePropertyName property, types.AllowableMethodName method)
 Adds a laminate allowable to this material.
OrthotropicTemperature AddTemperatureProperty (self, float temperature, float et1, float et2, float vt12, float ec1, float ec2, float vc12, float g12, float ftu1, float ftu2, float fcu1, float fcu2, float fsu12, float alpha1, float alpha2, float etu1, float etu2, float ecu1, float ecu2, float esu12)
 Adds a temperature-dependent property for a material.
bool DeleteTemperatureProperty (self, float temperature)
 Deletes a temperature-dependent property for a material.
OrthotropicEquationCorrectionFactor GetEquationCorrectionFactor (self, types.CorrectionProperty property, types.CorrectionId correction)
 Retrieve a Correction Factor from this material's correction factors.
OrthotropicLaminateAllowable GetLaminateAllowable (self, types.AllowablePropertyName lookupAllowableProperty)
 Retrieve a Laminate allowable from this material's laminate allowables.
OrthotropicTabularCorrectionFactor GetTabularCorrectionFactor (self, types.CorrectionProperty property, types.CorrectionId correction)
 Retrieve a Correction Factor from this material's correction factors.
OrthotropicTemperature GetTemperature (self, float lookupTemperature)
 Retrieve a Temperature from this material's temperature-dependent properties.
bool HasLaminateAllowable (self, types.AllowablePropertyName property)
 Returns true if this material has a specified laminate allowable property.
bool IsEffectiveLaminate (self)
 Returns true if this material is an effective laminate.
None Save (self)
 Save any changes to this orthotropic material to the database.

Protected Attributes

 _Entity = orthotropic

Properties

 Basis = property
 BendingCorrectionFactor = property
 BucklingStiffnessKnockdown = property
 Cost = property
 CreationDate = property
 Density = property
 FemMaterialId = property
 FiberVolume = property
 Form = property
 GlassTransition = property
 Id = property
 Manufacturer = property
 MaterialDescription = property
 MaterialFamilyName = property
 ModificationDate = property
 Name = property
 OrthotropicEffectiveLaminate = property
 Orthotropic material effective laminate properties.
 OrthotropicEquationCorrectionFactors = property
 OrthotropicLaminateAllowables = property
 OrthotropicTabularCorrectionFactors = property
 OrthotropicTemperatureProperties = property
 Processes = property
 Specification = property
 Thickness = property
 UserNote = property
 Wet = property

Detailed Description

Orthotropic material.

Constructor & Destructor Documentation

◆ __init__()

hyperx.api.Orthotropic.__init__ ( self,
_api.Orthotropic orthotropic )

Member Function Documentation

◆ AddEquationCorrectionFactor()

OrthotropicEquationCorrectionFactor hyperx.api.Orthotropic.AddEquationCorrectionFactor ( self,
types.CorrectionProperty propertyId,
types.CorrectionId correctionId,
types.CorrectionEquation equationId )

Adds an equation-based correction factor for this material.

Parameters
propertyIdThe ID of the property to be affected by the correction factor. Specified with a CorrectionPropertyName enum.
correctionIdThe ID for the type of correction factor to be applied. Specified with a CorrectionIDName enum.
equationIdThe ID for the type of correction factor equation to use. Specified with a CorrectionEquationName enum.

◆ AddLaminateAllowable()

OrthotropicLaminateAllowable hyperx.api.Orthotropic.AddLaminateAllowable ( self,
types.AllowablePropertyName property,
types.AllowableMethodName method )

Adds a laminate allowable to this material.

An orthotropic material can only have one laminate allowable of each property (as specified by the property argument).

Parameters
propertyThe strain or stress property for a laminate allowable.
methodThe method for a laminate allowable (AML, Percent 0/45, Polynomial).

◆ AddTemperatureProperty()

OrthotropicTemperature hyperx.api.Orthotropic.AddTemperatureProperty ( self,
float temperature,
float et1,
float et2,
float vt12,
float ec1,
float ec2,
float vc12,
float g12,
float ftu1,
float ftu2,
float fcu1,
float fcu2,
float fsu12,
float alpha1,
float alpha2,
float etu1,
float etu2,
float ecu1,
float ecu2,
float esu12 )

Adds a temperature-dependent property for a material.

◆ DeleteTemperatureProperty()

bool hyperx.api.Orthotropic.DeleteTemperatureProperty ( self,
float temperature )

Deletes a temperature-dependent property for a material.

◆ GetEquationCorrectionFactor()

OrthotropicEquationCorrectionFactor hyperx.api.Orthotropic.GetEquationCorrectionFactor ( self,
types.CorrectionProperty property,
types.CorrectionId correction )

Retrieve a Correction Factor from this material's correction factors.

Parameters
propertyCorrectionPropertyName to search for.
correctionCorrectionIDName to search for.

◆ GetLaminateAllowable()

OrthotropicLaminateAllowable hyperx.api.Orthotropic.GetLaminateAllowable ( self,
types.AllowablePropertyName lookupAllowableProperty )

Retrieve a Laminate allowable from this material's laminate allowables.

Parameters
LookupAllowablePropertyLaminate allowable property to search for.

◆ GetTabularCorrectionFactor()

OrthotropicTabularCorrectionFactor hyperx.api.Orthotropic.GetTabularCorrectionFactor ( self,
types.CorrectionProperty property,
types.CorrectionId correction )

Retrieve a Correction Factor from this material's correction factors.

Parameters
propertyCorrectionPropertyName to search for.
correctionCorrectionIDName to search for.

◆ GetTemperature()

OrthotropicTemperature hyperx.api.Orthotropic.GetTemperature ( self,
float lookupTemperature )

Retrieve a Temperature from this material's temperature-dependent properties.

Allows a degree of tolerance to avoid issues with floating point numbers.

Parameters
LookupTemperatureTemperature to search for.

◆ HasLaminateAllowable()

bool hyperx.api.Orthotropic.HasLaminateAllowable ( self,
types.AllowablePropertyName property )

Returns true if this material has a specified laminate allowable property.

◆ IsEffectiveLaminate()

bool hyperx.api.Orthotropic.IsEffectiveLaminate ( self)

Returns true if this material is an effective laminate.

◆ Save()

None hyperx.api.Orthotropic.Save ( self)

Save any changes to this orthotropic material to the database.

Member Data Documentation

◆ _Entity

hyperx.api.Orthotropic._Entity = orthotropic
protected

Property Documentation

◆ Basis

hyperx.api.Orthotropic.Basis = property
static

◆ BendingCorrectionFactor

hyperx.api.Orthotropic.BendingCorrectionFactor = property
static

◆ BucklingStiffnessKnockdown

hyperx.api.Orthotropic.BucklingStiffnessKnockdown = property
static

◆ Cost

hyperx.api.Orthotropic.Cost = property
static

◆ CreationDate

hyperx.api.Orthotropic.CreationDate = property
static

◆ Density

hyperx.api.Orthotropic.Density = property
static

◆ FemMaterialId

hyperx.api.Orthotropic.FemMaterialId = property
static

◆ FiberVolume

hyperx.api.Orthotropic.FiberVolume = property
static

◆ Form

hyperx.api.Orthotropic.Form = property
static

◆ GlassTransition

hyperx.api.Orthotropic.GlassTransition = property
static

◆ Id

hyperx.api.Orthotropic.Id = property
static

◆ Manufacturer

hyperx.api.Orthotropic.Manufacturer = property
static

◆ MaterialDescription

hyperx.api.Orthotropic.MaterialDescription = property
static

◆ MaterialFamilyName

hyperx.api.Orthotropic.MaterialFamilyName = property
static

◆ ModificationDate

hyperx.api.Orthotropic.ModificationDate = property
static

◆ Name

hyperx.api.Orthotropic.Name = property
static

◆ OrthotropicEffectiveLaminate

hyperx.api.Orthotropic.OrthotropicEffectiveLaminate = property
static

Orthotropic material effective laminate properties.

Read-only from the API. Check if material is an effective laminate with orthotropic.IsEffectiveLaminate.

◆ OrthotropicEquationCorrectionFactors

hyperx.api.Orthotropic.OrthotropicEquationCorrectionFactors = property
static

◆ OrthotropicLaminateAllowables

hyperx.api.Orthotropic.OrthotropicLaminateAllowables = property
static

◆ OrthotropicTabularCorrectionFactors

hyperx.api.Orthotropic.OrthotropicTabularCorrectionFactors = property
static

◆ OrthotropicTemperatureProperties

hyperx.api.Orthotropic.OrthotropicTemperatureProperties = property
static

◆ Processes

hyperx.api.Orthotropic.Processes = property
static

◆ Specification

hyperx.api.Orthotropic.Specification = property
static

◆ Thickness

hyperx.api.Orthotropic.Thickness = property
static

◆ UserNote

hyperx.api.Orthotropic.UserNote = property
static

◆ Wet

hyperx.api.Orthotropic.Wet = property
static

The documentation for this class was generated from the following file:
  • C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py