## On this page

  

 

 # `RSVelocity`

 Last update: 09.03.2026 

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

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

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

Defines a RSVelocity.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets or sets the BoundaryCondition.

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

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

Gets the list of children.

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

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

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

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

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

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

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

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

Gets or sets the LoadData.

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

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

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

Gets or sets the MissingMassEffectZPA.

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

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

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

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

Gets or sets the RigidResponseEffectFreqBegin.

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

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

Gets or sets the RigidResponseEffectFreqEnd.

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

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

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

Gets or sets the RigidResponseEffectZPA.

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

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

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

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

### RSVelocity.Activate()

Activate the current object.

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

### RSVelocity.AddComment()

Creates a new child Comment.

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

### RSVelocity.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### RSVelocity.Delete()

Run the Delete action.

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

### RSVelocity.Duplicate()

Creates a copy of the current DataModelObject.

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

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

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

Gets the parameter corresponding to the given property.

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

### RSVelocity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### RSVelocity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

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

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

Get a property by its unique name.

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

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

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