## On this page

  

 

 # `RSLoad`

 Last update: 09.03.2026 

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

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

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

Defines a RSLoad.

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

## Overview

### Methods

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

NameDescription[`BoundaryCondition`](#RSLoad.BoundaryCondition)Gets or sets the BoundaryCondition.[`Children`](#RSLoad.Children)Gets the list of children.[`Comments`](#RSLoad.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#RSLoad.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Direction`](#RSLoad.Direction)Gets or sets the Direction.[`Figures`](#RSLoad.Figures)Gets the list of associated figures.[`Images`](#RSLoad.Images)Gets the list of associated images.[`InternalObject`](#RSLoad.InternalObject)Gets the internal object. For advanced usage only.[`MissingMassEffect`](#RSLoad.MissingMassEffect)Gets or sets the MissingMassEffect.[`MissingMassEffectZPA`](#RSLoad.MissingMassEffectZPA)Gets or sets the MissingMassEffectZPA.[`Properties`](#RSLoad.Properties)Gets the list of properties for this object.[`RigidResponseEffect`](#RSLoad.RigidResponseEffect)Gets or sets the RigidResponseEffect.[`RigidResponseEffectFreqBegin`](#RSLoad.RigidResponseEffectFreqBegin)Gets or sets the RigidResponseEffectFreqBegin.[`RigidResponseEffectFreqEnd`](#RSLoad.RigidResponseEffectFreqEnd)Gets or sets the RigidResponseEffectFreqEnd.[`RigidResponseEffectType`](#RSLoad.RigidResponseEffectType)Gets or sets the RigidResponseEffectType.[`RigidResponseEffectZPA`](#RSLoad.RigidResponseEffectZPA)Gets or sets the RigidResponseEffectZPA.[`ScaleFactor`](#RSLoad.ScaleFactor)Gets or sets the ScaleFactor.[`Suppressed`](#RSLoad.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#RSLoad.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="RSLoad.BoundaryCondition"></a>

### *property* RSLoad.BoundaryCondition *: Any | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BoundaryCondition.

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

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

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

Gets or sets the Direction.

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

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

Gets the list of associated figures.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

<a id="RSLoad.MissingMassEffect"></a>

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

Gets or sets the MissingMassEffect.

<a id="RSLoad.MissingMassEffectZPA"></a>

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

Gets or sets the MissingMassEffectZPA.

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

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

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

Gets or sets the RigidResponseEffect.

<a id="RSLoad.RigidResponseEffectFreqBegin"></a>

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

Gets or sets the RigidResponseEffectFreqBegin.

<a id="RSLoad.RigidResponseEffectFreqEnd"></a>

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

Gets or sets the RigidResponseEffectFreqEnd.

<a id="RSLoad.RigidResponseEffectType"></a>

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

Gets or sets the RigidResponseEffectType.

<a id="RSLoad.RigidResponseEffectZPA"></a>

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

Gets or sets the RigidResponseEffectZPA.

<a id="RSLoad.ScaleFactor"></a>

### *property* RSLoad.ScaleFactor *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ScaleFactor.

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

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

### *property* RSLoad.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="method-detail"></a>

## Method detail

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

### RSLoad.Activate()

Activate the current object.

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

### RSLoad.AddComment()

Creates a new child Comment.

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

### RSLoad.AddFigure()

Creates a new child Figure.

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

### RSLoad.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="RSLoad.CopyTo"></a>

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### RSLoad.Delete()

Run the Delete action.

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

### RSLoad.Duplicate()

Creates a copy of the current DataModelObject.

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

### RSLoad.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="RSLoad.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### RSLoad.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### RSLoad.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### RSLoad.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="RSLoad.PropertyByName"></a>

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

Get a property by its unique name.

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

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

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