Materials#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Materials#

Bases: object

Defines a Materials.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

AddImportedTraceExternalData

Creates a new Imported Trace (External Data).

AddMaterialAssignment

Creates a new MaterialAssignment

AddMaterialCombination

Creates a new MaterialCombination

AddMaterialPlot

Creates a new MaterialPlot

CopyTo

Copies all visible properties from this object to another.

CreateParameter

Creates a new parameter for a Property.

Duplicate

Creates a copy of the current DataModelObject.

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.

Import

PropertyByAPIName

Get a property by its API name.

PropertyByName

Get a property by its unique name.

RefreshMaterials

Run the RefreshMaterials action.

RemoveParameter

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

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.

MaterialAssignments

Gets the MaterialAssignments.

MaterialCount

Gets the MaterialCount.

Properties

Gets the list of properties for this object.

ReadOnly

Gets or sets the ReadOnly.

VisibleProperties

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

Property detail#

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

Gets the list of children.

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

Gets the list of associated comments.

property Materials.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property Materials.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMaterialGroupAuto | None#

Gets the internal object. For advanced usage only.

property Materials.MaterialAssignments: int | None#

Gets the MaterialAssignments.

property Materials.MaterialCount: int | None#

Gets the MaterialCount.

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

Gets the list of properties for this object.

property Materials.ReadOnly: bool | None#

Gets or sets the ReadOnly.

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

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

Method detail#

Materials.Activate() None#

Activate the current object.

Materials.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

Materials.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

Materials.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.
Materials.AddImportedTraceExternalData() Ansys.ACT.Automation.Mechanical.ImportedLoads.ImportedTraceGroup#

Creates a new Imported Trace (External Data).

Materials.AddMaterialAssignment() Ansys.ACT.Automation.Mechanical.MaterialAssignment#

Creates a new MaterialAssignment

Materials.AddMaterialCombination() Ansys.ACT.Automation.Mechanical.MaterialCombination#

Creates a new MaterialCombination

Materials.AddMaterialPlot() Ansys.ACT.Automation.Mechanical.MaterialPlot#

Creates a new MaterialPlot

Materials.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

Materials.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

Materials.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

Materials.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

Materials.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

Materials.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

Materials.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

Materials.Import(materialURI: str, format: Ansys.Mechanical.DataModel.MechanicalEnums.Materials.ImportFormat, settings: Ansys.Mechanical.Materials.ImportSettings) Iterable[Ansys.ACT.Automation.Mechanical.Material]#
Materials.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.
Materials.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

Materials.RefreshMaterials() None#

Run the RefreshMaterials action.

Materials.RemoveParameter(propName: str) None#

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