Skip to main content

Mechanical scripting interface

Force

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Force

Bases: object

Defines a Force.

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.
GetActivateAtLoadStep Gets whether the force is active at the specified load step.
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.
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 Sets whether the force is active at the specified load step.
SetComponentActivateAtLoadStep SetComponentActivateAtLoadStep method.

Properties

Name Description
AppliedBy Gets or sets the AppliedBy.
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.
DivideLoadByNodes Gets or sets the DivideLoadByNodes.
DynamicRelaxationBehavior Gets or sets the DynamicRelaxationBehavior.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
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.
LoadVectorAssignment Gets or sets the LoadVectorAssignment.
LoadVectorNumber Gets or sets the LoadVectorNumber.
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.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
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.
XPhaseAngle Gets the XPhaseAngle.
YComponent Gets the YComponent.
YComponentImag Gets or sets the YComponentImag.
YPhaseAngle Gets the YPhaseAngle.
ZComponent Gets the ZComponent.
ZComponentImag Gets or sets the ZComponentImag.
ZPhaseAngle Gets the ZPhaseAngle.

Property detail

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

Gets or sets the AppliedBy.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DefineBy.

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

Gets or sets the Direction.

property Force.DivideLoadByNodes : bool | None

Gets or sets the DivideLoadByNodes.

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

Gets or sets the DynamicRelaxationBehavior.

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

Gets the list of associated figures.

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

Gets or sets the GraphControlsXAxis.

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

Gets or sets the HarmonicIndex.

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

Gets the list of associated images.

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

Gets or sets the IndependentVariable.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the LoadVectorAssignment.

property Force.LoadVectorNumber : int | None

Gets or sets the LoadVectorNumber.

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

Gets or sets the Location.

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

Gets or sets the NonCyclicLoadingType.

property Force.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets or sets the RPMSelection.

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

Gets or sets the SectorNumber.

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

Gets or sets the SharedRefBody.

property Force.StepSelection : int | None

Gets or sets the StepSelection.

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

Gets or sets the StepVarying.

property Force.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

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.XPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the XPhaseAngle.

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.YPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the YPhaseAngle.

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.ZPhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the ZPhaseAngle.

Method detail

Force.Activate()

Activate the current object.

Force.AddComment()

Creates a new child Comment.

Force.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

Force.CreateParameter(propName: str)

Creates a new parameter for a Property.

Force.Delete()

Run the Delete action.

Force.Duplicate()

Creates a copy of the current DataModelObject.

Force.GetActivateAtLoadStep(stepNumber: int)

Gets whether the force is active at the specified load step.

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

Gets the list of children, filtered by type.

Force.GetComponentActivateAtLoadStep(component: str, stepNumber: int)

GetComponentActivateAtLoadStep method.

Force.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Force.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Force.GroupSimilarObjects()

Run the GroupSimilarObjects action.

Force.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

Force.PropertyByName(name: str)

Get a property by its unique name.

Force.RemoveParameter(propName: str)

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

Force.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

Sets whether the force is active at the specified load step.

Force.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)

SetComponentActivateAtLoadStep method.