Skip to main content

Mechanical scripting interface

ThermalPointMass

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ThermalPointMass

Bases: object

Defines a ThermalPointMass.

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.
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.
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.
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.
ThermalCapacitance Gets or sets the ThermalCapacitance.
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 ThermalPointMass.AppliedBy : Ansys.Mechanical.DataModel.Enums.RemoteApplicationType | None

Gets or sets the AppliedBy.

property ThermalPointMass.Behavior : Ansys.Mechanical.DataModel.Enums.ThermalPointMassBehavior | None

Gets or sets the Behavior.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property ThermalPointMass.IsDistributedMass : bool | None

Gets the IsDistributedMass.

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

Gets or sets the Geometry.

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

Gets or sets the PinballRegion.

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

Gets the list of properties for this object.

property ThermalPointMass.ReadOnly : bool | None

Gets or sets the ReadOnly.

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

Gets the remote point associated to the point mass.

property ThermalPointMass.Suppressed : bool | None

Gets or sets the Suppressed.

property ThermalPointMass.ThermalCapacitance : Ansys.Core.Units.Quantity | None

Gets or sets the ThermalCapacitance.

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

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

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

Gets or sets the XCoordinate.

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

Gets or sets the YCoordinate.

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

Gets or sets the ZCoordinate.

Method detail

ThermalPointMass.Activate()

Activate the current object.

ThermalPointMass.AddCommandSnippet()

Creates a new CommandSnippet

ThermalPointMass.AddComment()

Creates a new child Comment.

ThermalPointMass.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ThermalPointMass.CreateParameter(propName: str)

Creates a new parameter for a Property.

ThermalPointMass.Delete()

Run the Delete action.

ThermalPointMass.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ThermalPointMass.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ThermalPointMass.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ThermalPointMass.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ThermalPointMass.PromoteToRemotePoint()

Run the PromoteToRemotePoint action.

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

ThermalPointMass.PropertyByName(name: str)

Get a property by its unique name.

ThermalPointMass.RemoveParameter(propName: str)

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