LoadApplication#

class ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.BoundaryConditions.LoadApplication#

Bases: object

Defines a LoadApplication.

Overview#

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

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 load application is active at the specified load step.

AbsoluteResult

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.

InternalObject

Gets the internal object. For advanced usage only.

LoadVectorNumber

Magnitude

Gets the Magnitude.

MagnitudeImag

Gets the MagnitudeImag.

Properties

Gets the list of properties for this object.

ReadOnly

Gets or sets the ReadOnly.

ScopingMethod

SharedRefBody

Gets or sets the SharedRefBody.

Source

StepSelection

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

ZComponent

Gets the ZComponent.

ZComponentImag

Gets the ZComponentImag.

Property detail#

property LoadApplication.AbsoluteResult: bool | None#
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.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#

Gets the internal object. For advanced usage only.

property LoadApplication.LoadVectorNumber: int | None#
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.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#
property LoadApplication.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None#

Gets or sets the SharedRefBody.

property LoadApplication.Source: Ansys.ACT.Automation.Mechanical.DataModelObject | None#
property LoadApplication.StepSelection: int | None#
property LoadApplication.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None#
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 the YComponentImag.

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

Gets the ZComponent.

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

Gets the ZComponentImag.

Method detail#

LoadApplication.Activate() None#

Activate the current object.

LoadApplication.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

LoadApplication.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

LoadApplication.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.
LoadApplication.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

LoadApplication.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

LoadApplication.Delete() None#

Run the Delete action.

LoadApplication.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

LoadApplication.GetActivateAtLoadStep(stepNumber: int) bool#

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

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

Gets the list of children, filtered by type.

LoadApplication.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

LoadApplication.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

LoadApplication.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

LoadApplication.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

LoadApplication.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.
LoadApplication.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

LoadApplication.RemoveParameter(propName: str) None#

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

LoadApplication.SetActivateAtLoadStep(stepNumber: int, bActive: bool) None#

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