## On this page

  

 

 # `Force`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Force"></a>

#### *class* Ansys.ACT.Automation.Mechanical.BoundaryConditions.Force

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a Force.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#Force.Activate)Activate the current object.[`AddComment`](#Force.AddComment)Creates a new child Comment.[`AddFigure`](#Force.AddFigure)Creates a new child Figure.[`AddImage`](#Force.AddImage)Creates a new child Image.[`CopyTo`](#Force.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#Force.CreateParameter)Creates a new parameter for a Property.[`Delete`](#Force.Delete)Run the Delete action.[`Duplicate`](#Force.Duplicate)Creates a copy of the current DataModelObject.[`GetActivateAtLoadStep`](#Force.GetActivateAtLoadStep)Gets whether the force is active at the specified load step.[`GetChildren`](#Force.GetChildren)Gets the list of children, filtered by type.[`GetComponentActivateAtLoadStep`](#Force.GetComponentActivateAtLoadStep)GetComponentActivateAtLoadStep method.[`GetParameter`](#Force.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#Force.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#Force.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PromoteToNamedSelection`](#Force.PromoteToNamedSelection)Run the PromoteToNamedSelection action.[`PropertyByAPIName`](#Force.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#Force.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#Force.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`SetActivateAtLoadStep`](#Force.SetActivateAtLoadStep)Sets whether the force is active at the specified load step.[`SetComponentActivateAtLoadStep`](#Force.SetComponentActivateAtLoadStep)SetComponentActivateAtLoadStep method.### Properties

NameDescription[`AppliedBy`](#Force.AppliedBy)Gets or sets the AppliedBy.[`Children`](#Force.Children)Gets the list of children.[`Comments`](#Force.Comments)Gets the list of associated comments.[`CoordinateSystem`](#Force.CoordinateSystem)Gets or sets the CoordinateSystem.[`DataModelObjectCategory`](#Force.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DefineBy`](#Force.DefineBy)Gets or sets the DefineBy.[`Direction`](#Force.Direction)Gets or sets the Direction.[`DivideLoadByNodes`](#Force.DivideLoadByNodes)Gets or sets the DivideLoadByNodes.[`DynamicRelaxationBehavior`](#Force.DynamicRelaxationBehavior)Gets or sets the DynamicRelaxationBehavior.[`Figures`](#Force.Figures)Gets the list of associated figures.[`GraphControlsXAxis`](#Force.GraphControlsXAxis)Gets or sets the GraphControlsXAxis.[`HarmonicIndex`](#Force.HarmonicIndex)Gets or sets the HarmonicIndex.[`Images`](#Force.Images)Gets the list of associated images.[`IndependentVariable`](#Force.IndependentVariable)Gets or sets the IndependentVariable.[`InternalObject`](#Force.InternalObject)Gets the internal object. For advanced usage only.[`LoadVectorAssignment`](#Force.LoadVectorAssignment)Gets or sets the LoadVectorAssignment.[`LoadVectorNumber`](#Force.LoadVectorNumber)Gets or sets the LoadVectorNumber.[`LoadVectorNumberImaginary`](#Force.LoadVectorNumberImaginary)[`LoadVectorNumberX`](#Force.LoadVectorNumberX)[`LoadVectorNumberXImaginary`](#Force.LoadVectorNumberXImaginary)[`LoadVectorNumberY`](#Force.LoadVectorNumberY)[`LoadVectorNumberYImaginary`](#Force.LoadVectorNumberYImaginary)[`LoadVectorNumberZ`](#Force.LoadVectorNumberZ)[`LoadVectorNumberZImaginary`](#Force.LoadVectorNumberZImaginary)[`Location`](#Force.Location)Gets or sets the Location.[`Magnitude`](#Force.Magnitude)Gets the Magnitude.[`MagnitudeImag`](#Force.MagnitudeImag)Gets the MagnitudeImag.[`NonCyclicLoadingType`](#Force.NonCyclicLoadingType)Gets or sets the NonCyclicLoadingType.[`NumberOfSegments`](#Force.NumberOfSegments)Gets or sets the NumberOfSegments.[`PhaseAngle`](#Force.PhaseAngle)Gets the PhaseAngle.[`Properties`](#Force.Properties)Gets the list of properties for this object.[`RangeMaximum`](#Force.RangeMaximum)Gets or sets the RangeMaximum.[`RangeMinimum`](#Force.RangeMinimum)Gets or sets the RangeMinimum.[`ReadOnly`](#Force.ReadOnly)Gets or sets the ReadOnly.[`RpmSelection`](#Force.RpmSelection)Gets or sets the RPMSelection.[`SectorNumber`](#Force.SectorNumber)Gets or sets the SectorNumber.[`SharedRefBody`](#Force.SharedRefBody)Gets or sets the SharedRefBody.[`StepSelection`](#Force.StepSelection)Gets or sets the StepSelection.[`StepVarying`](#Force.StepVarying)Gets or sets the StepVarying.[`Suppressed`](#Force.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#Force.VisibleProperties)Gets the list of properties that are visible for this object.[`XComponent`](#Force.XComponent)Gets the XComponent.[`XComponentImag`](#Force.XComponentImag)Gets the XComponentImag.[`XPhaseAngle`](#Force.XPhaseAngle)Gets the XPhaseAngle.[`YComponent`](#Force.YComponent)Gets the YComponent.[`YComponentImag`](#Force.YComponentImag)Gets or sets the YComponentImag.[`YPhaseAngle`](#Force.YPhaseAngle)Gets the YPhaseAngle.[`ZComponent`](#Force.ZComponent)Gets the ZComponent.[`ZComponentImag`](#Force.ZComponentImag)Gets or sets the ZComponentImag.[`ZPhaseAngle`](#Force.ZPhaseAngle)Gets the ZPhaseAngle.<a id="property-detail"></a>

## Property detail

<a id="Force.AppliedBy"></a>

### *property* Force.AppliedBy *: [Ansys.Mechanical.DataModel.Enums.LoadAppliedBy](../../../../Mechanical/DataModel/Enums/LoadAppliedBy.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadAppliedBy) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AppliedBy.

<a id="Force.Children"></a>

### *property* Force.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="Force.Comments"></a>

### *property* Force.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="Force.CoordinateSystem"></a>

### *property* Force.CoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CoordinateSystem.

<a id="Force.DataModelObjectCategory"></a>

### *property* Force.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="Force.DefineBy"></a>

### *property* Force.DefineBy *: [Ansys.Mechanical.DataModel.Enums.LoadDefineBy](../../../../Mechanical/DataModel/Enums/LoadDefineBy.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadDefineBy) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DefineBy.

<a id="Force.Direction"></a>

### *property* Force.Direction *: Ansys.ACT.Math.Vector3D | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Direction.

<a id="Force.DivideLoadByNodes"></a>

### *property* Force.DivideLoadByNodes *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DivideLoadByNodes.

<a id="Force.DynamicRelaxationBehavior"></a>

### *property* Force.DynamicRelaxationBehavior *: [Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType](../../../../Mechanical/DataModel/Enums/DynamicRelaxationBehaviorType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DynamicRelaxationBehavior.

<a id="Force.Figures"></a>

### *property* Force.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="Force.GraphControlsXAxis"></a>

### *property* Force.GraphControlsXAxis *: [Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType](../../../../Mechanical/DataModel/Enums/LoadVariableVariationType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GraphControlsXAxis.

<a id="Force.HarmonicIndex"></a>

### *property* Force.HarmonicIndex *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the HarmonicIndex.

<a id="Force.Images"></a>

### *property* Force.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="Force.IndependentVariable"></a>

### *property* Force.IndependentVariable *: [Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType](../../../../Mechanical/DataModel/Enums/LoadVariableVariationType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the IndependentVariable.

<a id="Force.InternalObject"></a>

### *property* Force.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="Force.LoadVectorAssignment"></a>

### *property* Force.LoadVectorAssignment *: [Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment](../../../../Mechanical/DataModel/Enums/LoadVectorAssignment.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadVectorAssignment.

<a id="Force.LoadVectorNumber"></a>

### *property* Force.LoadVectorNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadVectorNumber.

<a id="Force.LoadVectorNumberImaginary"></a>

### *property* Force.LoadVectorNumberImaginary *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.LoadVectorNumberX"></a>

### *property* Force.LoadVectorNumberX *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.LoadVectorNumberXImaginary"></a>

### *property* Force.LoadVectorNumberXImaginary *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.LoadVectorNumberY"></a>

### *property* Force.LoadVectorNumberY *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.LoadVectorNumberYImaginary"></a>

### *property* Force.LoadVectorNumberYImaginary *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.LoadVectorNumberZ"></a>

### *property* Force.LoadVectorNumberZ *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.LoadVectorNumberZImaginary"></a>

### *property* Force.LoadVectorNumberZImaginary *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

<a id="Force.Location"></a>

### *property* Force.Location *: [Ansys.ACT.Interfaces.Common.ISelectionInfo](../../../Interfaces/Common/ISelectionInfo.md#ansys.mechanical.stubs.v252.Ansys.ACT.Interfaces.Common.ISelectionInfo) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="Force.Magnitude"></a>

### *property* Force.Magnitude *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Magnitude.

<a id="Force.MagnitudeImag"></a>

### *property* Force.MagnitudeImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MagnitudeImag.

<a id="Force.NonCyclicLoadingType"></a>

### *property* Force.NonCyclicLoadingType *: [Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType](../../../../Mechanical/DataModel/Enums/NonCyclicLoadingType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NonCyclicLoadingType.

<a id="Force.NumberOfSegments"></a>

### *property* Force.NumberOfSegments *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NumberOfSegments.

<a id="Force.PhaseAngle"></a>

### *property* Force.PhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the PhaseAngle.

<a id="Force.Properties"></a>

### *property* Force.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="Force.RangeMaximum"></a>

### *property* Force.RangeMaximum *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMaximum.

<a id="Force.RangeMinimum"></a>

### *property* Force.RangeMinimum *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMinimum.

<a id="Force.ReadOnly"></a>

### *property* Force.ReadOnly *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ReadOnly.

<a id="Force.RpmSelection"></a>

### *property* Force.RpmSelection *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RPMSelection.

<a id="Force.SectorNumber"></a>

### *property* Force.SectorNumber *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SectorNumber.

<a id="Force.SharedRefBody"></a>

### *property* Force.SharedRefBody *: [Ansys.ACT.Automation.Mechanical.Body](../Body.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Body) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SharedRefBody.

<a id="Force.StepSelection"></a>

### *property* Force.StepSelection *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StepSelection.

<a id="Force.StepVarying"></a>

### *property* Force.StepVarying *: [Ansys.Mechanical.DataModel.Enums.StepVarying](../../../../Mechanical/DataModel/Enums/StepVarying.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.StepVarying) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StepVarying.

<a id="Force.Suppressed"></a>

### *property* Force.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="Force.VisibleProperties"></a>

### *property* Force.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="Force.XComponent"></a>

### *property* Force.XComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XComponent.

<a id="Force.XComponentImag"></a>

### *property* Force.XComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XComponentImag.

<a id="Force.XPhaseAngle"></a>

### *property* Force.XPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XPhaseAngle.

<a id="Force.YComponent"></a>

### *property* Force.YComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YComponent.

<a id="Force.YComponentImag"></a>

### *property* Force.YComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the YComponentImag.

<a id="Force.YPhaseAngle"></a>

### *property* Force.YPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YPhaseAngle.

<a id="Force.ZComponent"></a>

### *property* Force.ZComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZComponent.

<a id="Force.ZComponentImag"></a>

### *property* Force.ZComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ZComponentImag.

<a id="Force.ZPhaseAngle"></a>

### *property* Force.ZPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v252.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZPhaseAngle.

<a id="method-detail"></a>

## Method detail

<a id="Force.Activate"></a>

### Force.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="Force.AddComment"></a>

### Force.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

<a id="Force.AddFigure"></a>

### Force.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

<a id="Force.AddImage"></a>

### Force.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)

```text
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.

```

<a id="Force.CopyTo"></a>

### Force.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="Force.CreateParameter"></a>

### Force.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

<a id="Force.Delete"></a>

### Force.Delete() → [None](https://docs.python.org/3/library/constants.html#None)

Run the Delete action.

<a id="Force.Duplicate"></a>

### Force.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="Force.GetActivateAtLoadStep"></a>

### Force.GetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int)) → [bool](https://docs.python.org/3/library/functions.html#bool)

Gets whether the force is active at the specified load step.

<a id="Force.GetChildren"></a>

### Force.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="Force.GetComponentActivateAtLoadStep"></a>

### Force.GetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int)) → [bool](https://docs.python.org/3/library/functions.html#bool)

GetComponentActivateAtLoadStep method.

<a id="Force.GetParameter"></a>

### Force.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="Force.GroupAllSimilarChildren"></a>

### Force.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="Force.GroupSimilarObjects"></a>

### Force.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](../TreeGroupingFolder.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="Force.PromoteToNamedSelection"></a>

### Force.PromoteToNamedSelection() → Iterable\[[Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.NamedSelection)\]

Run the PromoteToNamedSelection action.

<a id="Force.PropertyByAPIName"></a>

### Force.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```text
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.

```

<a id="Force.PropertyByName"></a>

### Force.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="Force.RemoveParameter"></a>

### Force.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

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

<a id="Force.SetActivateAtLoadStep"></a>

### Force.SetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool)) → [None](https://docs.python.org/3/library/constants.html#None)

Sets whether the force is active at the specified load step.

<a id="Force.SetComponentActivateAtLoadStep"></a>

### Force.SetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool)) → [None](https://docs.python.org/3/library/constants.html#None)

SetComponentActivateAtLoadStep method.