ReactionForceConstraint

class ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.ReactionForceConstraint

Bases: object

Defines a ReactionForceConstraint.

Overview

Methods

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

AxisSelection	Gets or sets the AxisSelection.
BoundType	Gets or sets the BoundType.
Children	Gets the list of children.
DataModelObjectCategory	Gets the current DataModelObject's category.
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.
Properties	Gets the list of properties for this object.
ReactionForceCriteria	Gets or sets the ReactionForceCriteria.
ScopingMethod	Gets or sets the ScopingMethod.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponentMax	Gets or sets the XComponentMax.
YComponentMax	Gets or sets the YComponentMax.
ZComponentMax	Gets or sets the ZComponentMax.

Property detail

property ReactionForceConstraint.AxisSelection: Ansys.Mechanical.DataModel.Enums.AxisSelectionType | None

Gets or sets the AxisSelection.

property ReactionForceConstraint.BoundType: Ansys.Mechanical.DataModel.Enums.TopoBoundType | None

Gets or sets the BoundType.

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

Gets the list of children.

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

Gets the current DataModelObject's category.

property ReactionForceConstraint.EnvironmentSelection: Any | None

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

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

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

Gets the list of properties for this object.

property ReactionForceConstraint.ReactionForceCriteria: Ansys.Mechanical.DataModel.Enums.ReactionForceCriteriaType | None

Gets or sets the ReactionForceCriteria.

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

Gets or sets the ScopingMethod.

property ReactionForceConstraint.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

property ReactionForceConstraint.XComponentMax: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the XComponentMax.

property ReactionForceConstraint.YComponentMax: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the YComponentMax.

property ReactionForceConstraint.ZComponentMax: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the ZComponentMax.

Method detail

ReactionForceConstraint.Activate() → None

Activate the current object.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

ReactionForceConstraint.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

ReactionForceConstraint.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

ReactionForceConstraint.RemoveParameter(propName: str) → None

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

ReactionForceConstraint.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.