NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | List of all members
NXOpen.PhysicalMaterial Class Reference

Represents Physical Material More...

Inheritance diagram for NXOpen.PhysicalMaterial:
NXOpen.Material NXOpen.CAE.IExportableFEEntity NXOpen.NXObject NXOpen.INXObject

Public Types

enum  Category {
  Metals, Plastics, Polymers, Ceramics,
  Other
}
 The different categories of materials. More...
 
enum  Type {
  Unknown = -1, Isotropic, Orthotropic, Anisotropic,
  Fluid = 4, GeneralHyperelastic, Mooneyrivlin, Mooneyrivlintestdata,
  Polynomial, Reducedpolynomial, Ogden, Ogdentestdata,
  Foam, Foamtestdata, Blatz, Arrudaboyce,
  Arrudaboycetestdata, Neohooke, Neohooketestdata, Marlow,
  Vanderwaals, Yeoh, Yeohtestdata, Gent,
  Gasket, Gasketbehavior, Shapememoryalloy, Sussmanbathe,
  Gasketdisplacement, Damageinterface, Multiplefluid, Hartsmith,
  Alexander, Curing, Porous = 35
}
 The different types of materials. More...
 
enum  AssignWarning { None, InvalidObj }
 Indicates the underlying issues when trying to assign material More...
 

Public Member Functions

unsafe NXOpen.PhysicalMaterial.Type GetMaterialType ()
 Returns the material type More...
 
unsafe int GetId ()
 Returns the material id More...
 
unsafe void SetId (int materialId)
 Sets the material id More...
 
unsafe string GetCategory ()
 Returns the material category More...
 
unsafe void SetCategory (string materialCategory)
 Sets the material category More...
 
unsafe void SetMaterialCategory (string materialCategory)
 Sets the material category using international character set More...
 
unsafe string GetMaterialCategory ()
 Returns the material category using international character set More...
 
unsafe string GetSubcategory ()
 Returns the material sub-category More...
 
unsafe void SetSubcategory (string materialSubcategory)
 Sets the material sub-category More...
 
unsafe string GetAlternatename ()
 Returns the material alternate name More...
 
unsafe void SetAlternatename (string materialAlternatename)
 Sets the material alternate name More...
 
unsafe string GetDescription ()
 Returns the material description More...
 
unsafe void SetDescription (string materialDescription)
 Sets the material description More...
 
unsafe bool IsNonlibraryMaterial ()
 Returns true if the material is locally defined (not a library/Teamcenter material) More...
 
unsafe bool IsLoadedLibraryMaterial ()
 Returns true if the material is loaded from a library (not Teamcenter) More...
 
unsafe bool IsLoadedTeamcenterMaterialItem ()
 Returns true if the material is loaded from Teamcenter More...
 
unsafe string GetLibraryName ()
 Returns the library name if the material was loaded from a library More...
 
unsafe string GetTeamcenterMaterialItem ()
 Returns the Teamcenter item if the material was loaded from Teamcenter More...
 
unsafe string GetVersion ()
 Returns the material version More...
 
unsafe bool HasParentmaterial ()
 Returns whether the material was copied from another material More...
 
unsafe NXOpen.PhysicalMaterial GetParentmaterial ()
 Returns the parent material that the material was copied from More...
 
unsafe bool HasParentlibrarymaterial ()
 Returns whether the material was copied from a library material More...
 
unsafe void GetParentlibrarymaterial (out string parentName, out string parentLibraryName)
 Returns the parent libary material information More...
 
unsafe bool GetMaterialEditable ()
 Returns whether the material can be modified or not More...
 
unsafe void SetMaterialEditable (bool isEditable)
 Sets whether a material can be modified or not. More...
 
unsafe void AssignObjects (NXOpen.NXObject[] objects)
 Assigns the material to solid bodies More...
 
unsafe void AssignToAllBodies ()
 Assigns the material to all solid bodies More...
 
unsafe
NXOpen.PhysicalMaterial.AssignWarning 
AssignToBodiesWithoutMaterials ()
 Assigns the material to all solid bodies without a material already assigned. More...
 
unsafe
NXOpen.PhysicalMaterial.AssignWarning 
AssignToBodiesNotUsingPreferredMaterial ()
 Assigns the material to all solid bodies not using the preferred material. More...
 
unsafe void UnassignAllObjects ()
 Removes the material assignment from all the objects that has it currently assigned More...
 
unsafe void GetUsage (out NXOpen.NXObject[] objects)
 Finds the objects using this material More...
 
unsafe void ReplaceMaterialAssignment (NXOpen.PhysicalMaterial newMatl)
 Replaces all assignments of one material with another material in the part where the material is assigned. More...
 
unsafe NXOpen.PhysicalMaterial Copy (NXOpen.NXObject partObject)
 Creates new (copied) material with same properties as the original material. More...
 
unsafe NXOpen.PhysicalMaterial CopyLibMatlToPart (NXOpen.NXObject partObject)
 Copies a library material to a part. More...
 
unsafe NXOpen.PhysicalMaterial CopyLibMatlToPart (NXOpen.NXObject partObject, bool editable)
 Copies a library material to a part. More...
 
unsafe void Delete ()
 Deletes a material from the part. More...
 
unsafe void DeleteUserMaterialModels ()
 Deletes User Material (UMAT) Model Property Values from a material. More...
 
unsafe void DeleteOrphanedUserMaterialModels ()
 Deletes Orphaned User Material (UMAT) Models and Properties from a material. More...
 
unsafe void ResyncWithLibraryDefinition ()
 Re-synchronizes a loaded library material to match its latest library definition. More...
 
unsafe void UpdateMaterialProperties ()
 Re-synchronizes a material with its definition. More...
 
unsafe void InfoMaterial ()
 Displays the property values for the material in the information window. More...
 
unsafe void InfoMaterialToFile (bool bOverride, string pcFileName)
 Writes the property values for the material to a file. More...
 
unsafe NXOpen.BasePropertyTable GetPropTable ()
 Returns the property table that contains the properties for this material. More...
 
unsafe string[] GetSolverCardSyntax ()
 Returns the solver card syntax strings for this entity. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Detailed Description

Represents Physical Material

Created in NX5.0.0

Member Enumeration Documentation

Indicates the underlying issues when trying to assign material

Enumerator
None 

No warning.

InvalidObj 

Invalid objects are not assigned.

The different categories of materials.

The material list generated will be filtered based on the category

Enumerator
Metals 

Metals

Plastics 

Plastics

Polymers 

Polymers

Ceramics 

Ceramics

Other 

Other (Not metal, plastic, etc.)

The different types of materials.

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

Enumerator
Unknown 

unknown == error

Isotropic 

Isotropic

Orthotropic 

Orthotropic

Anisotropic 

Anisotropic

Fluid 

Fluid

GeneralHyperelastic 

Hyperelastic - General

Mooneyrivlin 

Mooney Rivlin

Mooneyrivlintestdata 

Mooney Rivlin - test data option

Polynomial 

Polynomial

Reducedpolynomial 

Reduced Polynomial

Ogden 

Ogden

Ogdentestdata 

Ogden - test data option

Foam 

Foam

Foamtestdata 

Foam - test data option

Blatz 

Blatz-Ko

Arrudaboyce 

Arruda-Boyce

Arrudaboycetestdata 

Arruda-Boyce - test data option

Neohooke 

Neo Hooke

Neohooketestdata 

Neo Hooke - test data option

Marlow 

Marlow

Vanderwaals 

Van Der Waals

Yeoh 

Yeoh

Yeohtestdata 

Yeoh - test data option

Gent 

Gent

Gasket 

Gasket

Gasketbehavior 

Gasket Behavior

Shapememoryalloy 

Shape Memory Alloy

Sussmanbathe 

Sussman-Bathe hyperelastic material

Gasketdisplacement 

Gasket with length-based loading

Damageinterface 

Damage interface material

Multiplefluid 

Multiple fluid material

Hartsmith 

Hart-Smith material

Alexander 

Alexander material

Curing 

Curing material

Porous 

Porous material

Member Function Documentation

unsafe void NXOpen.PhysicalMaterial.AssignObjects ( NXOpen.NXObject[]  objects)

Assigns the material to solid bodies

Created in NX6.0.0

License requirements: None.

Parameters
objectsobjects to assign this material to
unsafe void NXOpen.PhysicalMaterial.AssignToAllBodies ( )

Assigns the material to all solid bodies

Created in NX7.5.3

License requirements: None.

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

Created in NX7.5.3

License requirements: None.

Returns
Returns a warning code if any
unsafe 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.

Created in NX7.5.3

License requirements: None.

Returns
Returns a warning code if any
unsafe 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.

Created in NX6.0.0

License requirements: None.

Parameters
partObjectobject in part where to copy material to
Returns
the new material copied from this material
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterial.CopyLibMatlToPart ( NXOpen.NXObject  partObject)

Copies a library material to a part.

Created in NX6.0.2

License requirements: None.

Parameters
partObjectobject in part where to copy material to
Returns
the new material copied from this material
unsafe 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.

Created in NX8.5.0

License requirements: None.

Parameters
partObjectobject in part where to copy material to
editablewhen 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.
Returns
the new material copied from this material
unsafe void NXOpen.PhysicalMaterial.Delete ( )

Deletes a material from the part.

Created in NX6.0.0

License requirements: None.

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

unsafe void NXOpen.PhysicalMaterial.DeleteUserMaterialModels ( )

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

Created in NX11.0.0

License requirements: None.

unsafe string NXOpen.PhysicalMaterial.GetAlternatename ( )

Returns the material alternate name

Created in NX8.5.0

License requirements: None.

Returns
the alternate name for the material
unsafe string NXOpen.PhysicalMaterial.GetCategory ( )

Returns the material category

Created in NX6.0.0

License requirements: None.

Returns
the category for the material
unsafe string NXOpen.PhysicalMaterial.GetDescription ( )

Returns the material description

Created in NX6.0.0

License requirements: None.

Returns
the description for the material
unsafe int NXOpen.PhysicalMaterial.GetId ( )

Returns the material id

Created in NX7.5.0

License requirements: None.

Returns
the id for the material
unsafe string NXOpen.PhysicalMaterial.GetLibraryName ( )

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

Created in NX7.5.3

License requirements: None.

Returns
the name of the library or a null reference (Nothing in Visual Basic) for nonlibrary materials
unsafe string NXOpen.PhysicalMaterial.GetMaterialCategory ( )

Returns the material category using international character set

Created in NX8.5.0

License requirements: None.

Returns
the category for the material
unsafe bool NXOpen.PhysicalMaterial.GetMaterialEditable ( )

Returns whether the material can be modified or not

Created in NX10.0.0

License requirements: None.

Returns
unsafe NXOpen.PhysicalMaterial.Type NXOpen.PhysicalMaterial.GetMaterialType ( )

Returns the material type

Created in NX6.0.0

License requirements: None.

Returns
the type for the material
unsafe void NXOpen.PhysicalMaterial.GetParentlibrarymaterial ( out string  parentName,
out string  parentLibraryName 
)

Returns the parent libary material information

Created in NX8.5.0

License requirements: None.

Parameters
parentName
parentLibraryName
unsafe NXOpen.PhysicalMaterial NXOpen.PhysicalMaterial.GetParentmaterial ( )

Returns the parent material that the material was copied from

Created in NX8.5.0

License requirements: None.

Returns
material that the material was originally copied from (parent)
unsafe NXOpen.BasePropertyTable NXOpen.PhysicalMaterial.GetPropTable ( )

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

Created in NX7.5.3

License requirements: None.

Returns
unsafe string [] NXOpen.PhysicalMaterial.GetSolverCardSyntax ( )

Returns the solver card syntax strings for this entity.

Created in NX8.5.0

License requirements: None.

Returns

Implements NXOpen.CAE.IExportableFEEntity.

unsafe string NXOpen.PhysicalMaterial.GetSubcategory ( )

Returns the material sub-category

Created in NX8.5.0

License requirements: None.

Returns
the subcategory for the material
unsafe string NXOpen.PhysicalMaterial.GetTeamcenterMaterialItem ( )

Returns the Teamcenter item if the material was loaded from Teamcenter

Created in NX7.5.3

License requirements: None.

Returns
the Teamcenter item or a null reference (Nothing in Visual Basic) for non-Teamcenter materials
unsafe void NXOpen.PhysicalMaterial.GetUsage ( out NXOpen.NXObject[]  objects)

Finds the objects using this material

Created in NX6.0.0

License requirements: None.

Parameters
objectsthe objects using the material
unsafe string NXOpen.PhysicalMaterial.GetVersion ( )

Returns the material version

Created in NX7.5.3

License requirements: None.

Returns
the material version or a null reference (Nothing in Visual Basic) for non-versioned materials
unsafe bool NXOpen.PhysicalMaterial.HasParentlibrarymaterial ( )

Returns whether the material was copied from a library material

Created in NX8.5.0

License requirements: None.

Returns
true if it is a copy of a library material and false if it is not
unsafe bool NXOpen.PhysicalMaterial.HasParentmaterial ( )

Returns whether the material was copied from another material

Created in NX8.5.0

License requirements: None.

Returns
true if it is a copy of another (parent) material and false if it is not
unsafe void NXOpen.PhysicalMaterial.InfoMaterial ( )

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

Created in NX7.5.3

License requirements: None.

unsafe void NXOpen.PhysicalMaterial.InfoMaterialToFile ( bool  bOverride,
string  pcFileName 
)

Writes the property values for the material to a file.

Created in NX7.5.3

License requirements: None.

Parameters
bOverrideif the file already exists, true override the file, false append to the file
pcFileNamethe full path including filename of file where the information should be written
unsafe bool NXOpen.PhysicalMaterial.IsLoadedLibraryMaterial ( )

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

Created in NX7.5.3

License requirements: None.

Returns
true if it a loaded library material and false if it is a local material or a Teamcenter item revision
unsafe bool NXOpen.PhysicalMaterial.IsLoadedTeamcenterMaterialItem ( )

Returns true if the material is loaded from Teamcenter

Created in NX7.5.3

License requirements: None.

Returns
true if it a loaded Teamcenter material and false if it is a local material or a loaded library material
unsafe bool NXOpen.PhysicalMaterial.IsNonlibraryMaterial ( )

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

Created in NX7.5.3

License requirements: None.

Returns
true if it is a locally defined material and false if it is a loaded library material or Teamcenter item revision
unsafe 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
newMatlthe new material tag, a null reference (Nothing in Visual Basic) is not allowed.
unsafe void NXOpen.PhysicalMaterial.ResyncWithLibraryDefinition ( )

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

Created in NX7.5.2

License requirements: None.

unsafe void NXOpen.PhysicalMaterial.SetAlternatename ( string  materialAlternatename)

Sets the material alternate name

Created in NX8.5.0

License requirements: None.

Parameters
materialAlternatenamethe alternate name for the material
unsafe void NXOpen.PhysicalMaterial.SetCategory ( string  materialCategory)

Sets the material category

Created in NX6.0.0

License requirements: None.

Parameters
materialCategorythe category for the material
unsafe void NXOpen.PhysicalMaterial.SetDescription ( string  materialDescription)

Sets the material description

Created in NX6.0.0

License requirements: None.

Parameters
materialDescriptionthe description for the material
unsafe void NXOpen.PhysicalMaterial.SetId ( int  materialId)

Sets the material id

Created in NX7.5.0

License requirements: None.

Parameters
materialIdthe id for the material
unsafe void NXOpen.PhysicalMaterial.SetMaterialCategory ( string  materialCategory)

Sets the material category using international character set

Created in NX8.5.0

License requirements: None.

Parameters
materialCategorythe category for the material
unsafe 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
unsafe void NXOpen.PhysicalMaterial.SetSubcategory ( string  materialSubcategory)

Sets the material sub-category

Created in NX8.5.0

License requirements: None.

Parameters
materialSubcategorythe subcategory for the material
unsafe 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.

unsafe 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:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.