Represents Physical Material
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::PhysicalMaterial:

Public Types
enum	AssignWarning { AssignWarningNone, AssignWarningInvalidObj }
	Indicates the underlying issues when trying to assign material. More...

enum	Category { CategoryMetals, CategoryPlastics, CategoryPolymers, CategoryCeramics, CategoryOther }
	The different categories of materials. More...

enum	Type { TypeUnknown = -1, TypeIsotropic, TypeOrthotropic, TypeAnisotropic, TypeFluid = 4, TypeGeneralHyperelastic, TypeMooneyrivlin, TypeMooneyrivlintestdata, TypePolynomial, TypeReducedpolynomial, TypeOgden, TypeOgdentestdata, TypeFoam, TypeFoamtestdata, TypeBlatz, TypeArrudaboyce, TypeArrudaboycetestdata, TypeNeohooke, TypeNeohooketestdata, TypeMarlow, TypeVanderwaals, TypeYeoh, TypeYeohtestdata, TypeGent, TypeGasket, TypeGasketbehavior, TypeShapememoryalloy, TypeSussmanbathe, TypeGasketdisplacement, TypeDamageinterface, TypeMultiplefluid, TypeHartsmith, TypeAlexander, TypeCuring, TypePorous = 35 }
	The different types of materials. More...

Public Member Functions
void	AssignObjects (const std::vector< NXOpen::NXObject * > &objects)
	Assigns the material to solid bodies. More...

void	AssignToAllBodies ()
	Assigns the material to all solid bodies. More...

NXOpen::PhysicalMaterial::AssignWarning	AssignToBodiesNotUsingPreferredMaterial ()
	Assigns the material to all solid bodies not using the preferred material. More...

NXOpen::PhysicalMaterial::AssignWarning	AssignToBodiesWithoutMaterials ()
	Assigns the material to all solid bodies without a material already assigned. More...

NXOpen::PhysicalMaterial *	Copy (NXOpen::NXObject *partObject)
	Creates new (copied) material with same properties as the original material. More...

NXOpen::PhysicalMaterial *	CopyLibMatlToPart (NXOpen::NXObject *partObject)
	Copies a library material to a part. More...

NXOpen::PhysicalMaterial *	CopyLibMatlToPart (NXOpen::NXObject *partObject, bool editable)
	Copies a library material to a part. More...

void	Delete ()
	Deletes a material from the part. More...

void	DeleteOrphanedUserMaterialModels ()
	Deletes Orphaned User Material (UMAT) Models and Properties from a material. More...

void	DeleteUserMaterialModels ()
	Deletes User Material (UMAT) Model Property Values from a material. More...

NXString	GetAlternatename ()
	Returns the material alternate name. More...

NXString	GetCategory ()
	Returns the material category. More...

NXString	GetDescription ()
	Returns the material description. More...

int	GetId ()
	Returns the material id. More...

NXString	GetLibraryName ()
	Returns the library name if the material was loaded from a library. More...

NXString	GetMaterialCategory ()
	Returns the material category using international character set. More...

bool	GetMaterialEditable ()
	Returns whether the material can be modified or not. More...

NXOpen::PhysicalMaterial::Type	GetMaterialType ()
	Returns the material type. More...

void	GetParentlibrarymaterial (NXString parentName, NXString parentLibraryName)
	Returns the parent libary material information. More...

NXOpen::PhysicalMaterial *	GetParentmaterial ()
	Returns the parent material that the material was copied from. More...

NXOpen::BasePropertyTable *	GetPropTable ()
	Returns the property table that contains the properties for this material. More...

virtual std::vector< NXString >	GetSolverCardSyntax ()
	Returns the solver card syntax strings for this entity. More...

NXString	GetSubcategory ()
	Returns the material sub-category. More...

NXString	GetTeamcenterMaterialItem ()
	Returns the Teamcenter item if the material was loaded from Teamcenter. More...

void	GetUsage (std::vector< NXOpen::NXObject * > &objects)
	Finds the objects using this material. More...

NXString	GetVersion ()
	Returns the material version. More...

bool	HasParentlibrarymaterial ()
	Returns whether the material was copied from a library material. More...

bool	HasParentmaterial ()
	Returns whether the material was copied from another material. More...

void	InfoMaterial ()
	Displays the property values for the material in the information window. More...

void	InfoMaterialToFile (bool bOverride, const NXString &pcFileName)
	Writes the property values for the material to a file. More...

void	InfoMaterialToFile (bool bOverride, const char *pcFileName)
	Writes the property values for the material to a file. More...

bool	IsLoadedLibraryMaterial ()
	Returns true if the material is loaded from a library (not Teamcenter) More...

bool	IsLoadedTeamcenterMaterialItem ()
	Returns true if the material is loaded from Teamcenter. More...

bool	IsNonlibraryMaterial ()
	Returns true if the material is locally defined (not a library/Teamcenter material) More...

void	ReplaceMaterialAssignment (NXOpen::PhysicalMaterial *newMatl)
	Replaces all assignments of one material with another material in the part where the material is assigned. More...

void	ResyncWithLibraryDefinition ()
	Re-synchronizes a loaded library material to match its latest library definition. More...

void	SetAlternatename (const NXString &materialAlternatename)
	Sets the material alternate name. More...

void	SetAlternatename (const char *materialAlternatename)
	Sets the material alternate name. More...

void	SetCategory (const NXString &materialCategory)
	Sets the material category. More...

void	SetCategory (const char *materialCategory)
	Sets the material category. More...

void	SetDescription (const NXString &materialDescription)
	Sets the material description. More...

void	SetDescription (const char *materialDescription)
	Sets the material description. More...

void	SetId (int materialId)
	Sets the material id. More...

void	SetMaterialCategory (const NXString &materialCategory)
	Sets the material category using international character set. More...

void	SetMaterialCategory (const char *materialCategory)
	Sets the material category using international character set. More...

void	SetMaterialEditable (bool isEditable)
	Sets whether a material can be modified or not. More...

void	SetSubcategory (const NXString &materialSubcategory)
	Sets the material sub-category. More...

void	SetSubcategory (const char *materialSubcategory)
	Sets the material sub-category. More...

void	UnassignAllObjects ()
	Removes the material assignment from all the objects that has it currently assigned. More...

void	UpdateMaterialProperties ()
	Re-synchronizes a material with its definition. More...

Detailed Description

Represents Physical Material
Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::PhysicalMaterial::AssignWarning

Indicates the underlying issues when trying to assign material.

Enumerator
AssignWarningNone	No warning.
AssignWarningInvalidObj	Invalid objects are not assigned.

enum NXOpen::PhysicalMaterial::Category

The different categories of materials.

The material list generated will be filtered based on the category

Enumerator
CategoryMetals	Metals.
CategoryPlastics	Plastics.
CategoryPolymers	Polymers.
CategoryCeramics	Ceramics.
CategoryOther	Other (Not metal, plastic, etc.)

enum NXOpen::PhysicalMaterial::Type

The different types of materials.

The material list generated will be filtered based on the material type chosen

Enumerator
TypeUnknown	unknown == error
TypeIsotropic	Isotropic.
TypeOrthotropic	Orthotropic.
TypeAnisotropic	Anisotropic.
TypeFluid	Fluid.
TypeGeneralHyperelastic	Hyperelastic - General.
TypeMooneyrivlin	Mooney Rivlin.
TypeMooneyrivlintestdata	Mooney Rivlin - test data option.
TypePolynomial	Polynomial.
TypeReducedpolynomial	Reduced Polynomial.
TypeOgden	Ogden.
TypeOgdentestdata	Ogden - test data option.
TypeFoam	Foam.
TypeFoamtestdata	Foam - test data option.
TypeBlatz	Blatz-Ko.
TypeArrudaboyce	Arruda-Boyce.
TypeArrudaboycetestdata	Arruda-Boyce - test data option.
TypeNeohooke	Neo Hooke.
TypeNeohooketestdata	Neo Hooke - test data option.
TypeMarlow	Marlow.
TypeVanderwaals	Van Der Waals.
TypeYeoh	Yeoh.
TypeYeohtestdata	Yeoh - test data option.
TypeGent	Gent.
TypeGasket	Gasket.
TypeGasketbehavior	Gasket Behavior.
TypeShapememoryalloy	Shape Memory Alloy.
TypeSussmanbathe	Sussman-Bathe hyperelastic material.
TypeGasketdisplacement	Gasket with length-based loading.
TypeDamageinterface	Damage interface material.
TypeMultiplefluid	Multiple fluid material.
TypeHartsmith	Hart-Smith material.
TypeAlexander	Alexander material.
TypeCuring	Curing material.
TypePorous	Porous material.

Member Function Documentation

void NXOpen::PhysicalMaterial::AssignObjects ( const std::vector< NXOpen::NXObject * > & objects )

Assigns the material to solid bodies.

Created in NX6.0.0.

License requirements : None

Parameters

objects objects to assign this material to

void NXOpen::PhysicalMaterial::AssignToAllBodies ( )

Assigns the material to all solid bodies.

Created in NX7.5.3.

License requirements : None

NXOpen::PhysicalMaterial::AssignWarning NXOpen::PhysicalMaterial::AssignToBodiesNotUsingPreferredMaterial ( )

Assigns the material to all solid bodies not using the preferred material.

Invalid bodies are skipped and a warning code will be returned.

Returns: Returns a warning code if any
Created in NX7.5.3.

License requirements : None

NXOpen::PhysicalMaterial::AssignWarning NXOpen::PhysicalMaterial::AssignToBodiesWithoutMaterials ( )

Assigns the material to all solid bodies without a material already assigned.

Invalid bodies are skipped and a warning code will be returned.

Returns: Returns a warning code if any
Created in NX7.5.3.

License requirements : None

NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterial::Copy ( NXOpen::NXObject * partObject )

Creates new (copied) material with same properties as the original material.

The name of the new (copied) material will be unique and based on the name of the original material.

Returns: the new material copied from this material
Created in NX6.0.0.

License requirements : None

Parameters

partObject object in part where to copy material to

NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterial::CopyLibMatlToPart ( NXOpen::NXObject * partObject )

Copies a library material to a part.

Returns: the new material copied from this material
Created in NX6.0.2.

License requirements : None

Parameters

partObject object in part where to copy material to

NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterial::CopyLibMatlToPart	(	NXOpen::NXObject *	partObject,
		bool	editable
	)

Copies a library material to a part.

The copied (local) material can either be set to be editable or non-editable which determines whether the material can be modified or not.

Returns: the new material copied from this material
Created in NX8.5.0.

License requirements : None

Parameters

partObject	object in part where to copy material to
editable	when true, creates a local material ready for user editting. When false, it creates an exact copy of a loaded library material. The difference between loading and copying with this set to false is loading will get the latest library version whereas if the library material passed in is not synchronized with the latest version, the copy will also not be synchronized with the latest version.

void NXOpen::PhysicalMaterial::Delete ( )

Deletes a material from the part.

Created in NX6.0.0.

License requirements : None

void NXOpen::PhysicalMaterial::DeleteOrphanedUserMaterialModels ( )

Deletes Orphaned User Material (UMAT) Models and Properties from a material.

A model or property is considered orphaned if it exists on the material, but doesn't exist in the current environment.

Created in NX11.0.0.

License requirements : None

void NXOpen::PhysicalMaterial::DeleteUserMaterialModels ( )

Deletes User Material (UMAT) Model Property Values from a material.

Created in NX11.0.0.

License requirements : None

NXString NXOpen::PhysicalMaterial::GetAlternatename ( )

Returns the material alternate name.

Returns: the alternate name for the material
Created in NX8.5.0.

License requirements : None

NXString NXOpen::PhysicalMaterial::GetCategory ( )

Returns the material category.

Returns: the category for the material
Created in NX6.0.0.

License requirements : None

NXString NXOpen::PhysicalMaterial::GetDescription ( )

Returns the material description.

Returns: the description for the material
Created in NX6.0.0.

License requirements : None

int NXOpen::PhysicalMaterial::GetId ( )

Returns the material id.

Returns: the id for the material
Created in NX7.5.0.

License requirements : None

NXString NXOpen::PhysicalMaterial::GetLibraryName ( )

Returns the library name if the material was loaded from a library.

Returns: the name of the library or NULL for nonlibrary materials
Created in NX7.5.3.

License requirements : None

NXString NXOpen::PhysicalMaterial::GetMaterialCategory ( )

Returns the material category using international character set.

Returns: the category for the material
Created in NX8.5.0.

License requirements : None

bool NXOpen::PhysicalMaterial::GetMaterialEditable ( )

Returns whether the material can be modified or not.

Returns: Created in NX10.0.0.

License requirements : None

NXOpen::PhysicalMaterial::Type NXOpen::PhysicalMaterial::GetMaterialType ( )

Returns the material type.

Returns: the type for the material
Created in NX6.0.0.

License requirements : None

void NXOpen::PhysicalMaterial::GetParentlibrarymaterial	(	NXString *	parentName,
		NXString *	parentLibraryName
	)

Returns the parent libary material information.

Created in NX8.5.0.

License requirements : None

Parameters

parentName	parentname
parentLibraryName	parentlibraryname

NXOpen::PhysicalMaterial* NXOpen::PhysicalMaterial::GetParentmaterial ( )

Returns the parent material that the material was copied from.

Returns: material that the material was originally copied from (parent)
Created in NX8.5.0.

License requirements : None

NXOpen::BasePropertyTable* NXOpen::PhysicalMaterial::GetPropTable ( )

Returns the property table that contains the properties for this material.

Returns: Created in NX7.5.3.

License requirements : None

virtual std::vector<NXString> NXOpen::PhysicalMaterial::GetSolverCardSyntax ( )

virtual

Returns the solver card syntax strings for this entity.

Returns: Created in NX8.5.0.

License requirements : None

Implements NXOpen::CAE::IExportableFEEntity.

NXString NXOpen::PhysicalMaterial::GetSubcategory ( )

Returns the material sub-category.

Returns: the subcategory for the material
Created in NX8.5.0.

License requirements : None

NXString NXOpen::PhysicalMaterial::GetTeamcenterMaterialItem ( )

Returns the Teamcenter item if the material was loaded from Teamcenter.

Returns: the Teamcenter item or NULL for non-Teamcenter materials
Created in NX7.5.3.

License requirements : None

void NXOpen::PhysicalMaterial::GetUsage ( std::vector< NXOpen::NXObject * > & objects )

Finds the objects using this material.

Created in NX6.0.0.

License requirements : None

Parameters

objects the objects using the material

NXString NXOpen::PhysicalMaterial::GetVersion ( )

Returns the material version.

Returns: the material version or NULL for non-versioned materials
Created in NX7.5.3.

License requirements : None

bool NXOpen::PhysicalMaterial::HasParentlibrarymaterial ( )

Returns whether the material was copied from a library material.

Returns: true if it is a copy of a library material and false if it is not
Created in NX8.5.0.

License requirements : None

bool NXOpen::PhysicalMaterial::HasParentmaterial ( )

Returns whether the material was copied from another material.

Returns: true if it is a copy of another (parent) material and false if it is not
Created in NX8.5.0.

License requirements : None

void NXOpen::PhysicalMaterial::InfoMaterial ( )

Displays the property values for the material in the information window.

Created in NX7.5.3.

License requirements : None

void NXOpen::PhysicalMaterial::InfoMaterialToFile	(	bool	bOverride,
		const NXString &	pcFileName
	)

Writes the property values for the material to a file.

Created in NX7.5.3.

License requirements : None

Parameters

bOverride	if the file already exists, true override the file, false append to the file
pcFileName	the full path including filename of file where the information should be written

void NXOpen::PhysicalMaterial::InfoMaterialToFile	(	bool	bOverride,
		const char *	pcFileName
	)

Writes the property values for the material to a file.

Created in NX7.5.3.

License requirements : None

Parameters

bOverride	if the file already exists, true override the file, false append to the file
pcFileName	the full path including filename of file where the information should be written

bool NXOpen::PhysicalMaterial::IsLoadedLibraryMaterial ( )

Returns true if the material is loaded from a library (not Teamcenter)

Returns: true if it a loaded library material and false if it is a local material or a Teamcenter item revision
Created in NX7.5.3.

License requirements : None

bool NXOpen::PhysicalMaterial::IsLoadedTeamcenterMaterialItem ( )

Returns true if the material is loaded from Teamcenter.

Returns: true if it a loaded Teamcenter material and false if it is a local material or a loaded library material
Created in NX7.5.3.

License requirements : None

bool NXOpen::PhysicalMaterial::IsNonlibraryMaterial ( )

Returns true if the material is locally defined (not a library/Teamcenter material)

Returns: true if it is a locally defined material and false if it is a loaded library material or Teamcenter item revision
Created in NX7.5.3.

License requirements : None

void NXOpen::PhysicalMaterial::ReplaceMaterialAssignment ( NXOpen::PhysicalMaterial * newMatl )

Replaces all assignments of one material with another material in the part where the material is assigned.

The part needs to be fully loaded, the new material needs to be in the same part as the original material and the material type needs to be a valid material assignment target.

Created in NX10.0.0.

License requirements : None

Parameters

newMatl the new material tag, NULL is not allowed.

void NXOpen::PhysicalMaterial::ResyncWithLibraryDefinition ( )

Re-synchronizes a loaded library material to match its latest library definition.

Created in NX7.5.2.

License requirements : None

void NXOpen::PhysicalMaterial::SetAlternatename ( const NXString & materialAlternatename )

Sets the material alternate name.

Created in NX8.5.0.

License requirements : None

Parameters

materialAlternatename the alternate name for the material

void NXOpen::PhysicalMaterial::SetAlternatename ( const char * materialAlternatename )

Sets the material alternate name.

Created in NX8.5.0.

License requirements : None

Parameters

materialAlternatename the alternate name for the material

void NXOpen::PhysicalMaterial::SetCategory ( const NXString & materialCategory )

Sets the material category.

Created in NX6.0.0.

License requirements : None

Parameters

materialCategory the category for the material

void NXOpen::PhysicalMaterial::SetCategory ( const char * materialCategory )

Sets the material category.

Created in NX6.0.0.

License requirements : None

Parameters

materialCategory the category for the material

void NXOpen::PhysicalMaterial::SetDescription ( const NXString & materialDescription )

Sets the material description.

Created in NX6.0.0.

License requirements : None

Parameters

materialDescription the description for the material

void NXOpen::PhysicalMaterial::SetDescription ( const char * materialDescription )

Sets the material description.

Created in NX6.0.0.

License requirements : None

Parameters

materialDescription the description for the material

void NXOpen::PhysicalMaterial::SetId ( int materialId )

Sets the material id.

Created in NX7.5.0.

License requirements : None

Parameters

materialId the id for the material

void NXOpen::PhysicalMaterial::SetMaterialCategory ( const NXString & materialCategory )

Sets the material category using international character set.

Created in NX8.5.0.

License requirements : None

Parameters

materialCategory the category for the material

void NXOpen::PhysicalMaterial::SetMaterialCategory ( const char * materialCategory )

Sets the material category using international character set.

Created in NX8.5.0.

License requirements : None

Parameters

materialCategory the category for the material

void NXOpen::PhysicalMaterial::SetMaterialEditable ( bool isEditable )

Sets whether a material can be modified or not.

Note: library materials cannot be set to be able to be modified.

Created in NX10.0.0.

License requirements : None

Parameters

isEditable iseditable

void NXOpen::PhysicalMaterial::SetSubcategory ( const NXString & materialSubcategory )

Sets the material sub-category.

Created in NX8.5.0.

License requirements : None

Parameters

materialSubcategory the subcategory for the material

void NXOpen::PhysicalMaterial::SetSubcategory ( const char * materialSubcategory )

Sets the material sub-category.

Created in NX8.5.0.

License requirements : None

Parameters

materialSubcategory the subcategory for the material

void NXOpen::PhysicalMaterial::UnassignAllObjects ( )

Removes the material assignment from all the objects that has it currently assigned.

Created in NX6.0.0.

License requirements : None

void NXOpen::PhysicalMaterial::UpdateMaterialProperties ( )

Re-synchronizes a material with its definition.

The definition could be a library definition or a parent material's (from a copy) definition.

Created in NX8.5.0.

License requirements : None

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

PhysicalMaterial.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation