## On this page

  

 

 # `ThermalCondition`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.BoundaryConditions.ThermalCondition"></a>

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

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#ThermalCondition.Activate)Activate the current object.[`AddComment`](#ThermalCondition.AddComment)Creates a new child Comment.[`AddFigure`](#ThermalCondition.AddFigure)Creates a new child Figure.[`AddImage`](#ThermalCondition.AddImage)Creates a new child Image.[`CopyTo`](#ThermalCondition.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#ThermalCondition.CreateParameter)CreateParameter method.[`Delete`](#ThermalCondition.Delete)Run the Delete action.[`Duplicate`](#ThermalCondition.Duplicate)Creates a copy of the current DataModelObject.[`GetActivateAtLoadStep`](#ThermalCondition.GetActivateAtLoadStep)Gets whether the thermal condition is active at the specified load step.[`GetChildren`](#ThermalCondition.GetChildren)Gets the list of children, filtered by type.[`GetComponentActivateAtLoadStep`](#ThermalCondition.GetComponentActivateAtLoadStep)GetComponentActivateAtLoadStep method.[`GetParameter`](#ThermalCondition.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#ThermalCondition.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#ThermalCondition.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PromoteToNamedSelection`](#ThermalCondition.PromoteToNamedSelection)Run the PromoteToNamedSelection action.[`PropertyByAPIName`](#ThermalCondition.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#ThermalCondition.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#ThermalCondition.RemoveParameter)RemoveParameter method.[`SetActivateAtLoadStep`](#ThermalCondition.SetActivateAtLoadStep)Sets whether the thermal condition is active at the specified load step.[`SetComponentActivateAtLoadStep`](#ThermalCondition.SetComponentActivateAtLoadStep)SetComponentActivateAtLoadStep method.### Properties

NameDescription[`Children`](#ThermalCondition.Children)Gets the list of children.[`Comments`](#ThermalCondition.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#ThermalCondition.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DefineBy`](#ThermalCondition.DefineBy)Gets the DefineBy.[`Figures`](#ThermalCondition.Figures)Gets the list of associated figures.[`GraphControlsXAxis`](#ThermalCondition.GraphControlsXAxis)Gets or sets the GraphControlsXAxis.[`Images`](#ThermalCondition.Images)Gets the list of associated images.[`IndependentVariable`](#ThermalCondition.IndependentVariable)Gets or sets the IndependentVariable.[`InternalObject`](#ThermalCondition.InternalObject)InternalObject property.[`LoadVectorAssignment`](#ThermalCondition.LoadVectorAssignment)Gets or sets the LoadVectorAssignment.[`LoadVectorNumber`](#ThermalCondition.LoadVectorNumber)Gets or sets the LoadVectorNumber.[`Location`](#ThermalCondition.Location)Gets or sets the Location.[`Magnitude`](#ThermalCondition.Magnitude)Gets or sets the Magnitude.[`NumberOfSegments`](#ThermalCondition.NumberOfSegments)Gets or sets the NumberOfSegments.[`Properties`](#ThermalCondition.Properties)Gets the list of properties for this object.[`RangeMaximum`](#ThermalCondition.RangeMaximum)Gets or sets the RangeMaximum.[`RangeMinimum`](#ThermalCondition.RangeMinimum)Gets or sets the RangeMinimum.[`ReadOnly`](#ThermalCondition.ReadOnly)Gets or sets the ReadOnly.[`SharedRefBody`](#ThermalCondition.SharedRefBody)Gets or sets the SharedRefBody.[`ShellFace`](#ThermalCondition.ShellFace)Gets or sets the ShellFace.[`Suppressed`](#ThermalCondition.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#ThermalCondition.VisibleProperties)Gets the list of properties that are visible for this object.[`XYZFunctionCoordinateSystem`](#ThermalCondition.XYZFunctionCoordinateSystem)Gets or sets the XYZFunctionCoordinateSystem.<a id="property-detail"></a>

## Property detail

<a id="ThermalCondition.Children"></a>

### *property* ThermalCondition.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="ThermalCondition.Comments"></a>

### *property* ThermalCondition.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="ThermalCondition.DataModelObjectCategory"></a>

### *property* ThermalCondition.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="ThermalCondition.DefineBy"></a>

### *property* ThermalCondition.DefineBy *: [Ansys.Mechanical.DataModel.Enums.LoadDefineBy](../../../../Mechanical/DataModel/Enums/LoadDefineBy.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadDefineBy) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the DefineBy.

<a id="ThermalCondition.Figures"></a>

### *property* ThermalCondition.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="ThermalCondition.GraphControlsXAxis"></a>

### *property* ThermalCondition.GraphControlsXAxis *: [Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType](../../../../Mechanical/DataModel/Enums/LoadVariableVariationType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GraphControlsXAxis.

<a id="ThermalCondition.Images"></a>

### *property* ThermalCondition.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="ThermalCondition.IndependentVariable"></a>

### *property* ThermalCondition.IndependentVariable *: [Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType](../../../../Mechanical/DataModel/Enums/LoadVariableVariationType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the IndependentVariable.

<a id="ThermalCondition.InternalObject"></a>

### *property* ThermalCondition.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | [None](https://docs.python.org/3/library/constants.html#None)*

InternalObject property.

<a id="ThermalCondition.LoadVectorAssignment"></a>

### *property* ThermalCondition.LoadVectorAssignment *: [Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment](../../../../Mechanical/DataModel/Enums/LoadVectorAssignment.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.LoadVectorAssignment) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadVectorAssignment.

<a id="ThermalCondition.LoadVectorNumber"></a>

### *property* ThermalCondition.LoadVectorNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadVectorNumber.

<a id="ThermalCondition.Location"></a>

### *property* ThermalCondition.Location *: [Ansys.ACT.Interfaces.Common.ISelectionInfo](../../../Interfaces/Common/ISelectionInfo.md#ansys.mechanical.stubs.v252.Ansys.ACT.Interfaces.Common.ISelectionInfo) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="ThermalCondition.Magnitude"></a>

### *property* ThermalCondition.Magnitude *: Any | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Magnitude.

<a id="ThermalCondition.NumberOfSegments"></a>

### *property* ThermalCondition.NumberOfSegments *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the NumberOfSegments.

<a id="ThermalCondition.Properties"></a>

### *property* ThermalCondition.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="ThermalCondition.RangeMaximum"></a>

### *property* ThermalCondition.RangeMaximum *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMaximum.

<a id="ThermalCondition.RangeMinimum"></a>

### *property* ThermalCondition.RangeMinimum *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMinimum.

<a id="ThermalCondition.ReadOnly"></a>

### *property* ThermalCondition.ReadOnly *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ReadOnly.

<a id="ThermalCondition.SharedRefBody"></a>

### *property* ThermalCondition.SharedRefBody *: [Ansys.ACT.Automation.Mechanical.Body](../Body.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Body) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SharedRefBody.

<a id="ThermalCondition.ShellFace"></a>

### *property* ThermalCondition.ShellFace *: [Ansys.Mechanical.DataModel.Enums.ShellFaceType](../../../../Mechanical/DataModel/Enums/ShellFaceType.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.ShellFaceType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ShellFace.

<a id="ThermalCondition.Suppressed"></a>

### *property* ThermalCondition.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="ThermalCondition.VisibleProperties"></a>

### *property* ThermalCondition.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="ThermalCondition.XYZFunctionCoordinateSystem"></a>

### *property* ThermalCondition.XYZFunctionCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the XYZFunctionCoordinateSystem.

<a id="method-detail"></a>

## Method detail

<a id="ThermalCondition.Activate"></a>

### ThermalCondition.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="ThermalCondition.AddComment"></a>

### ThermalCondition.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

<a id="ThermalCondition.AddFigure"></a>

### ThermalCondition.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

<a id="ThermalCondition.AddImage"></a>

### ThermalCondition.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)

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

```

<a id="ThermalCondition.CopyTo"></a>

### ThermalCondition.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="ThermalCondition.CreateParameter"></a>

### ThermalCondition.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

CreateParameter method.

<a id="ThermalCondition.Delete"></a>

### ThermalCondition.Delete() → [None](https://docs.python.org/3/library/constants.html#None)

Run the Delete action.

<a id="ThermalCondition.Duplicate"></a>

### ThermalCondition.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="ThermalCondition.GetActivateAtLoadStep"></a>

### ThermalCondition.GetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int)) → [bool](https://docs.python.org/3/library/functions.html#bool)

Gets whether the thermal condition is active at the specified load step.

<a id="ThermalCondition.GetChildren"></a>

### ThermalCondition.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="ThermalCondition.GetComponentActivateAtLoadStep"></a>

### ThermalCondition.GetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int)) → [bool](https://docs.python.org/3/library/functions.html#bool)

GetComponentActivateAtLoadStep method.

<a id="ThermalCondition.GetParameter"></a>

### ThermalCondition.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="ThermalCondition.GroupAllSimilarChildren"></a>

### ThermalCondition.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="ThermalCondition.GroupSimilarObjects"></a>

### ThermalCondition.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](../TreeGroupingFolder.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="ThermalCondition.PromoteToNamedSelection"></a>

### ThermalCondition.PromoteToNamedSelection() → Iterable\[[Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.NamedSelection)\]

Run the PromoteToNamedSelection action.

<a id="ThermalCondition.PropertyByAPIName"></a>

### ThermalCondition.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

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

```

<a id="ThermalCondition.PropertyByName"></a>

### ThermalCondition.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="ThermalCondition.RemoveParameter"></a>

### ThermalCondition.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

RemoveParameter method.

<a id="ThermalCondition.SetActivateAtLoadStep"></a>

### ThermalCondition.SetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool)) → [None](https://docs.python.org/3/library/constants.html#None)

Sets whether the thermal condition is active at the specified load step.

<a id="ThermalCondition.SetComponentActivateAtLoadStep"></a>

### ThermalCondition.SetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool)) → [None](https://docs.python.org/3/library/constants.html#None)

SetComponentActivateAtLoadStep method.