Library | Package Java Toolkit

Interface Material

package com.ptc.pfc.pfcPart;

public interface Material
  extends com.ptc.pfc.pfcModelItem.ParameterOwner,
          com.ptc.pfc.pfcObject.Child



Description

This class provides information about a material.
Direct Known Subclasses:
WMaterial



Method Summary
voidDelete ()
    Deletes the material from the part's database.
StringGetBendTable ()
    Get method for attribute "BendTable"
    The bend table
StringGetCondition ()
    Get method for attribute "Condition"
    The condition
/*optional*/ StringGetCrossHatchFile ()
    Get method for attribute "CrossHatchFile"
    The name of the cross-hatching file used in detailing for this material.
/*optional*/ StringGetDescription ()
    Get method for attribute "Description"
    The material description string.
doubleGetEmissivity ()
    Get method for attribute "Emissivity"
    The emissivity
/*optional*/ StringGetFailureCriterion ()
    Get method for attribute "FailureCriterion"
    The failure criterion.
/*optional*/ StringGetFatigueMaterialFinish ()
    Get method for attribute "FatigueMaterialFinish"
    The fatigue material finish.
/*optional*/ StringGetFatigueMaterialType ()
    Get method for attribute "FatigueMaterialType"
    The fatigue material type.
/*optional*/ StringGetFatigueType ()
    Get method for attribute "FatigueType"
    The fatigue type.
MaterialTypeGetFluidMaterialType ()
    Get method for attribute "FluidMaterialType"
    The material type for the fluid properties.
doubleGetHardness ()
    Get method for attribute "Hardness"
    The hardness
/*optional*/ StringGetHardnessType ()
    Get method for attribute "HardnessType"
    The hardness type.
intGetId ()
    Get method for attribute "Id"
    The id of the material
doubleGetInitBendYFactor ()
    Get method for attribute "InitBendYFactor"
    The initial bend Y-factor
doubleGetMassDensity ()
    Get method for attribute "MassDensity"
    The mass density
/*optional*/ StringGetMaterialModel ()
    Get method for attribute "MaterialModel"
    The type of hyperelastic material model.
/*optional*/ BooleanGetModelDefByTests ()
    Get method for attribute "ModelDefByTests"
    Specifies whether the selected hyperelastic material model is defined using test data.
StringGetName ()
    Get method for attribute "Name"
    The name of the material
stringseqGetPermittedFailureCriteria ()
    Get method for attribute "PermittedFailureCriteria"
    A list of the permitted string values for the material failure criterion.
stringseqGetPermittedFatigueMaterialFinishes ()
    Get method for attribute "PermittedFatigueMaterialFinishes"
    A list of the permitted string values for the material fatigue material finish.
stringseqGetPermittedFatigueMaterialTypes ()
    Get method for attribute "PermittedFatigueMaterialTypes"
    A list of the permitted string values for the material fatigue material type.
stringseqGetPermittedFatigueTypes ()
    Get method for attribute "PermittedFatigueTypes"
    A list of the permitted string values for the material fatigue type.
stringseqGetPermittedMaterialModels ()
    Get method for attribute "PermittedMaterialModels"
    A list of the permitted string values for the material model.
stringseqGetPermittedSubTypes ()
    Get method for attribute "PermittedSubTypes"
    A list of the permitted string values for the material sub type.
doubleGetPoissonRatio ()
    Get method for attribute "PoissonRatio"
    The isotropic Poisson's ratio
/*optional*/ MaterialPropertyGetPropertyValue (MaterialPropertyType Type)
    Returns the value and units for a material property.
doubleGetShearModulus ()
    Get method for attribute "ShearModulus"
    The isotropic shear modulus
doubleGetSpecificHeat ()
    Get method for attribute "SpecificHeat"
    The specific heat
doubleGetStressLimCompress ()
    Get method for attribute "StressLimCompress"
    The isotropic compression ultimate stress.
doubleGetStressLimShear ()
    Get method for attribute "StressLimShear"
    The shear ultimate stress.
doubleGetStressLimTension ()
    Get method for attribute "StressLimTension"
    The isotropic tensile ultimate stress.
doubleGetStructDampCoef ()
    Get method for attribute "StructDampCoef"
    The structural damping coefficient
MaterialTypeGetStructuralMaterialType ()
    Get method for attribute "StructuralMaterialType"
    The material type for the structural properties.
/*optional*/ StringGetSubType ()
    Get method for attribute "SubType"
    The isotropic material type's sub type.
MaterialTypeGetThermalMaterialType ()
    Get method for attribute "ThermalMaterialType"
    The material type for the thermal properties.
doubleGetThermConductivity ()
    Get method for attribute "ThermConductivity"
    The isotropic thermal conductivity
doubleGetThermExpCoef ()
    Get method for attribute "ThermExpCoef"
    The isotropic thermal expansion coefficient
doubleGetThermExpRefTemp ()
    Get method for attribute "ThermExpRefTemp"
    The thermal expansion reference temperature
doubleGetYoungModulus ()
    Get method for attribute "YoungModulus"
    The isotropic Young's modulus
voidRemoveProperty (MaterialPropertyType Type)
    Removes a material property.
voidSave (String FileName)
    Writes the specified part material to a file.
voidSetBendTable (String value)
    Set method for attribute "BendTable"
    The bend table
voidSetCondition (String value)
    Set method for attribute "Condition"
    The condition
voidSetCrossHatchFile ( /*optional*/ String value)
    Set method for attribute "CrossHatchFile"
    The name of the cross-hatching file used in detailing for this material.
voidSetCurrent ()
    Sets the current material to its owner part.
voidSetDescription ( /*optional*/ String value)
    Set method for attribute "Description"
    The material description string.
voidSetEmissivity (double value)
    Set method for attribute "Emissivity"
    The emissivity
voidSetFailureCriterion ( /*optional*/ String value)
    Set method for attribute "FailureCriterion"
    The failure criterion.
voidSetFatigueMaterialFinish ( /*optional*/ String value)
    Set method for attribute "FatigueMaterialFinish"
    The fatigue material finish.
voidSetFatigueMaterialType ( /*optional*/ String value)
    Set method for attribute "FatigueMaterialType"
    The fatigue material type.
voidSetFatigueType ( /*optional*/ String value)
    Set method for attribute "FatigueType"
    The fatigue type.
voidSetFluidMaterialType (MaterialType value)
    Set method for attribute "FluidMaterialType"
    The material type for the fluid properties.
voidSetHardness (double value)
    Set method for attribute "Hardness"
    The hardness
voidSetHardnessType ( /*optional*/ String value)
    Set method for attribute "HardnessType"
    The hardness type.
voidSetInitBendYFactor (double value)
    Set method for attribute "InitBendYFactor"
    The initial bend Y-factor
voidSetMassDensity (double value)
    Set method for attribute "MassDensity"
    The mass density
voidSetMaterialModel ( /*optional*/ String value)
    Set method for attribute "MaterialModel"
    The type of hyperelastic material model.
voidSetModelDefByTests ( /*optional*/ Boolean value)
    Set method for attribute "ModelDefByTests"
    Specifies whether the selected hyperelastic material model is defined using test data.
voidSetPoissonRatio (double value)
    Set method for attribute "PoissonRatio"
    The isotropic Poisson's ratio
voidSetPropertyUnits (MaterialPropertyType Type, String Units, /*optional*/ Boolean Convert)
    Sets the units for a material property.
voidSetPropertyValue (MaterialPropertyType Type, MaterialProperty Value)
    Sets the value and units for a material property.
voidSetShearModulus (double value)
    Set method for attribute "ShearModulus"
    The isotropic shear modulus
voidSetSpecificHeat (double value)
    Set method for attribute "SpecificHeat"
    The specific heat
voidSetStressLimCompress (double value)
    Set method for attribute "StressLimCompress"
    The isotropic compression ultimate stress.
voidSetStressLimShear (double value)
    Set method for attribute "StressLimShear"
    The shear ultimate stress.
voidSetStressLimTension (double value)
    Set method for attribute "StressLimTension"
    The isotropic tensile ultimate stress.
voidSetStructDampCoef (double value)
    Set method for attribute "StructDampCoef"
    The structural damping coefficient
voidSetStructuralMaterialType (MaterialType value)
    Set method for attribute "StructuralMaterialType"
    The material type for the structural properties.
voidSetSubType ( /*optional*/ String value)
    Set method for attribute "SubType"
    The isotropic material type's sub type.
voidSetThermalMaterialType (MaterialType value)
    Set method for attribute "ThermalMaterialType"
    The material type for the thermal properties.
voidSetThermConductivity (double value)
    Set method for attribute "ThermConductivity"
    The isotropic thermal conductivity
voidSetThermExpCoef (double value)
    Set method for attribute "ThermExpCoef"
    The isotropic thermal expansion coefficient
voidSetThermExpRefTemp (double value)
    Set method for attribute "ThermExpRefTemp"
    The thermal expansion reference temperature
voidSetYoungModulus (double value)
    Set method for attribute "YoungModulus"
    The isotropic Young's modulus

Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource
AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent
GetChild

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner
GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Interface com.ptc.pfc.pfcObject.Child
GetDBParent, GetOId

Method Detail

GetName

StringGetName ()


    The name of the material



GetId

intGetId ()


    The id of the material



GetStructuralMaterialType/SetStructuralMaterialType

MaterialTypeGetStructuralMaterialType ()
voidSetStructuralMaterialType (MaterialType 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



GetThermalMaterialType/SetThermalMaterialType

MaterialTypeGetThermalMaterialType ()
voidSetThermalMaterialType (MaterialType 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



GetFluidMaterialType/SetFluidMaterialType

MaterialTypeGetFluidMaterialType ()
voidSetFluidMaterialType (MaterialType value)


    The material type for the fluid properties.
Manual References:
Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types



GetDescription/SetDescription

/*optional*/ StringGetDescription ()
voidSetDescription ( /*optional*/ String value)


    The material description string.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetCondition/SetCondition

StringGetCondition ()
voidSetCondition (String value)


    The condition

If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetBendTable/SetBendTable

StringGetBendTable ()
voidSetBendTable (String value)


    The bend table

If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetHardnessType/SetHardnessType

/*optional*/ StringGetHardnessType ()
voidSetHardnessType ( /*optional*/ String value)


    The hardness type.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetCrossHatchFile/SetCrossHatchFile

/*optional*/ StringGetCrossHatchFile ()
voidSetCrossHatchFile ( /*optional*/ String 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



GetMaterialModel/SetMaterialModel

/*optional*/ StringGetMaterialModel ()
voidSetMaterialModel ( /*optional*/ String value)


    The type of hyperelastic material model.

Must be one of the members of Material.GetPermittedMaterialModels()
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetPermittedMaterialModels

stringseqGetPermittedMaterialModels ()


    A list of the permitted string values for the material model.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetSubType/SetSubType

/*optional*/ StringGetSubType ()
voidSetSubType ( /*optional*/ String value)


    The isotropic material type's sub type.

Must be one of the members of Material.GetPermittedSubTypes()
Manual References:
Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types, Solid: Accessing Material Types



GetPermittedSubTypes

stringseqGetPermittedSubTypes ()


    A list of the permitted string values for the material sub type.
Manual References:
Solid: Accessing Material Types, Solid: Accessing Material Types



GetModelDefByTests/SetModelDefByTests

/*optional*/ BooleanGetModelDefByTests ()
voidSetModelDefByTests ( /*optional*/ Boolean 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



GetFatigueType/SetFatigueType

/*optional*/ StringGetFatigueType ()
voidSetFatigueType ( /*optional*/ String value)


    The fatigue type.

Must be one of the members of Material.GetPermittedFatigueTypes()
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetFatigueMaterialType/SetFatigueMaterialType

/*optional*/ StringGetFatigueMaterialType ()
voidSetFatigueMaterialType ( /*optional*/ String value)


    The fatigue material type.

Must be one of the members of Material.GetPermittedFatigueMaterialTypes()
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetFatigueMaterialFinish/SetFatigueMaterialFinish

/*optional*/ StringGetFatigueMaterialFinish ()
voidSetFatigueMaterialFinish ( /*optional*/ String value)


    The fatigue material finish.

Must be one of the members of Material.GetPermittedFatigueMaterialFinishes()
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetPermittedFatigueTypes

stringseqGetPermittedFatigueTypes ()


    A list of the permitted string values for the material fatigue type.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetPermittedFatigueMaterialTypes

stringseqGetPermittedFatigueMaterialTypes ()


    A list of the permitted string values for the material fatigue material type.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetPermittedFatigueMaterialFinishes

stringseqGetPermittedFatigueMaterialFinishes ()


    A list of the permitted string values for the material fatigue material finish.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetFailureCriterion/SetFailureCriterion

/*optional*/ StringGetFailureCriterion ()
voidSetFailureCriterion ( /*optional*/ String value)


    The failure criterion.

Must be one of the members of Material.GetPermittedFailureCriteria()
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetPermittedFailureCriteria

stringseqGetPermittedFailureCriteria ()


    A list of the permitted string values for the material failure criterion.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetPropertyValue

/*optional*/ MaterialPropertyGetPropertyValue (MaterialPropertyType Type)


    Returns the value and units for a material property.

Exceptions thrown (but not limited to):

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


SetPropertyValue

voidSetPropertyValue (MaterialPropertyType Type, MaterialProperty 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):

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

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

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

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


See Also:
pfcPart.MaterialProperty_Create(double, /*optional*/ String)
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:


SetPropertyUnits

voidSetPropertyUnits (MaterialPropertyType Type, String Units, /*optional*/ Boolean Convert)


    Sets the units for a material property.

Exceptions thrown (but not limited to):

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

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

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

XToolkitCantModify - 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:


RemoveProperty

voidRemoveProperty (MaterialPropertyType Type)


    Removes a material property.

Exceptions thrown (but not limited to):

XToolkitNotFound - This property does not exist on the material.

XToolkitBadContext - 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:


GetYoungModulus/SetYoungModulus

doubleGetYoungModulus ()
voidSetYoungModulus (double value)


    The isotropic Young's modulus





GetPoissonRatio/SetPoissonRatio

doubleGetPoissonRatio ()
voidSetPoissonRatio (double value)


    The isotropic Poisson's ratio

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



GetShearModulus/SetShearModulus

doubleGetShearModulus ()
voidSetShearModulus (double value)


    The isotropic shear modulus





GetMassDensity/SetMassDensity

doubleGetMassDensity ()
voidSetMassDensity (double 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 Material.GetPropertyValue(MaterialPropertyType) and Material.SetPropertyValue(MaterialPropertyType, MaterialProperty).



GetThermExpCoef/SetThermExpCoef

doubleGetThermExpCoef ()
voidSetThermExpCoef (double value)


    The isotropic thermal expansion coefficient





GetThermExpRefTemp/SetThermExpRefTemp

doubleGetThermExpRefTemp ()
voidSetThermExpRefTemp (double value)


    The thermal expansion reference temperature





GetStructDampCoef/SetStructDampCoef

doubleGetStructDampCoef ()
voidSetStructDampCoef (double value)


    The structural damping coefficient





GetStressLimTension/SetStressLimTension

doubleGetStressLimTension ()
voidSetStressLimTension (double value)


    The isotropic tensile ultimate stress.





GetStressLimCompress/SetStressLimCompress

doubleGetStressLimCompress ()
voidSetStressLimCompress (double value)


    The isotropic compression ultimate stress.





GetStressLimShear/SetStressLimShear

doubleGetStressLimShear ()
voidSetStressLimShear (double value)


    The shear ultimate stress.





GetThermConductivity/SetThermConductivity

doubleGetThermConductivity ()
voidSetThermConductivity (double value)


    The isotropic thermal conductivity





GetEmissivity/SetEmissivity

doubleGetEmissivity ()
voidSetEmissivity (double value)


    The emissivity

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



GetSpecificHeat/SetSpecificHeat

doubleGetSpecificHeat ()
voidSetSpecificHeat (double value)


    The specific heat





GetHardness/SetHardness

doubleGetHardness ()
voidSetHardness (double value)


    The hardness

If this property is not set on the material, an attempt to retrieve it will throw a XToolkitNotFound exception.
Manual References:
Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties, Solid: Accessing Material Properties



GetInitBendYFactor/SetInitBendYFactor

doubleGetInitBendYFactor ()
voidSetInitBendYFactor (double value)


    The initial bend Y-factor

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



Delete

voidDelete ()


    Deletes the material from the part's database.
Manual References:
Solid: Materials, Solid: Materials
Returns:


Save

voidSave (String FileName)


    Writes the specified part material to a file.

Exceptions thrown (but not limited to):

XToolkitBadContext - 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:


SetCurrent

voidSetCurrent ()


    Sets the current material to its owner part.
Returns: