Force

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Force(internalObject: Any)

Bases: object

Defines a Force.

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetActivateAtLoadStep	Gets whether the force is active at the specified load step.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep	GetComponentActivateAtLoadStep method.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
ToString	ToString method.

Properties

AppliedBy	Gets or sets the AppliedBy.
AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
HarmonicIndex	Gets or sets the HarmonicIndex.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
IndependentVariable	Gets or sets the IndependentVariable.
InternalObject	Gets the internal object. For advanced usage only.
LoadStepVarying	Gets or sets the LoadStepVarying.
LoadVectorAssignment	Gets or sets the LoadVectorAssignment.
LoadVectorNumber	Gets or sets the LoadVectorNumber.
LoadVectorNumberImaginary
LoadVectorNumberX
LoadVectorNumberXImaginary
LoadVectorNumberY
LoadVectorNumberYImaginary
LoadVectorNumberZ
LoadVectorNumberZImaginary
Location	Gets or sets the Location.
Magnitude	Gets the Magnitude.
MagnitudeImag	Gets the MagnitudeImag.
Name	Name property.
NonCyclicLoadingType	Gets or sets the NonCyclicLoadingType.
NumberOfSegments	Gets or sets the NumberOfSegments.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
RpmVarying	Gets or sets the RpmVarying.
SectorNumber	Gets or sets the SectorNumber.
SharedRefBody	Gets or sets the SharedRefBody.
State	State property.
StepSelection	Gets or sets the StepSelection.
StepVarying	Gets or sets the StepVarying.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property Force.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

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

Gets or sets the HarmonicIndex.

property Force.IconName: str | None

IconName property.

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

Gets the list of associated images.

property Force.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Gets or sets the LoadStepVarying.

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.LoadVectorNumberImaginary: int | None

property Force.LoadVectorNumberX: int | None

property Force.LoadVectorNumberXImaginary: int | None

property Force.LoadVectorNumberY: int | None

property Force.LoadVectorNumberYImaginary: int | None

property Force.LoadVectorNumberZ: int | None

property Force.LoadVectorNumberZImaginary: int | None

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.Name: str | None

Name property.

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.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property Force.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property Force.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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

Gets or sets the RpmVarying.

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

State property.

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.TransferableObjectId: str | None

TransferableObjectId property.

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() → None

Activate the current object.

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

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

Copies all visible properties from this object to another.

Force.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

Force.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Force.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

Force.GetAPIName(dispId: int) → str

Property name bound to dispId.

Force.GetActivateAtLoadStep(stepNumber: int) → bool

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

Force.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

Force.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

Force.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

Force.GetHashCode() → int

GetHashCode method.

Force.GetIconFile() → System.Byte

GetIconFile method.

Force.GetLifetimeService() → Any

GetLifetimeService method.

Force.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Force.GetPath() → str

GetPath method.

Force.GetPropertyName(dispId: int) → str

GetPropertyName method.

Force.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Force.GetType() → type

GetType method.

Force.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

Force.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Force.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Force.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Force.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Force.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

Run the PromoteToNamedSelection action.

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

Force.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

Force.RemoveParameter(propName: str) → None

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

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

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

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

SetComponentActivateAtLoadStep method.

Force.ToString() → str

ToString method.