## On this page

  

 

 # `Radiation`

 Last update: 16.07.2025 

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

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

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

Defines a Radiation.

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

## Overview

### Methods

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

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

## Property detail

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

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

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

Gets the list of children.

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

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

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

Gets or sets the Correlation.

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

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

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

### *property* Radiation.Emissivity *: [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 or sets the Emissivity.

<a id="Radiation.Enclosure"></a>

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

Gets or sets the Enclosure.

<a id="Radiation.EnclosureType"></a>

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

Gets or sets the EnclosureType.

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

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

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

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

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

Gets or sets the Location.

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

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

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

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

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

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

Gets or sets the ShellFace.

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

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

### *property* Radiation.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="method-detail"></a>

## Method detail

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

### Radiation.Activate()

Activate the current object.

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

### Radiation.AddComment()

Creates a new child Comment.

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

### Radiation.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### Radiation.Delete()

Run the Delete action.

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

### Radiation.Duplicate()

Creates a copy of the current DataModelObject.

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

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

GetActivateAtLoadStep method.

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

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

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

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

Gets the parameter corresponding to the given property.

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

### Radiation.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### Radiation.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### Radiation.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

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

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

Get a property by its unique name.

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

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

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

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