Force

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Force

Bases: object

Defines a Force.

Overview

Methods

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.
NumberOfSegments	Gets or sets the NumberOfSegments.
LoadVectorNumber	Gets or sets the LoadVectorNumber.
XComponent	Gets the XComponent.
XComponentImag	Gets the XComponentImag.
YComponent	Gets the YComponent.
YComponentImag	Gets or sets the YComponentImag.
ZComponent	Gets the ZComponent.
ZComponentImag	Gets or sets 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.
RangeMaximum	Gets or sets the RangeMaximum.
RangeMinimum	Gets or sets the RangeMinimum.
RpmSelection	Gets or sets the RpmSelection.
AppliedBy	Gets or sets the AppliedBy.
DefineBy	Gets or sets the DefineBy.
DynamicRelaxationBehavior	Gets or sets the DynamicRelaxationBehavior.
GraphControlsXAxis	Gets or sets the GraphControlsXAxis.
StepVarying	Gets or sets the StepVarying.
LoadVectorAssignment	Gets or sets the LoadVectorAssignment.
NonCyclicLoadingType	Gets or sets the NonCyclicLoadingType.
IndependentVariable	Gets or sets the IndependentVariable.
DivideLoadByNodes	Gets or sets the DivideLoadByNodes.
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 Force.Direction: Ansys.ACT.Math.Vector3D | None

Gets or sets the Direction.

property Force.StepSelection: System.Int32 | None

Gets or sets the StepSelection.

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

Gets the internal object. For advanced usage only.

property Force.NumberOfSegments: System.Int32 | None

Gets or sets the NumberOfSegments.

property Force.LoadVectorNumber: System.Int32 | None

Gets or sets the LoadVectorNumber.

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

Gets the XComponent.

property Force.XComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the XComponentImag.

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

Gets the YComponent.

property Force.YComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the YComponentImag.

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

Gets the ZComponent.

property Force.ZComponentImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the ZComponentImag.

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

Gets or sets the HarmonicIndex.

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

Gets or sets the SectorNumber.

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

Gets the Magnitude.

property Force.MagnitudeImag: Ansys.ACT.Mechanical.Fields.Field | None

Gets the MagnitudeImag.

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

Gets the PhaseAngle.

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

Gets the XPhaseAngle.

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

Gets the YPhaseAngle.

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

Gets the ZPhaseAngle.

property Force.RangeMaximum: Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property Force.RangeMinimum: Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

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

Gets or sets the RpmSelection.

property Force.AppliedBy: Ansys.Mechanical.DataModel.Enums.LoadAppliedBy | None

Gets or sets the AppliedBy.

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

Gets or sets the DefineBy.

property Force.DynamicRelaxationBehavior: Ansys.Mechanical.DataModel.Enums.DynamicRelaxationBehaviorType | None

Gets or sets the DynamicRelaxationBehavior.

property Force.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the GraphControlsXAxis.

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

Gets or sets the StepVarying.

property Force.LoadVectorAssignment: Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None

Gets or sets the LoadVectorAssignment.

property Force.NonCyclicLoadingType: Ansys.Mechanical.DataModel.Enums.NonCyclicLoadingType | None

Gets or sets the NonCyclicLoadingType.

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

Gets or sets the IndependentVariable.

property Force.DivideLoadByNodes: System.Boolean | None

Gets or sets the DivideLoadByNodes.

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

Gets or sets the CoordinateSystem.

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

Gets or sets the Location.

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

Gets the current DataModelObject’s category.

property Force.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

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

Gets or sets the SharedRefBody.

property Force.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Force.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Force.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Force.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Force.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property Force.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property Force.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Force.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

Force.GetActivateAtLoadStep(stepNumber: System.UInt32) → System.Boolean

GetActivateAtLoadStep method.

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

SetActivateAtLoadStep method.

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

GetComponentActivateAtLoadStep method.

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

SetComponentActivateAtLoadStep method.

Force.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

Force.Delete() → System.Void

Run the Delete action.

Force.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

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

Force.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Force.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

Force.Activate() → System.Void

Activate the current object.

Force.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

Force.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Force.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

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

Force.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Force.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Force.RemoveParameter(propName: System.String) → System.Void

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