HyperX.Solver.Api 1.23.0
The HyperX Solver Application Programming Interface
Loading...
Searching...
No Matches
HyperX.Solver.Api Namespace Reference

Classes

class  AnalysisResult
 A single analysis result. Use this to return the analysis result from a criterion that does not use batch loads. More...
class  AnalysisResultList
 Analysis results per load scenario. Use this to return results from a criterion that does use batch loads. More...
class  AnalyzableRepresentationException
 An analyzable cannot be represented in this way. More...
class  ConceptDefinition
class  Constants
class  CriteriaConfig
class  CriteriaSetConfig
class  CriterionDefinitionConfig
class  CriterionException
 General exception thrown by a criterion. More...
class  CriterionModule
 ENTRY POINT. More...
class  DetailName
class  DrawOptions
 Options to support IAnalyzable.Draw() methods. More...
class  ExtensionUtilities
interface  IAllowableCurve
interface  IAnalyzable
 An entity which can be analyzed in HyperX. More...
interface  IAnalyzableChanges
interface  IBBox
 Bounding box. More...
interface  IBeamElement
interface  IBeamLoad
interface  IBeamRep
 An analytical representation of a 'beam'. More...
interface  IBeamStiffness
interface  IBeamStrain
interface  ICorrectedAllowable
interface  ICorrectedLaminateAllowable
interface  ICorrectionFactor
 Represents a single correction. More...
interface  ICriterionDefinition
interface  ICriterionInput
interface  ICriterionResult
 Result data from a criterion. Must include a single result if the criterion is not set up for batch loads. Must include a result per load if the criterion is set up for batch loads. More...
interface  IDetailTree
interface  IDiscreteFieldTable
interface  IFoamProperties
interface  IHoneycombProperties
interface  IInitData
interface  IIsotropicProperties
interface  ILaminateProperties
interface  ILoadElement
interface  ILoadScenarioId
interface  ILocatedPlateLoad
interface  ILocatedPlateStrain
interface  IMaterial
 This interface represents any material. Different MaterialTypes have different properties available. Properties that are unavailable will throw, and be logged as DataRequired. To indicate that your analysis requires a particular property that doesn't exist, you can use the MaterialDataRequiredException. More...
interface  IMathUtility
interface  IMatrix33
interface  IMatrixAbd
class  InvalidEnumException
 An enum is invalid. More...
class  InvalidTcaException
 TCA is invalid. More...
interface  IOrthotropicProperties
interface  IPlaneStrain
interface  IPlaneStress
interface  IPlateLoad
interface  IPlateRep
 An analytical representation of a 'plate'. More...
interface  IPlateStiffness
interface  IPlateStrain
interface  IPly
 A single ply within a laminate. More...
interface  IPoint3D
interface  IPointXY
interface  IPointYZ
interface  IPreProcessedData
interface  IReadOnlyPreProcessedData
 Custom data can be pre-processed up front for several related criteria. More...
interface  IReadOnlySampleCalcItemList
interface  IResultData
interface  ISampleCalcInput
interface  ISampleCalcOutput
interface  ISettingDefinition
interface  ISettingList
interface  IShellElement
interface  ISolverUtility
interface  IStiffnessConstraints
interface  IStiffnessProperties
interface  ITableColumn
 Represents a column in a discrete field table. More...
interface  ITableEntry
 Represents a single cell in a discrete field table. More...
interface  ITableRow
 Represents a row in a discrete field table. More...
interface  IThermalProperties
interface  IVector3
class  Margin
class  MarginResultData
class  MaterialDataRequiredException
 Material data is required for an analysis. More...
class  MaterialTypeException
 The material type is invalid for an operation. More...
class  MathUtilities
class  Matrix33BoundsException
 Matrix33 index is out of bounds. More...
class  MatrixAbdBoundsException
 ABD matrix index is out of bounds. More...
class  ObjectCategoriesExtensions
class  ObjectDefinition
class  ObjectId
class  ObjectIds
 Native, aka "built-in", HyperX concepts. More...
class  PlyIndexException
 A ply index is out of bounds. More...
class  SampleCalcItemConfig
class  SampleCalcItemList
class  SampleCalcOutput
class  SampleCalcValue
class  SelectionOption
class  SettingDefinitionConfig
class  SolverApiException
 An exception thrown by a the Solver API layer. More...
class  Util
class  Vector3BoundsException
 Vector3 index is out of bounds. More...

Enumerations

enum  BeamLoadReference {
  CenterTop , CenterCenter , CenterBottom , LeftTop ,
  LeftCenter , LeftBottom , RightTop , RightCenter ,
  RightBottom , NeutralAxis
}
enum  CorrectionType {
  Invalid = 0 , Correction1 = 1 , Correction2 = 2 , Correction3 = 8 ,
  Correction4 = 9 , Correction5 = 7 , Correction6 = 4 , Correction7 = 3 ,
  Correction8 = 5 , Correction9 = 6
}
enum  CriterionCategory {
  None , Strength , Buckling , Crippling ,
  Stiffness , Temperature , Deformation , Frequency ,
  Geometry
}
enum  CriterionPriority { LongRunning = -1 , Default = 0 , Screening = 1 }
enum  CriterionScope { ConceptBased , ObjectBased }
enum  CurvatureDirection {
  InternalX = +1 , ExternalX = -1 , InternalY = +2 , ExternalY = -2 ,
  None = 0
}
enum  DiscreteFieldDataType { Unknown = 0 , Vector = 1 , Double = 2 , Text = 3 }
 Defines the type of data stored in the cell of a discrete field table. More...
enum  DiscreteFieldEntityType {
  Unknown = 0 , Element = 1 , Zone = 2 , Joint = 3 ,
  Grid = 4 , SectionCut = 5 , Solid = 6 , Point = 7
}
 Represents the physical entity type contained in a discrete field (e.g. zone, element, point, etc.). More...
enum  ElementType { Shell = 0 , Beam = 1 }
enum  EntityType { Unknown = 0 , Zone = 1 }
 Analysis entity type. Entity ID is unique within an entity type. More...
enum  InterpolationStatus { Success = 0 , Failed = 1 , Bounds = 2 }
enum  LaminateAllowableMethod {
  None = 0 , AML = 1 , Percent0 = 2 , Percent45 = 3 ,
  Polynomial = 999 , BypassStress = 4
}
enum  LaminateAllowableProperty {
  None = 0 , StrainTensionPristine = 1 , StrainCompressionPristine = 2 , StrainShearPristine = 3 ,
  StrainTensionOHT = 4 , StrainCompressionOHC = 5 , StressBearing = 6 , StrainCompressionCAI = 9 ,
  StrainCompressionFHC = 10 , StrainCompressionBVID = 11 , StrainTensionTAI = 12 , StrainTensionFHT = 13 ,
  StrainShearSAI = 14 , StressPullThrough = 15 , StressBearingBypass = 16 , StressBypass = 17
}
enum  LimitUltimate { Limit , Ultimate }
enum  LoadCaseType { Static , Fatigue }
enum  LoadProcessingTechnique {
  ElementBased , NeighborAveraging , Peak , Average ,
  Statistical , UserFeaLoads
}
enum  LoadScenarioType { Strength , Buckling }
 Design-to loads may be processed one way for strength analysis, and a different way for buckling analysis. Criteria are able to specify which load scenario type(s) they are valid for. More...
enum  MarginCode {
  Value = 0 , PassedDataRequired = 1 , PassedNA , PassedNAMaterial ,
  PassedBounds , PassedGeometry , PassedPositiveLoad , PassedNegativeLoad ,
  PassedSkipped , PassedHigh , Failed = -1 , FailedLow = -2 ,
  FailedDataRequired = -3 , FailedGeometry = -4
}
enum  MaterialTca { Tension , Compression , Average }
 Material properties may be given as tension, compression, or averaged. More...
enum  MaterialType {
  Foam , Honeycomb , Isotropic , Orthotropic ,
  EffectiveLaminate , DiscreteLaminate
}
enum  MechanicalFactorType { None , Limit , Ultimate }
enum  ObjectCategories {
  None = 0 , Facesheet = 1 << 0 , Flange = 1 << 1 , Web = 1 << 2 ,
  Attached = 1 << 3 , Bonded = 1 << 4 , Fastened = 1 << 5 , OneSided = 1 << 6 ,
  TwoSided = 1 << 7 , Capped = 1 << 8 , Core = 1 << 9 , Stiffener = 1 << 10 ,
  BondedCombo = 1 << 11 , SpacingSpan = 1 << 12 , CorrugatedSpan = 1 << 13
}
 Common categories an object might fall into. Associate an object with one or more of these types in the blueprint to allow more HyperX analysis to run on it without knowing about that blueprint specifically. More...
enum  PanelLoadReference {
  Top , TopFacesheetMidplane , Midplane , BottomFacesheetMidplane ,
  Bottom
}
 Applied load reference plane for panels. More...
enum  PlySurface { Top , Middle , Bottom }
enum  RepresentationType { Plate , Beam }
 Ways a portion of structure can be represented for analysis. More...
enum  SampleCalcDataType {
  Text = 0 , Integer , OptionalInteger , Double ,
  OptionalDouble , Boolean , Selection , Margin
}
enum  SettingDataType {
  Text , Integer , OptionalInteger , Double ,
  OptionalDouble , Boolean , Selection , OptionalMaterial
}
enum  SettingMaterialType {
  None = 0 , Isotropic = 1 << 0 , Orthotropic = 1 << 1 , DiscreteLaminate = 1 << 2 ,
  EffectiveLaminate = 1 << 3 , Honeycomb = 1 << 4 , Foam = 1 << 5
}
enum  ThermalFactorType { None , Hurt , Help }
enum  Unit {
  None , Mass , Distance , Area ,
  UnitForce , Force , UnitMoment , Moment ,
  Temperature , Stress , Strain , Margin ,
  Angle , ATerm , BTerm , DTerm ,
  InverseDTerm , EA , I , EI ,
  J , GJ , Curvature , Gamma
}

Enumeration Type Documentation

◆ BeamLoadReference

Enumerator
CenterTop 
CenterCenter 
CenterBottom 
LeftTop 
LeftCenter 
LeftBottom 
RightTop 
RightCenter 
RightBottom 
NeutralAxis 

Average, room temperature CN.

◆ CorrectionType

Enumerator
Invalid 
Correction1 
Correction2 
Correction3 
Correction4 
Correction5 
Correction6 
Correction7 
Correction8 
Correction9 

◆ CriterionCategory

Enumerator
None 
Strength 
Buckling 
Crippling 
Stiffness 
Temperature 
Deformation 
Frequency 
Geometry 

◆ CriterionPriority

Enumerator
LongRunning -1 
Default 
Screening 

◆ CriterionScope

Enumerator
ConceptBased 
ObjectBased 

◆ CurvatureDirection

Enumerator
InternalX +1 
ExternalX -1 
InternalY +2 
ExternalY -2 
None 

◆ DiscreteFieldDataType

Defines the type of data stored in the cell of a discrete field table.

Enumerator
Unknown 
Vector 
Double 
Text 

◆ DiscreteFieldEntityType

Represents the physical entity type contained in a discrete field (e.g. zone, element, point, etc.).

Enumerator
Unknown 
Element 
Zone 
Joint 
Grid 
SectionCut 
Solid 
Point 

◆ ElementType

Enumerator
Shell 
Beam 

◆ EntityType

Analysis entity type. Entity ID is unique within an entity type.

Intended for Zone, Joint, DsmSegment, DsmStringer, DsmSkin, etc. as Solver adds support for additional entities.

Enumerator
Unknown 
Zone 

◆ InterpolationStatus

Enumerator
Success 
Failed 
Bounds 

◆ LaminateAllowableMethod

Enumerator
None 
AML 
Percent0 
Percent45 
Polynomial 999 
BypassStress 

◆ LaminateAllowableProperty

Enumerator
None 
StrainTensionPristine 

Strain: Tension, Pristine.

StrainCompressionPristine 

Strain: Compression, Pristine.

StrainShearPristine 

Strain: Shear, Pristine.

StrainTensionOHT 

Strain: Tension, Open Hole (OHT).

StrainCompressionOHC 

Strain: Compression, Open Hole (OHC).

StressBearing 

Stress: Bearing.

StrainCompressionCAI 

Strain: Compression, After Impact (CAI).

StrainCompressionFHC 10 

Strain: Compression, Filled Hole (FHC).

StrainCompressionBVID 11 

Strain: Compression, Barely Visibile Impact Damage (BVID).

StrainTensionTAI 12 

Strain: Tension, After Impact (TAI).

StrainTensionFHT 13 

Strain: Tension, Filled Hole (FHT).

StrainShearSAI 14 

Strain: Shear, After Impact (SAI).

StressPullThrough 15 

Stress: Pull-Through.

StressBearingBypass 16 

Stress: Bearing-Bypass.

StressBypass 17 

Stress: Bypass.

◆ LimitUltimate

Enumerator
Limit 
Ultimate 

◆ LoadCaseType

Enumerator
Static 
Fatigue 

◆ LoadProcessingTechnique

Enumerator
ElementBased 
NeighborAveraging 
Peak 
Average 
Statistical 
UserFeaLoads 

◆ LoadScenarioType

Design-to loads may be processed one way for strength analysis, and a different way for buckling analysis. Criteria are able to specify which load scenario type(s) they are valid for.

Enumerator
Strength 
Buckling 

◆ MarginCode

Enumerator
Value 
PassedDataRequired 
PassedNA  
PassedNAMaterial  
PassedBounds  
PassedGeometry  
PassedPositiveLoad  
PassedNegativeLoad  
PassedSkipped  
PassedHigh  
Failed -1 
FailedLow -2 
FailedDataRequired -3 
FailedGeometry -4 

◆ MaterialTca

Material properties may be given as tension, compression, or averaged.

Enumerator
Tension 
Compression 
Average 

◆ MaterialType

Enumerator
Foam 
Honeycomb 
Isotropic 
Orthotropic 
EffectiveLaminate 
DiscreteLaminate 

◆ MechanicalFactorType

Enumerator
None 
Limit 
Ultimate 

◆ ObjectCategories

Common categories an object might fall into. Associate an object with one or more of these types in the blueprint to allow more HyperX analysis to run on it without knowing about that blueprint specifically.

Use with extension methods .IsAnyOf, IsNoneOf, .IsAllOf, .IsExactly

Enumerator
None 
Facesheet 1 << 0 

The 'skin'.

Flange 1 << 1 

Horizontal members of a stiffener or beam.

Web 1 << 2 

Vertical member of a stiffener or beam. (Includes the non-horizontal members of hats).

Attached 1 << 3 

via bonded or fastened. (historically: 'foot')

Bonded 1 << 4 

A bonded skin or flange is bonded.

Fastened 1 << 5 

A fastened skin or flange is fastened.

OneSided 1 << 6 

One side free.

TwoSided 1 << 7 

Two (both) sides free.

Capped 1 << 8 

No sides free (crown of hat, side of box, web of a I).

Core 1 << 9 

Core of a sandwich.

Stiffener 1 << 10 

Group: Stiffener of a panel or entire beam.

BondedCombo 1 << 11 

Group: Bonded skin and bonded flange.

SpacingSpan 1 << 12 

Group: Bonded skin, bonded flange, and open span.

CorrugatedSpan 1 << 13 

Group: Bonded skin, both bonded flanges, and open span.

◆ PanelLoadReference

Applied load reference plane for panels.

Enumerator
Top 

Top of the panel.

TopFacesheetMidplane 

Middle of the top facesheet.

Midplane 

Midplane of the panel (= H / 2).

BottomFacesheetMidplane 

Middle of the bottom facesheet.

Bottom 

Bottom of the panel.

◆ PlySurface

Enumerator
Top 
Middle 
Bottom 

◆ RepresentationType

Ways a portion of structure can be represented for analysis.

Enumerator
Plate 
Beam 

◆ SampleCalcDataType

Enumerator
Text 
Integer  
OptionalInteger  
Double  
OptionalDouble  
Boolean  
Selection  
Margin  

◆ SettingDataType

Enumerator
Text 
Integer 
OptionalInteger 
Double 
OptionalDouble 
Boolean 
Selection 
OptionalMaterial 

◆ SettingMaterialType

Enumerator
None 
Isotropic 1 << 0 
Orthotropic 1 << 1 
DiscreteLaminate 1 << 2 
EffectiveLaminate 1 << 3 
Honeycomb 1 << 4 
Foam 1 << 5 

◆ ThermalFactorType

Enumerator
None 
Hurt 
Help 

◆ Unit

Enumerator
None 
Mass 
Distance 
Area 
UnitForce 
Force 
UnitMoment 
Moment 
Temperature 
Stress 
Strain 
Margin 
Angle 
ATerm 
BTerm 
DTerm 
InverseDTerm 
EA 
EI 
GJ 
Curvature 
Gamma