CIP C++ documentation for class "pfcMaterial"

Class pfcMaterial

# include <pfcPart.h> class pfcMaterial : public virtual pfcParameterOwner, : public virtual pfcChild { xaideclare(pfcMaterial) ... };

Description

This class provides information about a material.

Direct Known Subclasses:: wfcWMaterial

Method Summary


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

`xstring`	`GetBendTable ()`
`void`	`SetBendTable (xrstring value)`
	The bend table

`xstring`	`GetCondition ()`
`void`	`SetCondition (xrstring value)`
	The condition

`optional xstring`	`GetCrossHatchFile ()`
`void`	`SetCrossHatchFile (optional xrstring value)`
	The name of the cross-hatching file used in detailing for this material.

`optional xstring`	`GetDescription ()`
`void`	`SetDescription (optional xrstring value)`
	The material description string.

`xreal`	`GetEmissivity ()`
`void`	`SetEmissivity (xreal value)`
	The emissivity

`optional xstring`	`GetFailureCriterion ()`
`void`	`SetFailureCriterion (optional xrstring value)`
	The failure criterion.

`optional xstring`	`GetFatigueMaterialFinish ()`
`void`	`SetFatigueMaterialFinish (optional xrstring value)`
	The fatigue material finish.

`optional xstring`	`GetFatigueMaterialType ()`
`void`	`SetFatigueMaterialType (optional xrstring value)`
	The fatigue material type.

`optional xstring`	`GetFatigueType ()`
`void`	`SetFatigueType (optional xrstring value)`
	The fatigue type.

`pfcMaterialType`	`GetFluidMaterialType ()`
`void`	`SetFluidMaterialType (pfcMaterialType value)`
	The material type for the fluid properties.

`xreal`	`GetHardness ()`
`void`	`SetHardness (xreal value)`
	The hardness

`optional xstring`	`GetHardnessType ()`
`void`	`SetHardnessType (optional xrstring value)`
	The hardness type.

`xint`	`GetId ()`
	The id of the material

`xreal`	`GetInitBendYFactor ()`
`void`	`SetInitBendYFactor (xreal value)`
	The initial bend Y-factor

`xreal`	`GetMassDensity ()`
`void`	`SetMassDensity (xreal value)`
	The mass density

`optional xstring`	`GetMaterialModel ()`
`void`	`SetMaterialModel (optional xrstring value)`
	The type of hyperelastic material model.

`optional xbool`	`GetModelDefByTests ()`
`void`	`SetModelDefByTests (optional xbool value)`
	Specifies whether the selected hyperelastic material model is defined using test data.

`xstring`	`GetName ()`
	The name of the material

`xstringsequence_ptr`	`GetPermittedFailureCriteria ()`
	A list of the permitted string values for the material failure criterion.

`xstringsequence_ptr`	`GetPermittedFatigueMaterialFinishes ()`
	A list of the permitted string values for the material fatigue material finish.

`xstringsequence_ptr`	`GetPermittedFatigueMaterialTypes ()`
	A list of the permitted string values for the material fatigue material type.

`xstringsequence_ptr`	`GetPermittedFatigueTypes ()`
	A list of the permitted string values for the material fatigue type.

`xstringsequence_ptr`	`GetPermittedMaterialModels ()`
	A list of the permitted string values for the material model.

`xstringsequence_ptr`	`GetPermittedSubTypes ()`
	A list of the permitted string values for the material sub type.

`xreal`	`GetPoissonRatio ()`
`void`	`SetPoissonRatio (xreal value)`
	The isotropic Poisson's ratio

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

`xreal`	`GetShearModulus ()`
`void`	`SetShearModulus (xreal value)`
	The isotropic shear modulus

`xreal`	`GetSpecificHeat ()`
`void`	`SetSpecificHeat (xreal value)`
	The specific heat

`xreal`	`GetStressLimCompress ()`
`void`	`SetStressLimCompress (xreal value)`
	The isotropic compression ultimate stress.

`xreal`	`GetStressLimShear ()`
`void`	`SetStressLimShear (xreal value)`
	The shear ultimate stress.

`xreal`	`GetStressLimTension ()`
`void`	`SetStressLimTension (xreal value)`
	The isotropic tensile ultimate stress.

`xreal`	`GetStructDampCoef ()`
`void`	`SetStructDampCoef (xreal value)`
	The structural damping coefficient

`pfcMaterialType`	`GetStructuralMaterialType ()`
`void`	`SetStructuralMaterialType (pfcMaterialType value)`
	The material type for the structural properties.

`optional xstring`	`GetSubType ()`
`void`	`SetSubType (optional xrstring value)`
	The isotropic material type's sub type.

`pfcMaterialType`	`GetThermalMaterialType ()`
`void`	`SetThermalMaterialType (pfcMaterialType value)`
	The material type for the thermal properties.

`xreal`	`GetThermConductivity ()`
`void`	`SetThermConductivity (xreal value)`
	The isotropic thermal conductivity

`xreal`	`GetThermExpCoef ()`
`void`	`SetThermExpCoef (xreal value)`
	The isotropic thermal expansion coefficient

`xreal`	`GetThermExpRefTemp ()`
`void`	`SetThermExpRefTemp (xreal value)`
	The thermal expansion reference temperature

`xreal`	`GetYoungModulus ()`
`void`	`SetYoungModulus (xreal value)`
	The isotropic Young's modulus

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

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







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





























`void`	`SetPropertyUnits (pfcMaterialPropertyType Type, xrstring Units, optional xbool Convert)`
	Sets the units for a material property.

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

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Method Detail

xstring GetName ()

The name of the material

xint GetId ()

The id of the material

`pfcMaterialType`	`GetStructuralMaterialType`	`()`
`void`	`SetStructuralMaterialType`	`(pfcMaterialType value)`

The material type for the structural properties.

Manual References:: Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types

`pfcMaterialType`	`GetThermalMaterialType`	`()`
`void`	`SetThermalMaterialType`	`(pfcMaterialType value)`

The material type for the thermal properties.

Manual References:: Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types

`pfcMaterialType`	`GetFluidMaterialType`	`()`
`void`	`SetFluidMaterialType`	`(pfcMaterialType value)`

The material type for the fluid properties.

Manual References:: Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types

`optional xstring`	`GetDescription`	`()`
`void`	`SetDescription`	`(optional xrstring value)`

The material description string.

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`xstring`	`GetCondition`	`()`
`void`	`SetCondition`	`(xrstring value)`

The condition

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`xstring`	`GetBendTable`	`()`
`void`	`SetBendTable`	`(xrstring value)`

The bend table

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetHardnessType`	`()`
`void`	`SetHardnessType`	`(optional xrstring value)`

The hardness type.

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetCrossHatchFile`	`()`
`void`	`SetCrossHatchFile`	`(optional xrstring value)`

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetMaterialModel`	`()`
`void`	`SetMaterialModel`	`(optional xrstring value)`

The type of hyperelastic material model.

Must be one of the members of pfcMaterial::GetPermittedMaterialModels()

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

xstringsequence_ptr GetPermittedMaterialModels ()

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetSubType`	`()`
`void`	`SetSubType`	`(optional xrstring value)`

The isotropic material type's sub type.

Must be one of the members of pfcMaterial::GetPermittedSubTypes()

Manual References:: Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types

xstringsequence_ptr GetPermittedSubTypes ()

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

Manual References:: Solid: Accessing Material Types, Solid: Accessing Material Types

`optional xbool`	`GetModelDefByTests`	`()`
`void`	`SetModelDefByTests`	`(optional xbool value)`

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetFatigueType`	`()`
`void`	`SetFatigueType`	`(optional xrstring value)`

The fatigue type.

Must be one of the members of pfcMaterial::GetPermittedFatigueTypes()

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetFatigueMaterialType`	`()`
`void`	`SetFatigueMaterialType`	`(optional xrstring value)`

The fatigue material type.

Must be one of the members of pfcMaterial::GetPermittedFatigueMaterialTypes()

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetFatigueMaterialFinish`	`()`
`void`	`SetFatigueMaterialFinish`	`(optional xrstring value)`

The fatigue material finish.

Must be one of the members of pfcMaterial::GetPermittedFatigueMaterialFinishes()

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

xstringsequence_ptr GetPermittedFatigueTypes ()

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

xstringsequence_ptr GetPermittedFatigueMaterialTypes ()

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

xstringsequence_ptr GetPermittedFatigueMaterialFinishes ()

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

`optional xstring`	`GetFailureCriterion`	`()`
`void`	`SetFailureCriterion`	`(optional xrstring value)`

The failure criterion.

Must be one of the members of pfcMaterial::GetPermittedFailureCriteria()

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

xstringsequence_ptr GetPermittedFailureCriteria ()

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

optional pfcMaterialProperty_ptr 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.

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

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 SetPropertyValue (pfcMaterialPropertyType Type, pfcMaterialProperty_ptr 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(xreal, optional xrstring)

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

Parameters:

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

Returns:

void SetPropertyUnits (pfcMaterialPropertyType Type, xrstring Units, optional xbool 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.

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

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.

Returns:

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).

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties

Parameters:

Type: The type of property to remove.

Returns:

`xreal`	`GetYoungModulus`	`()`
`void`	`SetYoungModulus`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetPoissonRatio`	`()`
`void`	`SetPoissonRatio`	`(xreal value)`

The isotropic Poisson's ratio

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

`xreal`	`GetShearModulus`	`()`
`void`	`SetShearModulus`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetMassDensity`	`()`
`void`	`SetMassDensity`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).

`xreal`	`GetThermExpCoef`	`()`
`void`	`SetThermExpCoef`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetThermExpRefTemp`	`()`
`void`	`SetThermExpRefTemp`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetStructDampCoef`	`()`
`void`	`SetStructDampCoef`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetStressLimTension`	`()`
`void`	`SetStressLimTension`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
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.

`xreal`	`GetStressLimCompress`	`()`
`void`	`SetStressLimCompress`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
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.

`xreal`	`GetStressLimShear`	`()`
`void`	`SetStressLimShear`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
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.

`xreal`	`GetThermConductivity`	`()`
`void`	`SetThermConductivity`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetEmissivity`	`()`
`void`	`SetEmissivity`	`(xreal value)`

The emissivity

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

`xreal`	`GetSpecificHeat`	`()`
`void`	`SetSpecificHeat`	`(xreal value)`

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(pfcMaterialPropertyType) and pfcMaterial::SetPropertyValue(pfcMaterialPropertyType, pfcMaterialProperty_ptr).
If this property is not set on the material, an attempt to retrieve it will throw a pfcXToolkitNotFound exception.

`xreal`	`GetHardness`	`()`
`void`	`SetHardness`	`(xreal value)`

The hardness

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

Manual References:: Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties

`xreal`	`GetInitBendYFactor`	`()`
`void`	`SetInitBendYFactor`	`(xreal value)`

The initial bend Y-factor

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

void Delete ()

Deletes the material from the part's database.

Manual References:: Solid: Materials, Solid: Materials

Returns:

void Save (xrstring 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.

Manual References:: Solid: Materials, Solid: Materials

Parameters:

FileName: The name of the output material file

Returns:

void SetCurrent ()

Sets the current material to its owner part.

Returns: