EarthGravity

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.EarthGravity

Bases: object

Defines a EarthGravity.

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

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.
Direction	Gets or sets the Direction.
Figures	Gets the list of associated figures.
GeometrySelection	Gets the GeometrySelection.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
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 EarthGravity.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

property EarthGravity.Direction: Ansys.Mechanical.DataModel.Enums.GravityOrientationType | None

Gets or sets the Direction.

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

Gets the list of associated figures.

property EarthGravity.GeometrySelection: str | None

Gets the GeometrySelection.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets the list of properties for this object.

property EarthGravity.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

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

Gets the XComponent.

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

Gets the YComponent.

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

Gets the ZComponent.

Method detail

EarthGravity.Activate() → None

Activate the current object.

EarthGravity.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

EarthGravity.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

EarthGravity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

EarthGravity.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

EarthGravity.Delete() → None

Run the Delete action.

EarthGravity.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

EarthGravity.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

EarthGravity.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

EarthGravity.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

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

EarthGravity.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

EarthGravity.RemoveParameter(propName: str) → None

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