HyperX.Scripting.Api
The HyperX C# Scripting Application Programming Interface
Loading...
Searching...
No Matches
HyperX.Scripting.Foam Class Referencesealed

Foam material. More...

Public Member Functions

FoamTemperature AddTemperatureProperty (float Temperature, float Et, float Ec, float G, float Ftu, float Fcu, float Fsu, float? Ef=null, float? Ffu=null, float? K=null, float? C=null)
 Adds a temperature-dependent property for a material.
bool DeleteTemperatureProperty (float Temperature)
 Deletes a temperature-dependent property for a material.
FoamTemperature GetTemperature (float LookupTemperature)
 Retrieve a Temperature from this material's temperature-dependent properties. Allows a degree of tolerance to avoid issues with floating point numbers.
void Save ()
 Save any changes to this foam material to the database.

Public Attributes

List< FoamTemperatureFoamTemperatureProperties
 List of this material's temperature-dependent properties.

Properties

double? Absorption [get, set]
double? BucklingStiffnessKnockdown [get, set]
double? Cost [get, set]
DateTime CreationDate [get]
 Date the material was created.
double Density [get, set]
 Density. Eng: lbm/in^3 / SI: kg/m^3.
int? FemMaterialId [get, set]
 Linked FEM Material ID. Null if none exists.
string Form [get, set]
int Id [get]
string Manufacturer [get, set]
string MaterialDescription [get, set]
string MaterialFamilyName [get, set]
 The material family for this material. When the material is saved, a new family will be created if none matching this name exists.
DateTime ModificationDate [get]
 Most recent modification date of the material.
string Name [get, set]
 Name of this material.
string Specification [get, set]
string UserNote [get, set]
bool Wet [get, set]

Detailed Description

Foam material.

Member Function Documentation

◆ AddTemperatureProperty()

FoamTemperature HyperX.Scripting.Foam.AddTemperatureProperty ( float Temperature,
float Et,
float Ec,
float G,
float Ftu,
float Fcu,
float Fsu,
float? Ef = null,
float? Ffu = null,
float? K = null,
float? C = null )

Adds a temperature-dependent property for a material.

///

Returns
The newly created temperature-dependent property.

◆ DeleteTemperatureProperty()

bool HyperX.Scripting.Foam.DeleteTemperatureProperty ( float Temperature)

Deletes a temperature-dependent property for a material.

◆ GetTemperature()

FoamTemperature HyperX.Scripting.Foam.GetTemperature ( 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.
Returns
The temperature, if a matching one was found. Returns 'null' if none exists.

◆ Save()

void HyperX.Scripting.Foam.Save ( )

Save any changes to this foam material to the database.

Member Data Documentation

◆ FoamTemperatureProperties

List<FoamTemperature> HyperX.Scripting.Foam.FoamTemperatureProperties

List of this material's temperature-dependent properties.

Property Documentation

◆ Absorption

double? HyperX.Scripting.Foam.Absorption
getset

◆ BucklingStiffnessKnockdown

double? HyperX.Scripting.Foam.BucklingStiffnessKnockdown
getset

◆ Cost

double? HyperX.Scripting.Foam.Cost
getset

◆ CreationDate

DateTime HyperX.Scripting.Foam.CreationDate
get

Date the material was created.

◆ Density

double HyperX.Scripting.Foam.Density
getset

Density. Eng: lbm/in^3 / SI: kg/m^3.

◆ FemMaterialId

int? HyperX.Scripting.Foam.FemMaterialId
getset

Linked FEM Material ID. Null if none exists.

◆ Form

string HyperX.Scripting.Foam.Form
getset

◆ Id

int HyperX.Scripting.Foam.Id
get

◆ Manufacturer

string HyperX.Scripting.Foam.Manufacturer
getset

◆ MaterialDescription

string HyperX.Scripting.Foam.MaterialDescription
getset

◆ MaterialFamilyName

string HyperX.Scripting.Foam.MaterialFamilyName
getset

The material family for this material. When the material is saved, a new family will be created if none matching this name exists.

◆ ModificationDate

DateTime HyperX.Scripting.Foam.ModificationDate
get

Most recent modification date of the material.

◆ Name

string HyperX.Scripting.Foam.Name
getset

Name of this material.

◆ Specification

string HyperX.Scripting.Foam.Specification
getset

◆ UserNote

string HyperX.Scripting.Foam.UserNote
getset

◆ Wet

bool HyperX.Scripting.Foam.Wet
getset

The documentation for this class was generated from the following file: