`RemoteForce`#

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

Bases: object

Defines a RemoteForce.

Overview#

Methods

`PromoteToRemotePoint`	Run the PromoteToRemotePoint action.
`GetActivateAtLoadStep`	GetActivateAtLoadStep method.
`SetActivateAtLoadStep`	SetActivateAtLoadStep method.
`GetComponentActivateAtLoadStep`	GetComponentActivateAtLoadStep method.
`SetComponentActivateAtLoadStep`	SetComponentActivateAtLoadStep method.
`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

`Direction`	Gets or sets the Direction.
`StepSelection`	Gets or sets the StepSelection.
`InternalObject`	Gets the internal object. For advanced usage only.
`BeamMaterial`	Gets or sets the BeamMaterial.
`NumberOfSegments`	Gets or sets the NumberOfSegments.
`XComponent`	Gets the XComponent.
`XComponentImag`	Gets the XComponentImag.
`YComponent`	Gets the YComponent.
`YComponentImag`	Gets the YComponentImag.
`ZComponent`	Gets the ZComponent.
`ZComponentImag`	Gets the ZComponentImag.
`HarmonicIndex`	Gets or sets the HarmonicIndex.
`SectorNumber`	Gets or sets the SectorNumber.
`Magnitude`	Gets the Magnitude.
`MagnitudeImag`	Gets the MagnitudeImag.
`PhaseAngle`	Gets the PhaseAngle.
`XPhaseAngle`	Gets the XPhaseAngle.
`YPhaseAngle`	Gets the YPhaseAngle.
`ZPhaseAngle`	Gets the ZPhaseAngle.
`BeamRadius`	Gets or sets the BeamRadius.
`XCoordinate`	Gets or sets the XCoordinate.
`YCoordinate`	Gets or sets the YCoordinate.
`ZCoordinate`	Gets or sets the ZCoordinate.
`PinballRegion`	Gets or sets the PinballRegion.
`RpmSelection`	Gets or sets the RpmSelection.
`Behavior`	Gets or sets the Behavior.
`DefineBy`	Gets or sets the DefineBy.
`LoadingApplicationType`	Gets or sets the LoadingApplicationType.
`StepVarying`	Gets or sets the StepVarying.
`NonCyclicLoadingType`	Gets or sets the NonCyclicLoadingType.
`IndependentVariable`	Gets or sets the IndependentVariable.
`FollowerLoad`	Gets or sets the FollowerLoad.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`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 RemoteForce.Direction: Ansys.ACT.Math.Vector3D | None: Gets or sets the Direction.

property RemoteForce.StepSelection: System.Int32 | None: Gets or sets the StepSelection.

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

property RemoteForce.BeamMaterial: System.String | None: Gets or sets the BeamMaterial.

property RemoteForce.NumberOfSegments: System.Int32 | None: Gets or sets the NumberOfSegments.

property RemoteForce.XComponent: Ansys.ACT.Mechanical.Fields.Field | None: Gets the XComponent.

property RemoteForce.XComponentImag: Ansys.ACT.Mechanical.Fields.Field | None: Gets the XComponentImag.

property RemoteForce.YComponent: Ansys.ACT.Mechanical.Fields.Field | None: Gets the YComponent.

property RemoteForce.YComponentImag: Ansys.ACT.Mechanical.Fields.Field | None: Gets the YComponentImag.

property RemoteForce.ZComponent: Ansys.ACT.Mechanical.Fields.Field | None: Gets the ZComponent.

property RemoteForce.ZComponentImag: Ansys.ACT.Mechanical.Fields.Field | None: Gets the ZComponentImag.

property RemoteForce.HarmonicIndex: Ansys.ACT.Mechanical.Fields.Field | None: Gets or sets the HarmonicIndex.

property RemoteForce.SectorNumber: Ansys.ACT.Mechanical.Fields.Field | None: Gets or sets the SectorNumber.

property RemoteForce.Magnitude: Ansys.ACT.Mechanical.Fields.Field | None: Gets the Magnitude.

property RemoteForce.MagnitudeImag: Ansys.ACT.Mechanical.Fields.Field | None: Gets the MagnitudeImag.

property RemoteForce.PhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None: Gets the PhaseAngle.

property RemoteForce.XPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None: Gets the XPhaseAngle.

property RemoteForce.YPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None: Gets the YPhaseAngle.

property RemoteForce.ZPhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None: Gets the ZPhaseAngle.

property RemoteForce.BeamRadius: Ansys.Core.Units.Quantity | None: Gets or sets the BeamRadius.

property RemoteForce.XCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the XCoordinate.

property RemoteForce.YCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the YCoordinate.

property RemoteForce.ZCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the ZCoordinate.

property RemoteForce.PinballRegion: Ansys.Core.Units.Quantity | None: Gets or sets the PinballRegion.

property RemoteForce.RpmSelection: Ansys.Core.Units.Quantity | None: Gets or sets the RpmSelection.

property RemoteForce.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None: Gets or sets the Behavior.

property RemoteForce.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None: Gets or sets the DefineBy.

property RemoteForce.LoadingApplicationType: Ansys.Mechanical.DataModel.Enums.LoadingApplicationType | None: Gets or sets the LoadingApplicationType.

property RemoteForce.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None: Gets or sets the StepVarying.

property RemoteForce.NonCyclicLoadingType: Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType | None: Gets or sets the NonCyclicLoadingType.

property RemoteForce.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or sets the IndependentVariable.

property RemoteForce.FollowerLoad: System.Boolean | None: Gets or sets the FollowerLoad.

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

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

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

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

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

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

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

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

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

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

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

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

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

Method detail#

RemoteForce.PromoteToRemotePoint() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.RemotePoint]: Run the PromoteToRemotePoint action.

RemoteForce.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean: GetActivateAtLoadStep method.

RemoteForce.SetActivateAtLoadStep(stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetActivateAtLoadStep method.

RemoteForce.GetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32) → System.Boolean: GetComponentActivateAtLoadStep method.

RemoteForce.SetComponentActivateAtLoadStep(component: System.String, stepNumber: System.UInt32, bActive: System.Boolean) → System.Void: SetComponentActivateAtLoadStep method.

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

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

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

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

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

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

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

RemoteForce.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

RemoteForce.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

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