Mechanical scripting interface 2025

`JointLoad`

Last update: 16.07.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.JointLoad

Bases: object

Defines a JointLoad.

Overview

Methods

Name Description
Activate Activate the current object.
AddCommandSnippet Creates a new CommandSnippet
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 joint is active at the specified load step.
GetChildren Gets the list of children, filtered by type.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects 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.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.
SetActivateAtLoadStep Sets whether the joint is active at the specified load step.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
CutoffFrequency Gets or sets the CutoffFrequency.
DOF Gets or sets the DOF.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
FittingMethod Gets or sets the FittingMethod.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Joint Gets or sets the Joint.
JointConditionType Gets or sets the JointConditionType.
LockAtLoadStep Gets or sets the LockAtLoadStep.
Magnitude Gets the Magnitude.
NumberOfSegments Gets or sets the NumberOfSegments.
Properties Gets the list of properties for this object.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property JointLoad.CutoffFrequency : float | None

Gets or sets the CutoffFrequency.

property JointLoad.DOF : Ansys.Mechanical.DataModel.Enums.KinematicDOF | None

Gets or sets the DOF.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property JointLoad.FittingMethod : Ansys.Mechanical.DataModel.Enums.FittingMethodType | None

Gets or sets the FittingMethod.

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

Gets the list of associated images.

property JointLoad.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSJointConditionAuto | None

Gets the internal object. For advanced usage only.

property JointLoad.Joint : Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the Joint.

property JointLoad.JointConditionType : Ansys.Mechanical.DataModel.Enums.JointConditionType | None

Gets or sets the JointConditionType.

property JointLoad.LockAtLoadStep : int | None

Gets or sets the LockAtLoadStep.

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

Gets the Magnitude.

property JointLoad.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property JointLoad.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

JointLoad.Activate() → None

Activate the current object.

JointLoad.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

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

Creates a new child Comment.

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

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

JointLoad.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

JointLoad.GetActivateAtLoadStep(stepNumber: int) → bool

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

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

JointLoad.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

JointLoad.RemoveParameter(propName: str) → None

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

JointLoad.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

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

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

Connect with Ansys