## On this page

  

 

 # `HeatFlux`

 Last update: 16.07.2025 

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

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

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

Defines a HeatFlux.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

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

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

Gets the list of associated figures.

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

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

Gets or sets the GraphControlsXAxis.

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

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

Gets the list of associated images.

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

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

Gets or sets the IndependentVariable.

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

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

Gets the internal object. For advanced usage only.

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

### *property* HeatFlux.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

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

### *property* HeatFlux.Magnitude *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v242.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Magnitude.

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

### *property* HeatFlux.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="HeatFlux.Properties"></a>

### *property* HeatFlux.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="HeatFlux.ReadOnly"></a>

### *property* HeatFlux.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="HeatFlux.SharedRefBody"></a>

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

Gets or sets the SharedRefBody.

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

### *property* HeatFlux.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="HeatFlux.VisibleProperties"></a>

### *property* HeatFlux.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="HeatFlux.XYZFunctionCoordinateSystem"></a>

### *property* HeatFlux.XYZFunctionCoordinateSystem *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../CoordinateSystem.md#ansys.mechanical.stubs.v242.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="HeatFlux.Activate"></a>

### HeatFlux.Activate()

Activate the current object.

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

### HeatFlux.AddComment()

Creates a new child Comment.

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

### HeatFlux.AddFigure()

Creates a new child Figure.

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

### HeatFlux.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="HeatFlux.CopyTo"></a>

### HeatFlux.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

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

### HeatFlux.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

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

### HeatFlux.Delete()

Run the Delete action.

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

### HeatFlux.Duplicate()

Creates a copy of the current DataModelObject.

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

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

GetActivateAtLoadStep method.

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

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

Gets the list of children, filtered by type.

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

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

GetComponentActivateAtLoadStep method.

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

### HeatFlux.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

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

### HeatFlux.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### HeatFlux.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### HeatFlux.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

### HeatFlux.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```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="HeatFlux.PropertyByName"></a>

### HeatFlux.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

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

### HeatFlux.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

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

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

SetActivateAtLoadStep method.

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

### HeatFlux.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))

SetComponentActivateAtLoadStep method.