Mechanical scripting interface 2024

`ThermalCondition`

Last update: 16.07.2025

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.ThermalCondition

Bases: object

Defines a ThermalCondition.

Overview

Methods

Name Description
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.
GetActivateAtLoadStep GetActivateAtLoadStep method.
GetChildren Gets the list of children, filtered by type.
GetComponentActivateAtLoadStep GetComponentActivateAtLoadStep method.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PromoteToNamedSelection Run the PromoteToNamedSelection 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.
SetActivateAtLoadStep SetActivateAtLoadStep method.
SetComponentActivateAtLoadStep SetComponentActivateAtLoadStep method.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
DefineBy Gets the DefineBy.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
Images Gets the list of associated images.
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.
Location Gets or sets the Location.
Magnitude Gets or sets the Magnitude.
NumberOfSegments Gets or sets the NumberOfSegments.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
ShellFace Gets or sets the ShellFace.
Suppressed Gets or sets the Suppressed.
TableAssignment Gets or sets the TableAssignment.
VisibleProperties Gets the list of properties that are visible for this object.
XYZFunctionCoordinateSystem Gets or sets the XYZFunctionCoordinateSystem.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property ThermalCondition.DefineBy : Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None

Gets the DefineBy.

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

Gets the list of associated figures.

property ThermalCondition.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the GraphControlsXAxis.

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

Gets the list of associated images.

property ThermalCondition.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

property ThermalCondition.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

Gets the internal object. For advanced usage only.

property ThermalCondition.LoadVectorAssignment : Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment | None

Gets or sets the LoadVectorAssignment.

property ThermalCondition.LoadVectorNumber : int | None

Gets or sets the LoadVectorNumber.

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

Gets or sets the Location.

property ThermalCondition.Magnitude : Ansys.ACT.Mechanical.Fields.Field | None

Gets or sets the Magnitude.

property ThermalCondition.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property ThermalCondition.RangeMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property ThermalCondition.RangeMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property ThermalCondition.ReadOnly : bool | None

Gets or sets the ReadOnly.

property ThermalCondition.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property ThermalCondition.ShellFace : Ansys.Mechanical.DataModel.Enums.ShellFaceType | None

Gets or sets the ShellFace.

property ThermalCondition.Suppressed : bool | None

Gets or sets the Suppressed.

property ThermalCondition.TableAssignment : Ansys.ACT.Automation.Mechanical.Table | None

Gets or sets the TableAssignment.

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

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

property ThermalCondition.XYZFunctionCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the XYZFunctionCoordinateSystem.

Method detail

ThermalCondition.Activate()

Activate the current object.

ThermalCondition.AddComment()

Creates a new child Comment.

ThermalCondition.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ThermalCondition.CreateParameter(propName: str)

Creates a new parameter for a Property.

ThermalCondition.Delete()

Run the Delete action.

ThermalCondition.Duplicate()

Creates a copy of the current DataModelObject.

ThermalCondition.GetActivateAtLoadStep(stepNumber: int)

GetActivateAtLoadStep method.

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

Gets the list of children, filtered by type.

ThermalCondition.GetComponentActivateAtLoadStep(component: str, stepNumber: int)

GetComponentActivateAtLoadStep method.

ThermalCondition.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ThermalCondition.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ThermalCondition.GroupSimilarObjects()

Run the GroupSimilarObjects action.

ThermalCondition.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

ThermalCondition.PropertyByName(name: str)

Get a property by its unique name.

ThermalCondition.RemoveParameter(propName: str)

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

ThermalCondition.SetActivateAtLoadStep(stepNumber: int, bActive: bool)

SetActivateAtLoadStep method.

ThermalCondition.SetComponentActivateAtLoadStep(component: str, stepNumber: int, bActive: bool)

SetComponentActivateAtLoadStep method.

Connect with Ansys