`Material`

class Ansys.ACT.Automation.Mechanical.Material

Bases: object

Defines a Material.

Overview

Methods

Name	Description
Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddMaterialAssignment	Run the AddMaterialAssignment action.
CopyTo	Copies all visible properties from this object to another.
CreateMaterialAssignment	Run the CreateMaterialAssignment action.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
GetAsDictionary	Returns material as a python dictionary
GetChildren	Gets the list of children, filtered by type.
GetParameter	Gets the parameter corresponding to the given property.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PropertyByAPIName	Get a property by its API name.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.

Properties

Name	Description
AssignedBodies	Gets the AssignedBodies.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject’s category.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
MaterialModels	Returns a collection of the material models that this material is made up of.
Properties	Gets the list of properties for this object.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Material.AssignedBodies : int | None

Gets the AssignedBodies.

property Material.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Material.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Material.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property Material.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Material.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Material.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSMaterialAuto | None

Gets the internal object. For advanced usage only.

property Material.MaterialModels : List[Any] | None

Returns a collection of the material models that this material is made up of.

property Material.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Material.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

Material.Activate() → None

Activate the current object.

Material.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Material.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

Material.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

Material.AddMaterialAssignment() → Ansys.ACT.Automation.Mechanical.MaterialAssignment

Run the AddMaterialAssignment action.

Material.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

Material.CreateMaterialAssignment() → Ansys.ACT.Automation.Mechanical.MaterialAssignment

Run the CreateMaterialAssignment action.

Material.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Material.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Material.GetAsDictionary() → dict[Any, Any]

Returns material as a python dictionary

Material.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Material.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Material.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

Material.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Material.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

Material.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Material.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.