NodalForce

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

Bases: object

Defines a NodalDisplacement.

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 nodal 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.
GetQuantityName	GetQuantityName 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 nodal force is active at the specified load step.
SetComponentActivateAtLoadStep	SetComponentActivateAtLoadStep method.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets the CoordinateSystem.
DataModelObjectCategory	Gets the current DataModelObject's category.
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.
LoadVectorAssignment	Gets or sets the LoadVectorAssignment.
LoadVectorNumber	Gets or sets the LoadVectorNumber.
LoadVectorNumberX
LoadVectorNumberXImaginary
LoadVectorNumberY
LoadVectorNumberYImaginary
LoadVectorNumberZ
LoadVectorNumberZImaginary
Location	Gets or sets the Location.
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 or sets 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.
SectorNumber	Gets or sets the SectorNumber.
SharedRefBody	Gets or sets the SharedRefBody.
State	State property.
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.
XYZFunctionCoordinateSystem	Gets or sets the XYZFunctionCoordinateSystem.
YComponent	Gets the YComponent.
ZComponent	Gets the ZComponent.

Property detail

property NodalForce.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property NodalForce.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the CoordinateSystem.

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

Gets the current DataModelObject's category.

property NodalForce.DivideLoadByNodes: bool | None

Gets or sets the DivideLoadByNodes.

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

Gets or sets the DynamicRelaxationBehavior.

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

Gets the list of associated figures.

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

Gets or sets the GraphControlsXAxis.

property NodalForce.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

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

Gets or sets the HarmonicIndex.

property NodalForce.IconName: str | None

IconName property.

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

Gets the list of associated images.

property NodalForce.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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

Gets or sets the IndependentVariable.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the LoadVectorAssignment.

property NodalForce.LoadVectorNumber: int | None

Gets or sets the LoadVectorNumber.

property NodalForce.LoadVectorNumberX: int | None

property NodalForce.LoadVectorNumberXImaginary: int | None

property NodalForce.LoadVectorNumberY: int | None

property NodalForce.LoadVectorNumberYImaginary: int | None

property NodalForce.LoadVectorNumberZ: int | None

property NodalForce.LoadVectorNumberZImaginary: int | None

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

Gets or sets the Location.

property NodalForce.Name: str | None

Name property.

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

Gets or sets the NonCyclicLoadingType.

property NodalForce.NumberOfSegments: int | None

Gets or sets the NumberOfSegments.

property NodalForce.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property NodalForce.PhaseAngle: Ansys.Core.Units.Quantity | None

Gets or sets the PhaseAngle.

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

Gets the list of properties for this object.

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

Gets or sets the RangeMaximum.

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

Gets or sets the RangeMinimum.

property NodalForce.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SectorNumber.

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

Gets or sets the SharedRefBody.

property NodalForce.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property NodalForce.Suppressed: bool | None

Gets or sets the Suppressed.

property NodalForce.TransferableObjectId: str | None

TransferableObjectId property.

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

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

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

Gets the XComponent.

property NodalForce.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the XYZFunctionCoordinateSystem.

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

Gets the YComponent.

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

Gets the ZComponent.

Method detail

NodalForce.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

NodalForce.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

NodalForce.GetAPIName(dispId: int) → str

Property name bound to dispId.

NodalForce.GetActivateAtLoadStep(stepNumber: int) → bool

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

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetComponentActivateAtLoadStep method.

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

GetDetailsView method.

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

Enum name bound to value

NodalForce.GetHashCode() → int

GetHashCode method.

NodalForce.GetIconFile() → System.Byte

GetIconFile method.

NodalForce.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

NodalForce.GetPath() → str

GetPath method.

NodalForce.GetPropertyName(dispId: int) → str

GetPropertyName method.

NodalForce.GetPropertyValue(name: str) → Any

GetPropertyValue method.

NodalForce.GetQuantityName() → str

GetQuantityName method.

NodalForce.GetType() → type

GetType method.

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

GetVisibleProperties method.

NodalForce.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

NodalForce.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

NodalForce.InitializeLifetimeService() → Any

InitializeLifetimeService method.

NodalForce.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

NodalForce.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

Run the PromoteToNamedSelection action.

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

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

PropertyById method.

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

Get a property by its unique name.

NodalForce.RemoveParameter(propName: str) → None

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

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

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

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

SetComponentActivateAtLoadStep method.

NodalForce.ToString() → str

ToString method.