`RotatingForce`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.RotatingForce#

Bases: object

Defines a RotatingForce.

Overview#

Methods

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

Properties

`Axis`	Gets or sets the Axis.
`InternalObject`	Gets the internal object. For advanced usage only.
`SynchronousRatio`	Gets or sets the SynchronousRatio.
`AxisComponentX`	Gets the AxisComponentX.
`AxisComponentY`	Gets the AxisComponentY.
`AxisComponentZ`	Gets the AxisComponentZ.
`HitPointNodeId`	Gets the HitPointNodeId.
`UnbalancedForceMagnitude`	Gets or sets the UnbalancedForceMagnitude.
`XCoordinate`	Gets or sets the XCoordinate.
`YCoordinate`	Gets or sets the YCoordinate.
`ZCoordinate`	Gets or sets the ZCoordinate.
`PhaseAngle`	Gets or sets the PhaseAngle.
`AxisLocationX`	Gets the AxisLocationX.
`AxisLocationY`	Gets the AxisLocationY.
`AxisLocationZ`	Gets the AxisLocationZ.
`HitPointLocationX`	Gets the HitPointLocationX.
`HitPointLocationY`	Gets the HitPointLocationY.
`HitPointLocationZ`	Gets the HitPointLocationZ.
`RotatingRadius`	Gets or sets the RotatingRadius.
`Mass`	Gets or sets the Mass.
`DefineBy`	Gets or sets the DefineBy.
`CalculatedFromUnbalancedMass`	Gets or sets the CalculatedFromUnbalancedMass.
`HitPointSelection`	Gets or sets the HitPointSelection.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`RemotePointSelection`	Gets or sets the RemotePointSelection.
`HitPointRemotePointSelection`	Gets or sets the HitPointRemotePointSelection.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`SharedRefBody`	Gets or sets the SharedRefBody.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property RotatingForce.Axis: Ansys.Mechanical.Math.BoundVector | None: Gets or sets the Axis.

property RotatingForce.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None: Gets the internal object. For advanced usage only.

property RotatingForce.SynchronousRatio: System.Double | None: Gets or sets the SynchronousRatio.

property RotatingForce.AxisComponentX: System.Double | None: Gets the AxisComponentX.

property RotatingForce.AxisComponentY: System.Double | None: Gets the AxisComponentY.

property RotatingForce.AxisComponentZ: System.Double | None: Gets the AxisComponentZ.

property RotatingForce.HitPointNodeId: System.Int32 | None: Gets the HitPointNodeId.

property RotatingForce.UnbalancedForceMagnitude: System.Double | None: Gets or sets the UnbalancedForceMagnitude.

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.

property RotatingForce.PhaseAngle: Ansys.Core.Units.Quantity | None: Gets or sets the PhaseAngle.

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.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.RotatingRadius: Ansys.Core.Units.Quantity | None: Gets or sets the RotatingRadius.

property RotatingForce.Mass: Ansys.Core.Units.Quantity | None: Gets or sets the Mass.

property RotatingForce.DefineBy: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the DefineBy.

property RotatingForce.CalculatedFromUnbalancedMass: System.Boolean | None: Gets or sets the CalculatedFromUnbalancedMass.

property RotatingForce.HitPointSelection: System.Boolean | None: Gets or sets the HitPointSelection.

property RotatingForce.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

property RotatingForce.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None: Gets or sets the RemotePointSelection.

property RotatingForce.HitPointRemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None: Gets or sets the HitPointRemotePointSelection.

property RotatingForce.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property RotatingForce.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property RotatingForce.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property RotatingForce.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None: Gets or sets the SharedRefBody.

property RotatingForce.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property RotatingForce.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property RotatingForce.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property RotatingForce.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property RotatingForce.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property RotatingForce.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property RotatingForce.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property RotatingForce.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

RotatingForce.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

RotatingForce.Delete() → System.Void: Run the Delete action.

RotatingForce.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

RotatingForce.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

RotatingForce.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

RotatingForce.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

RotatingForce.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.Activate() → System.Void: Activate the current object.

RotatingForce.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

RotatingForce.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

RotatingForce.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

RotatingForce.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

RotatingForce.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

RotatingForce.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

RotatingForce.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

RotatingForce.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.