Flux

class ansys.speos.core.source.BaseSource.Flux(flux, default_parameters=None, stable_ctr=False)

Type of flux.

By default, Luminous flux value is set with value 683 lm.

Parameters:

fluxansys.api.speos.source.v1.source_pb2

flux protobuf object to modify.

default_parametersOptional[ ansys.speos.core.generic.parameters.LuminousFluxParameters, ansys.speos.core.generic.parameters.RadiantFluxParameters, ansys.speos.core.generic.parameters.FluxFromFileParameters, ansys.speos.core.generic.parameters.IntensityFluxParameters] = None

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

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• flux (ansys.api.speos.source.v1.source_pb2)

• default_parameters (Optional[Union[ansys.speos.core.generic.parameters.LuminousFluxParameters, ansys.speos.core.generic.parameters.RadiantFluxParameters, ansys.speos.core.generic.parameters.FluxFromFileParameters, ansys.speos.core.generic.parameters.IntensityFluxParameters]])

• stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_flux method available in source classes.

Overview

Methods

set_luminous	Set flux type luminous.
set_radiant	Set flux type radiant.

Properties

value

Property of flux type’s value.

Import detail

from ansys.speos.core.source.BaseSource import Flux

Property detail

property Flux.value: float

Property of flux type’s value.

Parameters:

valuefloat

Value of the flux.

Returns:

float

Flux type value.

Method detail

Flux.set_luminous()

Set flux type luminous.

Returns:

ansys.speos.core.source.BaseSource.Flux

Flux object

Flux.set_radiant()

Set flux type radiant.

Returns:

ansys.speos.core.source.BaseSource.Flux

Flux object