Skip to main content

Mechanical scripting interface

PointMass

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.PointMass

Bases: object

Defines a PointMass.

Overview

Methods

Name Description
Activate Activate the current object.
AddCommandSnippet Creates a new CommandSnippet
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.
PromoteToRemotePoint Run the PromoteToRemotePoint 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

Name Description
AppliedBy Gets or sets the AppliedBy.
BeamRadius Gets or sets the BeamRadius.
Behavior Gets or sets the Behavior.
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.
ElementAPDLName Gets or sets the ElementAPDLName.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsDistributedMass Gets the IsDistributedMass.
Location Gets or sets the Geometry.
Mass Gets or sets the Mass.
MassMomentOfInertiaX Gets or sets the MassMomentOfInertiaX.
MassMomentOfInertiaY Gets or sets the MassMomentOfInertiaY.
MassMomentOfInertiaZ Gets or sets the MassMomentOfInertiaZ.
Material Gets or sets the Material.
NodalCoordinateSystem Gets the NodalCoordinateSystem.
PinballRegion Gets or sets the PinballRegion.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
RemotePoint Gets the remote point associated to the point mass.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XCoordinate Gets or sets the XCoordinate.
YCoordinate Gets or sets the YCoordinate.
ZCoordinate Gets or sets the ZCoordinate.

Property detail

property PointMass.AppliedBy : Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the AppliedBy.

property PointMass.BeamRadius : Ansys.Core.Units.Quantity | None

Gets or sets the BeamRadius.

property PointMass.Behavior : Ansys.Mechanical.DataModel.Enums.LoadBehavior | None

Gets or sets the Behavior.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

property PointMass.ElementAPDLName : str | None

Gets or sets the ElementAPDLName.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property PointMass.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSPointMassAuto | None

Gets the internal object. For advanced usage only.

property PointMass.IsDistributedMass : bool | None

Gets the IsDistributedMass.

property PointMass.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Geometry.

property PointMass.Mass : Ansys.Core.Units.Quantity | None

Gets or sets the Mass.

property PointMass.MassMomentOfInertiaX : Ansys.Core.Units.Quantity | None

Gets or sets the MassMomentOfInertiaX.

property PointMass.MassMomentOfInertiaY : Ansys.Core.Units.Quantity | None

Gets or sets the MassMomentOfInertiaY.

property PointMass.MassMomentOfInertiaZ : Ansys.Core.Units.Quantity | None

Gets or sets the MassMomentOfInertiaZ.

property PointMass.Material : str | None

Gets or sets the Material.

property PointMass.NodalCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets the NodalCoordinateSystem.

property PointMass.PinballRegion : Ansys.Core.Units.Quantity | None

Gets or sets the PinballRegion.

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

Gets the list of properties for this object.

property PointMass.ReadOnly : bool | None

Gets or sets the ReadOnly.

property PointMass.RemotePoint : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets the remote point associated to the point mass.

property PointMass.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

property PointMass.XCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

property PointMass.YCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

property PointMass.ZCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

Method detail

PointMass.Activate()

Activate the current object.

PointMass.AddCommandSnippet()

Creates a new CommandSnippet

PointMass.AddComment()

Creates a new child Comment.

PointMass.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

PointMass.CreateParameter(propName: str)

Creates a new parameter for a Property.

PointMass.Delete()

Run the Delete action.

PointMass.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

PointMass.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

PointMass.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

PointMass.GroupSimilarObjects()

Run the GroupSimilarObjects action.

PointMass.PromoteToRemotePoint()

Run the PromoteToRemotePoint action.

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

PointMass.PropertyByName(name: str)

Get a property by its unique name.

PointMass.RemoveParameter(propName: str)

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