CIP JavaScript documentation for class " pfcMaterial"

Class pfcMaterial

Description

This class provides information about a material.

Direct Parent Classes:: pfcParameterOwner, pfcChild

Property Summary


`string`	`BendTable`
	The bend table

`string`	`Condition`
	The condition

`/* optional */ string`	`CrossHatchFile`
	The name of the cross-hatching file used in detailing for this material.

`/* optional */ string`	`Description`
	The material description string.

`number`	`Emissivity`
	The emissivity

`/* optional */ string`	`FailureCriterion`
	The failure criterion.

`/* optional */ string`	`FatigueMaterialFinish`
	The fatigue material finish.

`/* optional */ string`	`FatigueMaterialType`
	The fatigue material type.

`/* optional */ string`	`FatigueType`
	The fatigue type.

`pfcMaterialType`	`FluidMaterialType`
	The material type for the fluid properties.

`number`	`Hardness`
	The hardness

`/* optional */ string`	`HardnessType`
	The hardness type.

`/* readonly */ number`	`Id`
	The id of the material

`number`	`InitBendYFactor`
	The initial bend Y-factor

`number`	`MassDensity`
	The mass density

`/* optional */ string`	`MaterialModel`
	The type of hyperelastic material model.

`/* optional */ boolean`	`ModelDefByTests`
	Specifies whether the selected hyperelastic material model is defined using test data.

`/* readonly */ string`	`Name`
	The name of the material

`/* readonly */ stringseq`	`PermittedFailureCriteria`
	A list of the permitted string values for the material failure criterion.

`/* readonly */ stringseq`	`PermittedFatigueMaterialFinishes`
	A list of the permitted string values for the material fatigue material finish.

`/* readonly */ stringseq`	`PermittedFatigueMaterialTypes`
	A list of the permitted string values for the material fatigue material type.

`/* readonly */ stringseq`	`PermittedFatigueTypes`
	A list of the permitted string values for the material fatigue type.

`/* readonly */ stringseq`	`PermittedMaterialModels`
	A list of the permitted string values for the material model.

`/* readonly */ stringseq`	`PermittedSubTypes`
	A list of the permitted string values for the material sub type.

`number`	`PoissonRatio`
	The isotropic Poisson's ratio

`number`	`ShearModulus`
	The isotropic shear modulus

`number`	`SpecificHeat`
	The specific heat

`number`	`StressLimCompress`
	The isotropic compression ultimate stress.

`number`	`StressLimShear`
	The shear ultimate stress.

`number`	`StressLimTension`
	The isotropic tensile ultimate stress.

`number`	`StructDampCoef`
	The structural damping coefficient

`pfcMaterialType`	`StructuralMaterialType`
	The material type for the structural properties.

`/* optional */ string`	`SubType`
	The isotropic material type's sub type.

`pfcMaterialType`	`ThermalMaterialType`
	The material type for the thermal properties.

`number`	`ThermConductivity`
	The isotropic thermal conductivity

`number`	`ThermExpCoef`
	The isotropic thermal expansion coefficient

`number`	`ThermExpRefTemp`
	The thermal expansion reference temperature

`number`	`YoungModulus`
	The isotropic Young's modulus

Method Summary


`void`	`Delete ()`
	Deletes the material from the part's database.

`/* optional */ pfcMaterialProperty`	`GetPropertyValue (pfcMaterialPropertyType Type)`
	Returns the value and units for a material property.

`void`	`RemoveProperty (pfcMaterialPropertyType Type)`
	Removes a material property.

`void`	`Save (string FileName)`
	Writes the specified part material to a file.

`void`	`SetCurrent ()`
	Sets the current material to its owner part.

`void`	`SetPropertyUnits (pfcMaterialPropertyType Type, string Units, /* optional */ boolean Convert)`
	Sets the units for a material property.

`void`	`SetPropertyValue (pfcMaterialPropertyType Type, pfcMaterialProperty Value)`
	Sets the value and units for a material property.

Property Detail

string BendTable

The bend table

If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

string Condition

The condition

If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

/* optional */ string CrossHatchFile

The name of the cross-hatching file used in detailing for this material.

/* optional */ string Description

The material description string.

number Emissivity

The emissivity

If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

/* optional */ string FailureCriterion

The failure criterion.

Must be one of the members of pfcMaterial.PermittedFailureCriteria

/* optional */ string FatigueMaterialFinish

The fatigue material finish.

Must be one of the members of pfcMaterial.PermittedFatigueMaterialFinishes

/* optional */ string FatigueMaterialType

The fatigue material type.

Must be one of the members of pfcMaterial.PermittedFatigueMaterialTypes

/* optional */ string FatigueType

The fatigue type.

Must be one of the members of pfcMaterial.PermittedFatigueTypes

pfcMaterialType FluidMaterialType

The material type for the fluid properties.

number Hardness

The hardness

If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

/* optional */ string HardnessType

The hardness type.

/* readonly */ number Id

The id of the material

number InitBendYFactor

The initial bend Y-factor

If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number MassDensity

The mass density

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().

/* optional */ string MaterialModel

The type of hyperelastic material model.

Must be one of the members of pfcMaterial.PermittedMaterialModels

/* optional */ boolean ModelDefByTests

Specifies whether the selected hyperelastic material model is defined using test data.

/* readonly */ string Name

The name of the material

/* readonly */ stringseq PermittedFailureCriteria

A list of the permitted string values for the material failure criterion.

/* readonly */ stringseq PermittedFatigueMaterialFinishes

A list of the permitted string values for the material fatigue material finish.

/* readonly */ stringseq PermittedFatigueMaterialTypes

A list of the permitted string values for the material fatigue material type.

/* readonly */ stringseq PermittedFatigueTypes

A list of the permitted string values for the material fatigue type.

/* readonly */ stringseq PermittedMaterialModels

A list of the permitted string values for the material model.

/* readonly */ stringseq PermittedSubTypes

A list of the permitted string values for the material sub type.

number PoissonRatio

The isotropic Poisson's ratio

If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number ShearModulus

The isotropic shear modulus

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number SpecificHeat

The specific heat

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number StressLimCompress

The isotropic compression ultimate stress.

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.
Compression stress values must be negative.
If the current material failure criterion doesn't accept this type, an attempt to set it will throw a pfcXToolkitBadContext exception.

number StressLimShear

The shear ultimate stress.

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.
If the current material failure criterion doesn't accept this type, an attempt to set it will throw a pfcXToolkitBadContext exception.

number StressLimTension

The isotropic tensile ultimate stress.

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.
If the current material failure criterion doesn't accept this type, an attempt to set it will throw a pfcXToolkitBadContext exception.

number StructDampCoef

The structural damping coefficient

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

pfcMaterialType StructuralMaterialType

The material type for the structural properties.

/* optional */ string SubType

The isotropic material type's sub type.

Must be one of the members of pfcMaterial.PermittedSubTypes

pfcMaterialType ThermalMaterialType

The material type for the thermal properties.

number ThermConductivity

The isotropic thermal conductivity

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number ThermExpCoef

The isotropic thermal expansion coefficient

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number ThermExpRefTemp

The thermal expansion reference temperature

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

number YoungModulus

The isotropic Young's modulus

This accesses the property value in the units of the model that owns this material. To access the value using its assigned units as you would find in the user interface, use pfcMaterial.GetPropertyValue() and pfcMaterial.SetPropertyValue().
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

Method Detail

void Delete ()

Deletes the material from the part's database.

/* optional */ pfcMaterialProperty GetPropertyValue (pfcMaterialPropertyType Type)

Returns the value and units for a material property.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

The material property unit type was not recognized, OR
The material does not have this property assigned.

Parameters:

Type: The type of property to retrieve.

Returns:: The value and units, or null, if the property is not set on the material.

void RemoveProperty (pfcMaterialPropertyType Type)

Removes a material property.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This property does not exist on the material.

pfcXToolkitBadContext - This property cannot be deleted on the material (because other properties assigned to the material already do not permit it).

Parameters:

Type: The type of property to remove.

void Save (string FileName)

Writes the specified part material to a file.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function is not available in Design Test Mode.

Parameters:

FileName: The name of the output material file

void SetCurrent ()

Sets the current material to its owner part.

void SetPropertyUnits (pfcMaterialPropertyType Type, string Units, /* optional */ boolean Convert)

Sets the units for a material property.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - This property cannot be created on the material (because other properties assigned to the material already do not permit it).

pfcXToolkitNotValid - The new value for the property lies outside the permitted ranges for the property.

pfcXToolkitInvalidType - The new units for the property are not correct for this property type.

pfcXToolkitCantModify - Cannot change the value of the property because it is driven by a parameter, relation or function.

Parameters:

Type: The type of property to set.
Units: The units to use for the property.
Convert: true to convert the property value to the new units. false or null to interpret the current value in the new units.

void SetPropertyValue (pfcMaterialPropertyType Type, pfcMaterialProperty Value)

Sets the value and units for a material property.

If the property doesn't exist on the material, this method creates it.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - This property cannot be created on the material (because other properties assigned to the material already do not permit it).

pfcXToolkitNotValid - The new value for the property lies outside the permitted ranges for the property.

pfcXToolkitInvalidType - The new units for the property are not correct for this property type.

pfcXToolkitCantModify - Cannot change the value of the property because it is driven by a parameter, relation or function.

See Also:: pfcMaterialProperty.Create()

Parameters:

Type: The type of property to set.
Value: The value and units to use for the property