Skip to main content

Mechanical scripting interface

VolumeConstraint

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.VolumeConstraint

Bases: object

Defines a VolumeConstraint.

Overview

Methods

Name Description
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.

Properties

Name Description
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 VolumeConstraint.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DefineBy.

property VolumeConstraint.EnvironmentSelection : Any | None

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

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

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.PercentageToRetain : int | None

Gets or sets the PercentageToRetain.

property VolumeConstraint.PercentageToRetainMax : int | None

Gets or sets the PercentageToRetainMax.

property VolumeConstraint.PercentageToRetainMin : int | None

Gets or sets the PercentageToRetainMin.

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

Gets the list of properties for this object.

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.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

VolumeConstraint.Activate()

Activate the current object.

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

Copies all visible properties from this object to another.

VolumeConstraint.CreateParameter(propName: str)

Creates a new parameter for a Property.

VolumeConstraint.Delete()

Run the Delete action.

VolumeConstraint.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

VolumeConstraint.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

VolumeConstraint.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

VolumeConstraint.GroupSimilarObjects()

Run the GroupSimilarObjects action.

VolumeConstraint.PropertyByAPIName(name: str)

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.PropertyByName(name: str)

Get a property by its unique name.

VolumeConstraint.RemoveParameter(propName: str)

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

VolumeConstraint.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.