Skip to main content

Mechanical scripting interface

RotatingForce

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.RotatingForce

Bases: object

Defines a RotatingForce.

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.
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.
PromoteToNamedSelection Run the PromoteToNamedSelection 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.

Properties

Name Description
Axis Gets or sets the Axis.
AxisComponentX Gets the AxisComponentX.
AxisComponentY Gets the AxisComponentY.
AxisComponentZ Gets the AxisComponentZ.
AxisLocationX Gets the AxisLocationX.
AxisLocationY Gets the AxisLocationY.
AxisLocationZ Gets the AxisLocationZ.
CalculatedFromUnbalancedMass Gets or sets the CalculatedFromUnbalancedMass.
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.
HitPointLocationX Gets the HitPointLocationX.
HitPointLocationY Gets the HitPointLocationY.
HitPointLocationZ Gets the HitPointLocationZ.
HitPointNodeId Gets the HitPointNodeId.
HitPointRemotePointSelection Gets or sets the HitPointRemotePointSelection.
HitPointSelection Gets or sets the HitPointSelection.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
Mass Gets or sets the Mass.
PhaseAngle Gets or sets the PhaseAngle.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
RemotePointSelection Gets or sets the RemotePointSelection.
RotatingRadius Gets or sets the RotatingRadius.
SharedRefBody Gets or sets the SharedRefBody.
Suppressed Gets or sets the Suppressed.
SynchronousRatio Gets or sets the SynchronousRatio.
UnbalancedForceMagnitude Gets or sets the UnbalancedForceMagnitude.
VisibleProperties Gets the list of properties that are visible for this object.
XCoordinate Gets or sets the XCoordinate.
YCoordinate Gets or sets the YCoordinate.
ZCoordinate Gets or sets the ZCoordinate.

Property detail

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

Gets or sets the Axis.

property RotatingForce.AxisComponentX : float | None

Gets the AxisComponentX.

property RotatingForce.AxisComponentY : float | None

Gets the AxisComponentY.

property RotatingForce.AxisComponentZ : float | None

Gets the AxisComponentZ.

property RotatingForce.AxisLocationX : Ansys.Core.Units.Quantity | None

Gets the AxisLocationX.

property RotatingForce.AxisLocationY : Ansys.Core.Units.Quantity | None

Gets the AxisLocationY.

property RotatingForce.AxisLocationZ : Ansys.Core.Units.Quantity | None

Gets the AxisLocationZ.

property RotatingForce.CalculatedFromUnbalancedMass : bool | None

Gets or sets the CalculatedFromUnbalancedMass.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

property RotatingForce.DefineBy : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the DefineBy.

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

Gets the list of associated figures.

property RotatingForce.HitPointLocationX : Ansys.Core.Units.Quantity | None

Gets the HitPointLocationX.

property RotatingForce.HitPointLocationY : Ansys.Core.Units.Quantity | None

Gets the HitPointLocationY.

property RotatingForce.HitPointLocationZ : Ansys.Core.Units.Quantity | None

Gets the HitPointLocationZ.

property RotatingForce.HitPointNodeId : int | None

Gets the HitPointNodeId.

property RotatingForce.HitPointRemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the HitPointRemotePointSelection.

property RotatingForce.HitPointSelection : bool | None

Gets or sets the HitPointSelection.

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

Gets the list of associated images.

property RotatingForce.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property RotatingForce.Mass : Ansys.Core.Units.Quantity | None

Gets or sets the Mass.

property RotatingForce.PhaseAngle : Ansys.Core.Units.Quantity | None

Gets or sets the PhaseAngle.

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

Gets the list of properties for this object.

property RotatingForce.ReadOnly : bool | None

Gets or sets the ReadOnly.

property RotatingForce.RemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property RotatingForce.RotatingRadius : Ansys.Core.Units.Quantity | None

Gets or sets the RotatingRadius.

property RotatingForce.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property RotatingForce.Suppressed : bool | None

Gets or sets the Suppressed.

property RotatingForce.SynchronousRatio : float | None

Gets or sets the SynchronousRatio.

property RotatingForce.UnbalancedForceMagnitude : float | None

Gets or sets the UnbalancedForceMagnitude.

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

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

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

Gets or sets the XCoordinate.

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

Gets or sets the YCoordinate.

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

Gets or sets the ZCoordinate.

Method detail

RotatingForce.Activate()

Activate the current object.

RotatingForce.AddComment()

Creates a new child Comment.

RotatingForce.AddFigure()

Creates a new child Figure.

RotatingForce.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.

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

Copies all visible properties from this object to another.

RotatingForce.CreateParameter(propName: str)

Creates a new parameter for a Property.

RotatingForce.Delete()

Run the Delete action.

RotatingForce.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

RotatingForce.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

RotatingForce.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

RotatingForce.GroupSimilarObjects()

Run the GroupSimilarObjects action.

RotatingForce.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

RotatingForce.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.

RotatingForce.PropertyByName(name: str)

Get a property by its unique name.

RotatingForce.RemoveParameter(propName: str)

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