`Acceleration`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Acceleration#

Bases: object

Defines a Acceleration.

Overview#

Methods

`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`Direction`	Gets or sets the Direction.
`BoundaryCondition`	Gets or sets the BoundaryCondition.
`StepSelection`	Gets or sets the StepSelection.
`InternalObject`	Gets the internal object. For advanced usage only.
`NumberOfSegments`	Gets or sets the NumberOfSegments.
`Location`	Gets the Location.
`LoadVectorNumber`	Gets or sets the LoadVectorNumber.
`XComponent`	Gets the XComponent.
`YComponent`	Gets the YComponent.
`ZComponent`	Gets the ZComponent.
`Magnitude`	Gets the Magnitude.
`MagnitudeImag`	Gets the MagnitudeImag.
`PhaseAngle`	Gets the PhaseAngle.
`RpmSelection`	Gets or sets the RpmSelection.
`DefineBy`	Gets or sets the DefineBy.
`LoadVectorAssignment`	Gets or sets the LoadVectorAssignment.
`StepVarying`	Gets or sets the StepVarying.
`IndependentVariable`	Gets or sets the IndependentVariable.
`AbsoluteResult`	Gets or sets the AbsoluteResult.
`BaseExcitation`	Gets or sets the BaseExcitation.
`Suppressed`	Gets or sets the Suppressed.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property Acceleration.Direction: System.Object | None: Gets or sets the Direction.

property Acceleration.BoundaryCondition: System.Object | None: Gets or sets the BoundaryCondition.

property Acceleration.StepSelection: System.Int32 | None: Gets or sets the StepSelection.

property Acceleration.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSAccelerationAuto | None: Gets the internal object. For advanced usage only.

property Acceleration.NumberOfSegments: System.Int32 | None: Gets or sets the NumberOfSegments.

property Acceleration.Location: System.String | None: Gets the Location.

property Acceleration.LoadVectorNumber: System.Int32 | None: Gets or sets the LoadVectorNumber.

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.

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.PhaseAngle: Ansys.ACT.Mechanical.Fields.Field | None: Gets the PhaseAngle.

property Acceleration.RpmSelection: Ansys.Core.Units.Quantity | None: Gets or sets the RpmSelection.

property Acceleration.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None: Gets or sets the DefineBy.

property Acceleration.LoadVectorAssignment: Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None: Gets or sets the LoadVectorAssignment.

property Acceleration.StepVarying: Ansys.Mechanical.DataModel.Enums.StepVarying | None: Gets or sets the StepVarying.

property Acceleration.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None: Gets or sets the IndependentVariable.

property Acceleration.AbsoluteResult: System.Boolean | None: Gets or sets the AbsoluteResult.

property Acceleration.BaseExcitation: System.Boolean | None: Gets or sets the BaseExcitation.

property Acceleration.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

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.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property Acceleration.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property Acceleration.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property Acceleration.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property Acceleration.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property Acceleration.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property Acceleration.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property Acceleration.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

Acceleration.Delete() → System.Void: Run the Delete action.

Acceleration.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

Acceleration.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

Acceleration.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

Acceleration.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

Acceleration.AddImage(filePath: System.String) → 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.

Acceleration.Activate() → System.Void: Activate the current object.

Acceleration.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

Acceleration.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

Acceleration.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

Acceleration.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

Acceleration.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

Acceleration.PropertyByAPIName(name: System.String) → 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.

Acceleration.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

Acceleration.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

Acceleration.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.