ExitanceVariable#

class ansys.speos.core.source.SourceSurface.ExitanceVariable(exitance_variable, exitance_variable_props, default_parameters=None, stable_ctr=False)#

Type of surface source existence : existence variable.

Parameters:
exitance_variableansys.api.speos.source.v1.source_pb2.SourceTemplate.Surface.
ExitanceVariable

Existence variable to complete.

exitance_variable_propsansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance.
SurfaceProperties.ExitanceVariableProperties

Existence variable properties to complete.

default_parametersOptional[ ansys.speos.core.generic.parameters.VariableExitanceParameters] = None

If defined the values in the ExitanceVariable instance will be overwritten by the values of the data class.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

Notes

Do not instantiate this class yourself, use set_exitance_variable method available in Source classes.

Overview#

xmp_file_uri

Xmp file uri.

axis_plane

Axis plane of the variable exitance surface source.

Import detail#

from ansys.speos.core.source.SourceSurface import ExitanceVariable

Property detail#

property ExitanceVariable.xmp_file_uri: str#

Xmp file uri.

Parameters:
xmp_file_uriUnion[str, pathlib.Path]

xmp file uri.

Returns:
str

xmp file uri.

property ExitanceVariable.axis_plane: List[float]#

Axis plane of the variable exitance surface source.

Parameters:
axis_planeList[float]

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

Returns:
List[float]

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