TemperatureField

class ansys.speos.core.source.SourceThermic.TemperatureField(name, project, temperature_field, temperature_field_props, default_parameters=None, stable_ctr=False)

Type of thermic source exitance : temperature field.

Parameters:

namestr

Name of the feature.

projectansys.speos.core.project.Project

Project that will own the feature.

temperature_fieldansys.api.speos.source.v1.source_pb2.SourceTemplate.Thermic.TemperatureField

Temperature field to complete.

temperature_field_propsansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance.ThermicProperties.TemperatureFieldProperties

Temperature field properties to complete.

default_parametersOptional[ ansys.speos.core.generic.parameters.TemperatureFieldParameters

] = None

Uses default TemperatureFieldParameters values.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• name (str)

• project (SourceThermic.TemperatureField.__init__.project)

• temperature_field (ansys.api.speos.source.v1.source_pb2.SourceTemplate.Thermic.TemperatureField)

• temperature_field_props (ansys.speos.core.kernel.scene.ProtoScene.SourceInstance.ThermicProperties.TemperatureFieldProperties)

• default_parameters (Optional[ansys.speos.core.generic.parameters.TemperatureFieldParameters])

• stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_temperature_field method available in SourceThermic class.

Overview

Properties

temperature_field_uri	Property of temperature field file uri.
sop	Surface optical property of the thermic source.
axis_plane	Get axis plane.

Import detail

from ansys.speos.core.source.SourceThermic import TemperatureField

Property detail

property TemperatureField.temperature_field_uri: str

Property of temperature field file uri.

Parameters:

temperature_field_file_uri: Union[str, Path]

temperature field file uri.

Returns:

str

temperature field file uri.

property TemperatureField.sop: ansys.speos.core.opt_prop.BaseSop

Surface optical property of the thermic source.

Returns:

ansys.speos.core.opt_prop.OptProp

Surface optical property for the temperature field.

property TemperatureField.axis_plane: List[float]

Get axis plane.

Returns:

List[float]

Position of the temperature field [Ox Oy Oz Xx Xy Xz Yx Yy Yz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0].