MaterialAssignment

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MaterialAssignment

Bases: object

Defines a MaterialAssignment.

Overview

Methods

Activate	Activate the current object.
AddCommandSnippet	Creates a new CommandSnippet
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
CopyTo	Copies all visible properties from this object to another.
CreateMaterialPlot	Run the CreateMaterialPlot action.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
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.
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

Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
FieldCoordinateSystem	Gets or sets the FieldCoordinateSystem.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
Material	Gets or sets the Material.
MaterialName	Gets or sets the MaterialName.
MaterialPolarizationDirection	Gets or sets the MaterialPolarizationDirection.
NonlinearEffects	Gets or sets the NonlinearEffects.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
ReferenceTemperatureValue	Gets or sets the ReferenceTemperatureValue.
Suppressed	Gets or sets the Suppressed.
ThermalStrainEffects	Gets or sets the ThermalStrainEffects.
UseReferenceTemperatureByBody	Gets or sets the UseReferenceTemperatureByBody.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property MaterialAssignment.FieldCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the FieldCoordinateSystem.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property MaterialAssignment.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMaterialAssignmentAuto | None

Gets the internal object. For advanced usage only.

property MaterialAssignment.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property MaterialAssignment.Material: str | None

Gets or sets the Material.

property MaterialAssignment.MaterialName: str | None

Gets or sets the MaterialName.

property MaterialAssignment.MaterialPolarizationDirection: Ansys.Mechanical.DataModel.Enums.MaterialPolarizationDirection | None

Gets or sets the MaterialPolarizationDirection.

property MaterialAssignment.NonlinearEffects: bool | None

Gets or sets the NonlinearEffects.

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

Gets the list of properties for this object.

property MaterialAssignment.ReadOnly: bool | None

Gets or sets the ReadOnly.

property MaterialAssignment.ReferenceTemperatureValue: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceTemperatureValue.

property MaterialAssignment.Suppressed: bool | None

Gets or sets the Suppressed.

property MaterialAssignment.ThermalStrainEffects: bool | None

Gets or sets the ThermalStrainEffects.

property MaterialAssignment.UseReferenceTemperatureByBody: bool | None

Gets or sets the UseReferenceTemperatureByBody.

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

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

Method detail

MaterialAssignment.Activate() → None

Activate the current object.

MaterialAssignment.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

MaterialAssignment.CreateMaterialPlot() → Ansys.ACT.Automation.Mechanical.MaterialPlot

Run the CreateMaterialPlot action.

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

Creates a new parameter for a Property.

MaterialAssignment.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

MaterialAssignment.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

MaterialAssignment.RemoveParameter(propName: str) → None

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