Skip to main content

Mechanical scripting interface

CondensedPartBase

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.CondensedPartBase

Bases: object

Defines a CondensedPartBase.

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.
ClearGeneratedData Run the ClearGeneratedData action.
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

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
GeometrySelection Gets or sets the GeometrySelection.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
NumberInterfaceEntries Gets the NumberInterfaceEntries.
NumberMasterNodes Gets the NumberMasterNodes.
Physics Gets the Physics.
Properties Gets the list of properties for this object.
ReferenceTemperature Gets or sets the ReferenceTemperature.
SolutionName Gets or sets the SolutionName.
SolutionNameMode Gets or sets the SolutionNameMode.
SolverFilesDirectory Gets the SolverFilesDirectory.
SolverUnitSystem Gets or sets the SolverUnitSystem.
SolverUnits Gets or sets the SolverUnits.
Suppressed Gets or sets the Suppressed.
TemperatureUnits Gets the TemperatureUnits.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property CondensedPartBase.GeometrySelection : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometrySelection.

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

Gets the list of associated images.

property CondensedPartBase.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCondensedPartAuto | None

Gets the internal object. For advanced usage only.

property CondensedPartBase.NumberInterfaceEntries : int | None

Gets the NumberInterfaceEntries.

property CondensedPartBase.NumberMasterNodes : int | None

Gets the NumberMasterNodes.

property CondensedPartBase.Physics : Ansys.Mechanical.DataModel.Enums.CondensedPartPhysics | None

Gets the Physics.

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

Gets the list of properties for this object.

property CondensedPartBase.ReferenceTemperature : Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceTemperature.

property CondensedPartBase.SolutionName : str | None

Gets or sets the SolutionName.

property CondensedPartBase.SolutionNameMode : Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets or sets the SolutionNameMode.

property CondensedPartBase.SolverFilesDirectory : str | None

Gets the SolverFilesDirectory.

property CondensedPartBase.SolverUnitSystem : Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None

Gets or sets the SolverUnitSystem.

property CondensedPartBase.SolverUnits : Ansys.Mechanical.DataModel.Enums.SolverUnitsControlType | None

Gets or sets the SolverUnits.

property CondensedPartBase.Suppressed : bool | None

Gets or sets the Suppressed.

property CondensedPartBase.TemperatureUnits : str | None

Gets the TemperatureUnits.

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

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

Method detail

CondensedPartBase.Activate()

Activate the current object.

CondensedPartBase.AddCommandSnippet()

Creates a new CommandSnippet

CondensedPartBase.AddComment()

Creates a new child Comment.

CondensedPartBase.AddFigure()

Creates a new child Figure.

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

CondensedPartBase.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

CondensedPartBase.CreateParameter(propName: str)

Creates a new parameter for a Property.

CondensedPartBase.Delete()

Run the Delete action.

CondensedPartBase.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

CondensedPartBase.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CondensedPartBase.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CondensedPartBase.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CondensedPartBase.PropertyByName(name: str)

Get a property by its unique name.

CondensedPartBase.RemoveParameter(propName: str)

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