Skip to main content

Mechanical scripting interface

Acceleration

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.Acceleration

Bases: object

Defines a Acceleration.

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.
GetActivateAtLoadStep Gets whether the acceleration 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.
SetActivateAtLoadStep Sets whether the acceleration is active at the specified load step.

Properties

Name Description
AbsoluteResult Gets or sets the AbsoluteResult.
BaseExcitation Gets or sets the BaseExcitation.
BoundaryCondition Gets or sets the BoundaryCondition.
Children Gets the list of children.
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.
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.
Location Gets the Location.
Magnitude Gets the Magnitude.
MagnitudeImag Gets the MagnitudeImag.
NumberOfSegments Gets or sets the NumberOfSegments.
PhaseAngle Gets the PhaseAngle.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
RpmSelection Gets or sets the RPMSelection.
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.
YComponent Gets the YComponent.
ZComponent Gets the ZComponent.

Property detail

property Acceleration.AbsoluteResult : bool | None

Gets or sets the AbsoluteResult.

property Acceleration.BaseExcitation : bool | None

Gets or sets the BaseExcitation.

property Acceleration.BoundaryCondition : Any | None

Gets or sets the BoundaryCondition.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

property Acceleration.DefineBy : Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets or sets the DefineBy.

property Acceleration.Direction : Any | None

Gets or sets the Direction.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets or sets the IndependentVariable.

property Acceleration.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSAccelerationAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the LoadVectorAssignment.

property Acceleration.LoadVectorNumber : int | None

Gets or sets the LoadVectorNumber.

property Acceleration.Location : str | None

Gets the Location.

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

Gets the Magnitude.

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

Gets the MagnitudeImag.

property Acceleration.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

property Acceleration.PhaseAngle : Ansys.ACT.Mechanical.Fields.Field | None

Gets the PhaseAngle.

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

Gets the list of properties for this object.

property Acceleration.ReadOnly : bool | None

Gets or sets the ReadOnly.

property Acceleration.RpmSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPMSelection.

property Acceleration.StepSelection : int | None

Gets or sets the StepSelection.

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

Gets or sets the StepVarying.

property Acceleration.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

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

Gets the XComponent.

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

Gets the YComponent.

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

Gets the ZComponent.

Method detail

Acceleration.Activate()

Activate the current object.

Acceleration.AddComment()

Creates a new child Comment.

Acceleration.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

Acceleration.CreateParameter(propName: str)

Creates a new parameter for a Property.

Acceleration.Delete()

Run the Delete action.

Acceleration.Duplicate()

Creates a copy of the current DataModelObject.

Acceleration.GetActivateAtLoadStep(stepNumber: int)

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

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

Gets the list of children, filtered by type.

Acceleration.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Acceleration.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Acceleration.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

Acceleration.PropertyByName(name: str)

Get a property by its unique name.

Acceleration.RemoveParameter(propName: str)

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

Acceleration.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

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