## On this page

  

 

 # `NodalForce`

 Last update: 16.07.2025 

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

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

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

Defines a NodalDisplacement.

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

## Overview

### Methods

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

NameDescription[`Children`](#NodalForce.Children)Gets the list of children.[`Comments`](#NodalForce.Comments)Gets the list of associated comments.[`CoordinateSystem`](#NodalForce.CoordinateSystem)Gets the CoordinateSystem.[`DataModelObjectCategory`](#NodalForce.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DivideLoadByNodes`](#NodalForce.DivideLoadByNodes)Gets or sets the DivideLoadByNodes.[`DynamicRelaxationBehavior`](#NodalForce.DynamicRelaxationBehavior)Gets or sets the DynamicRelaxationBehavior.[`Figures`](#NodalForce.Figures)Gets the list of associated figures.[`GraphControlsXAxis`](#NodalForce.GraphControlsXAxis)Gets or sets the GraphControlsXAxis.[`HarmonicIndex`](#NodalForce.HarmonicIndex)Gets or sets the HarmonicIndex.[`Images`](#NodalForce.Images)Gets the list of associated images.[`IndependentVariable`](#NodalForce.IndependentVariable)Gets or sets the IndependentVariable.[`InternalObject`](#NodalForce.InternalObject)Gets the internal object. For advanced usage only.[`LoadVectorAssignment`](#NodalForce.LoadVectorAssignment)Gets or sets the LoadVectorAssignment.[`LoadVectorNumber`](#NodalForce.LoadVectorNumber)Gets or sets the LoadVectorNumber.[`Location`](#NodalForce.Location)Gets or sets the Location.[`NonCyclicLoadingType`](#NodalForce.NonCyclicLoadingType)Gets or sets the NonCyclicLoadingType.[`NumberOfSegments`](#NodalForce.NumberOfSegments)Gets or sets the NumberOfSegments.[`PhaseAngle`](#NodalForce.PhaseAngle)Gets or sets the PhaseAngle.[`Properties`](#NodalForce.Properties)Gets the list of properties for this object.[`RangeMaximum`](#NodalForce.RangeMaximum)Gets or sets the RangeMaximum.[`RangeMinimum`](#NodalForce.RangeMinimum)Gets or sets the RangeMinimum.[`ReadOnly`](#NodalForce.ReadOnly)Gets or sets the ReadOnly.[`SectorNumber`](#NodalForce.SectorNumber)Gets or sets the SectorNumber.[`SharedRefBody`](#NodalForce.SharedRefBody)Gets or sets the SharedRefBody.[`Suppressed`](#NodalForce.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#NodalForce.VisibleProperties)Gets the list of properties that are visible for this object.[`XComponent`](#NodalForce.XComponent)Gets the XComponent.[`XYZFunctionCoordinateSystem`](#NodalForce.XYZFunctionCoordinateSystem)Gets or sets the XYZFunctionCoordinateSystem.[`YComponent`](#NodalForce.YComponent)Gets the YComponent.[`ZComponent`](#NodalForce.ZComponent)Gets the ZComponent.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the CoordinateSystem.

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

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

Gets the current DataModelObject’s category.

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

### *property* NodalForce.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="NodalForce.DynamicRelaxationBehavior"></a>

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

Gets or sets the DynamicRelaxationBehavior.

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

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

Gets the list of associated figures.

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

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

Gets or sets the GraphControlsXAxis.

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

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

Gets or sets the HarmonicIndex.

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

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

Gets the list of associated images.

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

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

Gets or sets the IndependentVariable.

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

### *property* NodalForce.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="NodalForce.LoadVectorAssignment"></a>

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

Gets or sets the LoadVectorAssignment.

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

### *property* NodalForce.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="NodalForce.Location"></a>

### *property* NodalForce.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

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

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

Gets or sets the NonCyclicLoadingType.

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

### *property* NodalForce.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="NodalForce.PhaseAngle"></a>

### *property* NodalForce.PhaseAngle *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PhaseAngle.

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

### *property* NodalForce.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="NodalForce.RangeMaximum"></a>

### *property* NodalForce.RangeMaximum *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMaximum.

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

### *property* NodalForce.RangeMinimum *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMinimum.

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

### *property* NodalForce.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="NodalForce.SectorNumber"></a>

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

Gets or sets the SectorNumber.

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

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

Gets or sets the SharedRefBody.

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

### *property* NodalForce.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="NodalForce.VisibleProperties"></a>

### *property* NodalForce.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="NodalForce.XComponent"></a>

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

Gets the XComponent.

<a id="NodalForce.XYZFunctionCoordinateSystem"></a>

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

Gets or sets the XYZFunctionCoordinateSystem.

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

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

Gets the YComponent.

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

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

Gets the ZComponent.

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

## Method detail

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

### NodalForce.Activate()

Activate the current object.

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

### NodalForce.AddComment()

Creates a new child Comment.

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

### NodalForce.AddFigure()

Creates a new child Figure.

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

### NodalForce.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="NodalForce.CopyTo"></a>

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

Copies all visible properties from this object to another.

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

### NodalForce.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

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

### NodalForce.Delete()

Run the Delete action.

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

### NodalForce.Duplicate()

Creates a copy of the current DataModelObject.

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

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

GetActivateAtLoadStep method.

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

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

Gets the list of children, filtered by type.

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

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

GetComponentActivateAtLoadStep method.

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

### NodalForce.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

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

### NodalForce.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### NodalForce.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### NodalForce.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

### NodalForce.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="NodalForce.PropertyByName"></a>

### NodalForce.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

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

### NodalForce.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

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

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

SetActivateAtLoadStep method.

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

### NodalForce.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))

SetComponentActivateAtLoadStep method.