`Acceleration`#

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Acceleration(internalObject: Any)#

Bases: object

Defines a Acceleration.

Overview#

Methods

`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.
`CreateObjRef`	CreateObjRef method.
`CreateParameter`	Creates a new parameter for a Property.
`Delete`	Run the Delete action.
`Duplicate`	Creates a copy of the current DataModelObject.
`Equals`	Equals method.
`GetAPIName`	Property name bound to dispId.
`GetActivateAtLoadStep`	Gets whether the acceleration is active at the specified load step.
`GetAllProperties`	GetAllProperties method.
`GetChildren`	Gets the list of children, filtered by type.
`GetDetailsView`	GetDetailsView method.
`GetEnumName`	Enum name bound to value
`GetHashCode`	GetHashCode method.
`GetIconFile`	GetIconFile method.
`GetLifetimeService`	GetLifetimeService method.
`GetObjectData`	GetObjectData method.
`GetParameter`	Gets the parameter corresponding to the given property.
`GetPath`	GetPath method.
`GetPropertyName`	GetPropertyName method.
`GetPropertyValue`	GetPropertyValue method.
`GetType`	GetType method.
`GetVisibleProperties`	GetVisibleProperties method.
`GetVisiblePropertyNames`	GetVisiblePropertyNames method.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`InitializeLifetimeService`	InitializeLifetimeService method.
`IsPropertyEditable`	IsPropertyEditable method.
`IsPropertyVisible`	IsPropertyVisible method.
`PropertyByAPIName`	Get a property by its API name.
`PropertyById`	PropertyById method.
`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.
`ToString`	ToString method.

Properties

`AbsoluteResult`	Gets or sets the AbsoluteResult.
`AttachedRefs`	AttachedRefs property.
`BaseExcitation`	Gets or sets the BaseExcitation.
`BoundaryCondition`	Gets or sets the BoundaryCondition.
`Children`	Gets the list of children.
`ClsId`	ClsId property.
`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.
`GroupingFolder`	GroupingFolder property.
`IconName`	IconName property.
`Images`	Gets the list of associated images.
`ImportableObjectSourceId`	ImportableObjectSourceId property.
`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.
`LoadVectorNumberX`
`LoadVectorNumberY`
`LoadVectorNumberZ`
`Location`	Gets the Location.
`Magnitude`	Gets the Magnitude.
`MagnitudeImag`	Gets the MagnitudeImag.
`Name`	Name property.
`NumberOfSegments`	Gets or sets the NumberOfSegments.
`ObjectId`	ObjectId property.
`ObjectState`	ObjectState property.
`ObjectTags`	ObjectTags property.
`Parent`	Parent property.
`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.
`RpmVarying`	Gets or sets the RpmVarying.
`State`	State property.
`StepSelection`	Gets or sets the StepSelection.
`StepVarying`	Gets or sets the StepVarying.
`Suppressed`	Gets or sets the Suppressed.
`TransferableObjectId`	TransferableObjectId property.
`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.AttachedRefs: List[int] | None#: AttachedRefs property.

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.ClsId: int | None#: ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: GroupingFolder property.

property Acceleration.IconName: str | None#: IconName property.

property Acceleration.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property Acceleration.ImportableObjectSourceId: str | None#: ImportableObjectSourceId property.

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.LoadVectorNumberX: int | None#

property Acceleration.LoadVectorNumberY: int | None#

property Acceleration.LoadVectorNumberZ: int | None#

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.Name: str | None#: Name property.

property Acceleration.NumberOfSegments: int | None#: Gets or sets the NumberOfSegments.

property Acceleration.ObjectId: int | None#: ObjectId property.

property Acceleration.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#: ObjectState property.

property Acceleration.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#: ObjectTags property.

property Acceleration.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: Parent property.

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.RpmVarying: bool | None#: Gets or sets the RpmVarying.

property Acceleration.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#: State property.

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.TransferableObjectId: str | None#: TransferableObjectId property.

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() → None#: Activate the current object.

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

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

Acceleration.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef#: CreateObjRef method.

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

Acceleration.Delete() → None#: Run the Delete action.

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

Acceleration.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool#: Equals method.

Acceleration.GetAPIName(dispId: int) → str#: Property name bound to dispId.

Acceleration.GetActivateAtLoadStep(stepNumber: int) → bool#: Gets whether the acceleration is active at the specified load step.

Acceleration.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#: GetAllProperties method.

Acceleration.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

Acceleration.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData#: GetDetailsView method.

Acceleration.GetEnumName(enumType: type, value: int, dispId: int) → str#: Enum name bound to value

Acceleration.GetHashCode() → int#: GetHashCode method.

Acceleration.GetIconFile() → System.Byte#: GetIconFile method.

Acceleration.GetLifetimeService() → Any#: GetLifetimeService method.

Acceleration.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None#: GetObjectData method.

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

Acceleration.GetPath() → str#: GetPath method.

Acceleration.GetPropertyName(dispId: int) → str#: GetPropertyName method.

Acceleration.GetPropertyValue(name: str) → Any#: GetPropertyValue method.

Acceleration.GetType() → type#: GetType method.

Acceleration.GetVisibleProperties() → List[System.Reflection.PropertyInfo]#: GetVisibleProperties method.

Acceleration.GetVisiblePropertyNames() → List[str]#: GetVisiblePropertyNames method.

Acceleration.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

Acceleration.InitializeLifetimeService() → Any#: InitializeLifetimeService method.

Acceleration.IsPropertyEditable(dispId: int) → bool#: IsPropertyEditable method.

Acceleration.IsPropertyVisible(dispId: int) → bool#: IsPropertyVisible method.

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

Acceleration.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property#: PropertyById method.

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

Acceleration.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

Acceleration.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None#: Sets whether the acceleration is active at the specified load step.

Acceleration.ToString() → str#: ToString method.

Acceleration#

Overview#

Property detail#

Method detail#

`Acceleration`#