MassConstraint#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MassConstraint#

Bases: object

Defines a MassConstraint.

Overview#

Activate

Activate the current object.

CopyTo

Copies all visible properties from this object to another.

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.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

Children

Gets the list of children.

DataModelObjectCategory

Gets the current DataModelObject's category.

DefineBy

Gets or sets the DefineBy.

EnvironmentSelection

Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

MaximumAbsoluteValue

Gets or sets the MaximumAbsoluteValue.

MinimumAbsoluteValue

Gets or sets the MinimumAbsoluteValue.

PercentageToRetain

Gets or sets the PercentageToRetain.

PercentageToRetainMax

Gets or sets the PercentageToRetainMax.

PercentageToRetainMin

Gets or sets the PercentageToRetainMin.

Properties

Gets the list of properties for this object.

ScopingMethod

Gets or sets the ScopingMethod.

Selection

Gets or sets the Selection.

Suppressed

Gets or sets the Suppressed.

VisibleProperties

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

Property detail#

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

Gets the list of children.

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

Gets the current DataModelObject's category.

property MassConstraint.DefineBy: Ansys.Mechanical.DataModel.Enums.ResponseConstraintDefineBy | None#

Gets or sets the DefineBy.

property MassConstraint.EnvironmentSelection: Any | None#

Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

property MassConstraint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | None#

Gets the internal object. For advanced usage only.

property MassConstraint.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property MassConstraint.MaximumAbsoluteValue: Ansys.Core.Units.Quantity | None#

Gets or sets the MaximumAbsoluteValue.

property MassConstraint.MinimumAbsoluteValue: Ansys.Core.Units.Quantity | None#

Gets or sets the MinimumAbsoluteValue.

property MassConstraint.PercentageToRetain: int | None#

Gets or sets the PercentageToRetain.

property MassConstraint.PercentageToRetainMax: int | None#

Gets or sets the PercentageToRetainMax.

property MassConstraint.PercentageToRetainMin: int | None#

Gets or sets the PercentageToRetainMin.

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

Gets the list of properties for this object.

property MassConstraint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property MassConstraint.Selection: Ansys.ACT.Automation.Mechanical.OptimizationRegion | None#

Gets or sets the Selection.

property MassConstraint.Suppressed: bool | None#

Gets or sets the Suppressed.

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

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

Method detail#

MassConstraint.Activate() None#

Activate the current object.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

MassConstraint.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

MassConstraint.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MassConstraint.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.
MassConstraint.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

MassConstraint.RemoveParameter(propName: str) None#

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

MassConstraint.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.