Skip to main content

Mechanical scripting interface

RotationalVelocity

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.RotationalVelocity

Bases: object

Defines a RotationalVelocity.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
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.
GetActivateAtLoadStep Gets whether the rotational velocity is active at the specified load step.
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.
SetActivateAtLoadStep Sets whether the rotational velocity is active at the specified load step.

Properties

Name Description
Axis Gets or sets the Axis.
Children Gets the list of children.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the current DataModelObject’s category.
DefineBy Gets or sets the DefineBy.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Magnitude Gets the Magnitude.
NumberOfSegments Gets or sets the NumberOfSegments.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XComponent Gets the XComponent.
XCoordinate Gets or sets the XCoordinate.
YComponent Gets the YComponent.
YCoordinate Gets or sets the YCoordinate.
ZComponent Gets the ZComponent.
ZCoordinate Gets or sets the ZCoordinate.

Property detail

property RotationalVelocity.Axis : Ansys.Mechanical.Math.BoundVector | None

Gets or sets the Axis.

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

Gets the list of children.

property RotationalVelocity.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property RotationalVelocity.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

property RotationalVelocity.DefineBy : Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets or sets the DefineBy.

property RotationalVelocity.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property RotationalVelocity.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property RotationalVelocity.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

property RotationalVelocity.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSRotationAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property RotationalVelocity.Magnitude : Ansys.ACT.Mechanical.Fields.Field | None

Gets the Magnitude.

property RotationalVelocity.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property RotationalVelocity.ReadOnly : bool | None

Gets or sets the ReadOnly.

property RotationalVelocity.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

property RotationalVelocity.XComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets the XComponent.

property RotationalVelocity.XCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

property RotationalVelocity.YComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets the YComponent.

property RotationalVelocity.YCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

property RotationalVelocity.ZComponent : Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZComponent.

property RotationalVelocity.ZCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

Method detail

RotationalVelocity.Activate()

Activate the current object.

RotationalVelocity.AddComment()

Creates a new child Comment.

RotationalVelocity.AddFigure()

Creates a new child Figure.

RotationalVelocity.AddImage(filePath: str)

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.

RotationalVelocity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

RotationalVelocity.CreateParameter(propName: str)

Creates a new parameter for a Property.

RotationalVelocity.Delete()

Run the Delete action.

RotationalVelocity.Duplicate()

Creates a copy of the current DataModelObject.

RotationalVelocity.GetActivateAtLoadStep(stepNumber: int)

Gets whether the rotational velocity is active at the specified load step.

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

Gets the list of children, filtered by type.

RotationalVelocity.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

RotationalVelocity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

RotationalVelocity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

RotationalVelocity.PropertyByAPIName(name: str)

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.

RotationalVelocity.PropertyByName(name: str)

Get a property by its unique name.

RotationalVelocity.RemoveParameter(propName: str)

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

RotationalVelocity.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

Sets whether the rotational velocity is active at the specified load step.