hyperx.api.Foam Class Reference

Foam material. More...

Public Member Functions
	__init__ (self, _api.Foam foam)
FoamTemperature	AddTemperatureProperty (self, float temperature, float et, float ec, float g, float ftu, float fcu, float fsu, float ef=None, float ffu=None, float k=None, float c=None)
	Adds a temperature-dependent property for a material.
bool	DeleteTemperatureProperty (self, float temperature)
	Deletes a temperature-dependent property for a material.
FoamTemperature	GetTemperature (self, float lookupTemperature)
	Retrieve a Temperature from this material's temperature-dependent properties.
None	Save (self)
	Save any changes to this foam material to the database.

Protected Attributes
	_Entity = foam

Properties
	Absorption = property
	BucklingStiffnessKnockdown = property
	Cost = property
	CreationDate = property
	Date the material was created.
	Density = property
	Density.
	FemMaterialId = property
	Linked FEM Material ID.
	FoamTemperatureProperties = property
	List of this material's temperature-dependent properties.
	Form = property
	Id = property
	Manufacturer = property
	MaterialDescription = property
	MaterialFamilyName = property
	The material family for this material.
	ModificationDate = property
	Most recent modification date of the material.
	Name = property
	Name of this material.
	Specification = property
	UserNote = property
	Wet = property

Detailed Description

Foam material.

Constructor & Destructor Documentation

__init__()

hyperx.api.Foam.__init__	(		self,
		_api.Foam	foam )

Member Function Documentation

AddTemperatureProperty()

FoamTemperature hyperx.api.Foam.AddTemperatureProperty	(		self,
		float	temperature,
		float	et,
		float	ec,
		float	g,
		float	ftu,
		float	fcu,
		float	fsu,
		float	ef = None,
		float	ffu = None,
		float	k = None,
		float	c = None )

Adds a temperature-dependent property for a material.

Returns

The newly created temperature-dependent property.

DeleteTemperatureProperty()

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

Deletes a temperature-dependent property for a material.

GetTemperature()

FoamTemperature hyperx.api.Foam.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

LookupTemperature

Temperature to search for.

Returns

The temperature, if a matching one was found. Returns None if none exists.

Save()

None hyperx.api.Foam.Save

(

self

)

Save any changes to this foam material to the database.

Member Data Documentation

_Entity

hyperx.api.Foam._Entity = foam

protected

Property Documentation

Absorption

hyperx.api.Foam.Absorption = property

static

BucklingStiffnessKnockdown

hyperx.api.Foam.BucklingStiffnessKnockdown = property

static

Cost

hyperx.api.Foam.Cost = property

static

CreationDate

hyperx.api.Foam.CreationDate = property

static

Date the material was created.

Density

hyperx.api.Foam.Density = property

static

Density.

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

FemMaterialId

hyperx.api.Foam.FemMaterialId = property

static

Linked FEM Material ID.

Null if none exists.

FoamTemperatureProperties

hyperx.api.Foam.FoamTemperatureProperties = property

static

List of this material's temperature-dependent properties.

Form

hyperx.api.Foam.Form = property

static

Id

hyperx.api.Foam.Id = property

static

Manufacturer

hyperx.api.Foam.Manufacturer = property

static

MaterialDescription

hyperx.api.Foam.MaterialDescription = property

static

MaterialFamilyName

hyperx.api.Foam.MaterialFamilyName = property

static

The material family for this material.

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

ModificationDate

hyperx.api.Foam.ModificationDate = property

static

Most recent modification date of the material.

Name

hyperx.api.Foam.Name = property

static

Name of this material.

Specification

hyperx.api.Foam.Specification = property

static

UserNote

hyperx.api.Foam.UserNote = property

static

Wet

hyperx.api.Foam.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