VolumeConstraint#

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

Bases: object

Defines a VolumeConstraint.

Overview#

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

Delete

Run the Delete action.

GetChildren

Gets the list of children, filtered by type.

GetChildren

Gets the list of children, filtered by type.

Activate

Activate the current object.

CopyTo

Copies all visible properties from this object to another.

Duplicate

Creates a copy of the current DataModelObject.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PropertyByName

Get a property by its unique name.

PropertyByAPIName

Get a property by its API name.

CreateParameter

Creates a new parameter for a Property.

GetParameter

Gets the parameter corresponding to the given property.

RemoveParameter

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

InternalObject

Gets the internal object. For advanced usage only.

PercentageToRetain

Gets or sets the PercentageToRetain.

PercentageToRetainMax

Gets or sets the PercentageToRetainMax.

PercentageToRetainMin

Gets or sets the PercentageToRetainMin.

MaximumAbsoluteValue

Gets or sets the MaximumAbsoluteValue.

MinimumAbsoluteValue

Gets or sets the MinimumAbsoluteValue.

DefineBy

Gets or sets the DefineBy.

ScopingMethod

Gets or sets the ScopingMethod.

Selection

Gets or sets the Selection.

Location

Gets or sets the Location.

DataModelObjectCategory

Gets the current DataModelObject’s category.

EnvironmentSelection

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

Suppressed

Gets or sets the Suppressed.

Children

Gets the list of children.

InternalObject

Gets the internal object. For advanced usage only.

Properties

Gets the list of properties for this object.

VisibleProperties

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

Property detail#

property VolumeConstraint.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoConstraintAuto | None

Gets the internal object. For advanced usage only.

property VolumeConstraint.PercentageToRetain: System.Int32 | None

Gets or sets the PercentageToRetain.

property VolumeConstraint.PercentageToRetainMax: System.Int32 | None

Gets or sets the PercentageToRetainMax.

property VolumeConstraint.PercentageToRetainMin: System.Int32 | None

Gets or sets the PercentageToRetainMin.

property VolumeConstraint.MaximumAbsoluteValue: Ansys.Core.Units.Quantity | None

Gets or sets the MaximumAbsoluteValue.

property VolumeConstraint.MinimumAbsoluteValue: Ansys.Core.Units.Quantity | None

Gets or sets the MinimumAbsoluteValue.

property VolumeConstraint.DefineBy: Ansys.Mechanical.DataModel.Enums.ResponseConstraintDefineBy | None

Gets or sets the DefineBy.

property VolumeConstraint.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property VolumeConstraint.Selection: Ansys.ACT.Automation.Mechanical.OptimizationRegion | None

Gets or sets the Selection.

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

Gets or sets the Location.

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

Gets the current DataModelObject’s category.

property VolumeConstraint.EnvironmentSelection: System.Object | None

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

property VolumeConstraint.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property VolumeConstraint.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property VolumeConstraint.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property VolumeConstraint.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property VolumeConstraint.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail#

VolumeConstraint.RenameBasedOnDefinition() System.Void

Run the RenameBasedOnDefinition action.

VolumeConstraint.Delete() System.Void

Run the Delete action.

VolumeConstraint.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

VolumeConstraint.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

VolumeConstraint.Activate() System.Void

Activate the current object.

VolumeConstraint.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void

Copies all visible properties from this object to another.

VolumeConstraint.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

VolumeConstraint.GroupAllSimilarChildren() System.Void

Run the GroupAllSimilarChildren action.

VolumeConstraint.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

VolumeConstraint.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

VolumeConstraint.PropertyByAPIName(name: System.String) 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.
VolumeConstraint.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

VolumeConstraint.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

VolumeConstraint.RemoveParameter(propName: System.String) System.Void

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