## On this page

  

 

 # `Convection`

 Last update: 16.07.2025 

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

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

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

Defines a Convection.

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

## Overview

### Methods

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

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

## Property detail

<a id="Convection.AmbientTemperature"></a>

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

Gets the AmbientTemperature.

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

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

Gets the list of children.

<a id="Convection.CoefficientType"></a>

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

Gets or sets the CoefficientType.

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

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

Gets the list of associated comments.

<a id="Convection.ConvectionMatrix"></a>

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

Gets or sets the ConvectionMatrix.

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

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

Gets the current DataModelObject’s category.

<a id="Convection.DisplayConnectionLines"></a>

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

Gets or sets the DisplayConnectionLines.

<a id="Convection.EditDataFor"></a>

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

Gets or sets the EditDataFor.

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

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

Gets the list of associated figures.

<a id="Convection.FilmCoefficient"></a>

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

Gets the FilmCoefficient.

<a id="Convection.FluidFlowEdge"></a>

### *property* Convection.FluidFlowEdge *: [Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.NamedSelection) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the FluidFlowEdge.

<a id="Convection.FluidFlowSelection"></a>

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

Gets or sets the FluidFlowSelection.

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

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

Gets or sets the GraphControlsXAxis.

<a id="Convection.HasFluidFlow"></a>

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

Gets or sets the HasFluidFlow.

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

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

Gets the list of associated images.

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

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

Gets or sets the IndependentVariable.

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

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

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

Gets or sets the Location.

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

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

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

### *property* Convection.RangeMaximum *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMaximum.

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

### *property* Convection.RangeMinimum *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMinimum.

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

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

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

Gets or sets the SharedRefBody.

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

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

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

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

### Convection.Activate()

Activate the current object.

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

### Convection.AddComment()

Creates a new child Comment.

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

### Convection.AddFigure()

Creates a new child Figure.

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

### Convection.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="Convection.CopyTo"></a>

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### Convection.Delete()

Run the Delete action.

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

### Convection.Duplicate()

Creates a copy of the current DataModelObject.

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

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

GetActivateAtLoadStep method.

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

### Convection.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="Convection.GetComponentActivateAtLoadStep"></a>

### Convection.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="Convection.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### Convection.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### Convection.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### Convection.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

### Convection.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="Convection.PropertyByName"></a>

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

Get a property by its unique name.

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

### Convection.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="Convection.SetActivateAtLoadStep"></a>

### Convection.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="Convection.SetComponentActivateAtLoadStep"></a>

### Convection.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.