RemoteForce

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

Bases: object

Defines a RemoteForce.

Overview

Methods

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	GetActivateAtLoadStep method.
GetChildren	Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep	GetComponentActivateAtLoadStep method.
GetParameter	Gets the parameter corresponding to the given property.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PromoteToRemotePoint	Run the PromoteToRemotePoint 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	SetActivateAtLoadStep method.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.

Properties

BeamMaterial	Gets or sets the BeamMaterial.
BeamRadius	Gets or sets the BeamRadius.
Behavior	Gets or sets the Behavior.
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.
Direction	Gets or sets the Direction.
Figures	Gets the list of associated figures.
FollowerLoad	Gets or sets the FollowerLoad.
HarmonicIndex	Gets or sets the HarmonicIndex.
Images	Gets the list of associated images.
IndependentVariable	Gets or sets the IndependentVariable.
InternalObject	Gets the internal object. For advanced usage only.
LoadingApplicationType	Gets or sets the LoadingApplicationType.
Location	Gets or sets the Location.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
NonCyclicLoadingType	Gets or sets the NonCyclicLoadingType.
NumberOfSegments	Gets or sets the NumberOfSegments.
PhaseAngle	Gets the PhaseAngle.
PinballRegion	Gets or sets the PinballRegion.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
RpmSelection	Gets or sets the RpmSelection.
SectorNumber	Gets or sets the SectorNumber.
SharedRefBody	Gets or sets the SharedRefBody.
StepSelection	Gets or sets the StepSelection.
StepVarying	Gets or sets the StepVarying.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.
XComponent	Gets the XComponent.
XComponentImag	Gets the XComponentImag.
XCoordinate	Gets or sets the XCoordinate.
XPhaseAngle	Gets the XPhaseAngle.
YComponent	Gets the YComponent.
YComponentImag	Gets the YComponentImag.
YCoordinate	Gets or sets the YCoordinate.
YPhaseAngle	Gets the YPhaseAngle.
ZComponent	Gets the ZComponent.
ZComponentImag	Gets the ZComponentImag.
ZCoordinate	Gets or sets the ZCoordinate.
ZPhaseAngle	Gets the ZPhaseAngle.

Property detail

property RemoteForce.BeamMaterial: str | None

Gets or sets the BeamMaterial.

property RemoteForce.BeamRadius: Ansys.Core.Units.Quantity | None

Gets or sets the BeamRadius.

property RemoteForce.Behavior: Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the Behavior.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

Gets or sets the DefineBy.

property RemoteForce.Direction: Ansys.ACT.Math.Vector3D | None

Gets or sets the Direction.

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

Gets the list of associated figures.

property RemoteForce.FollowerLoad: bool | None

Gets or sets the FollowerLoad.

property RemoteForce.HarmonicIndex: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the HarmonicIndex.

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

Gets the list of associated images.

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

Gets or sets the IndependentVariable.

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

Gets the internal object. For advanced usage only.

property RemoteForce.LoadingApplicationType: Ansys.Mechanical.DataModel.Enums.LoadingApplicationType | None

Gets or sets the LoadingApplicationType.

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

Gets or sets the Location.

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.NonCyclicLoadingType: Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType | None

Gets or sets the NonCyclicLoadingType.

property RemoteForce.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

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

Gets the PhaseAngle.

property RemoteForce.PinballRegion: Ansys.Core.Units.Quantity | None

Gets or sets the PinballRegion.

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

Gets the list of properties for this object.

property RemoteForce.ReadOnly: bool | None

Gets or sets the ReadOnly.

property RemoteForce.RpmSelection: Ansys.Core.Units.Quantity | None

Gets or sets the RpmSelection.

property RemoteForce.SectorNumber: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the SectorNumber.

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

Gets or sets the SharedRefBody.

property RemoteForce.StepSelection: int | None

Gets or sets the StepSelection.

property RemoteForce.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None

Gets or sets the StepVarying.

property RemoteForce.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

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.XCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

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

Gets the XPhaseAngle.

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.YCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

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

Gets the YPhaseAngle.

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.ZCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

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

Gets the ZPhaseAngle.

Method detail

RemoteForce.Activate() → None

Activate the current object.

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: str) → 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.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

RemoteForce.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

RemoteForce.Delete() → None

Run the Delete action.

RemoteForce.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

RemoteForce.GetActivateAtLoadStep(stepNumber: int) → bool

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

RemoteForce.GetComponentActivateAtLoadStep(component: str, stepNumber: int) → bool

GetComponentActivateAtLoadStep method.

RemoteForce.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

RemoteForce.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

RemoteForce.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

RemoteForce.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

RemoteForce.PromoteToRemotePoint() → Iterable[Ansys.ACT.Automation.Mechanical.RemotePoint]

Run the PromoteToRemotePoint action.

RemoteForce.PropertyByAPIName(name: str) → 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.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

RemoteForce.RemoveParameter(propName: str) → None

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

RemoteForce.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None

SetActivateAtLoadStep method.

RemoteForce.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool) → None

SetComponentActivateAtLoadStep method.