Skip to main content

Mechanical scripting interface

LoadApplication

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.LoadApplication

Bases: object

Defines a LoadApplication.

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

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
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.
Magnitude Gets the Magnitude.
MagnitudeImag Gets the MagnitudeImag.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
Source Gets or sets the Source.
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.
YComponent Gets the YComponent.
YComponentImag Gets or sets the YComponentImag.
ZComponent Gets the ZComponent.
ZComponentImag Gets or sets the ZComponentImag.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets or sets the IndependentVariable.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the LoadVectorAssignment.

property LoadApplication.LoadVectorNumber : int | None

Gets or sets the LoadVectorNumber.

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

Gets the Magnitude.

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

Gets the MagnitudeImag.

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

Gets the list of properties for this object.

property LoadApplication.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property LoadApplication.Source : Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the Source.

property LoadApplication.StepSelection : int | None

Gets or sets the StepSelection.

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

Gets or sets the StepVarying.

property LoadApplication.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

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

Gets the XComponent.

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

Gets the XComponentImag.

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

Gets the YComponent.

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

Gets or sets the YComponentImag.

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

Gets the ZComponent.

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

Gets or sets the ZComponentImag.

Method detail

LoadApplication.Activate()

Activate the current object.

LoadApplication.AddComment()

Creates a new child Comment.

LoadApplication.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

LoadApplication.CreateParameter(propName: str)

Creates a new parameter for a Property.

LoadApplication.Delete()

Run the Delete action.

LoadApplication.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

LoadApplication.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

LoadApplication.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

LoadApplication.GroupSimilarObjects()

Run the GroupSimilarObjects action.

LoadApplication.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

LoadApplication.PropertyByName(name: str)

Get a property by its unique name.

LoadApplication.RemoveParameter(propName: str)

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