VolumeScatteringUserDefined

class ansys.speos.core.input_files.material.VolumeScatteringUserDefined(wavelengths=(), angles=_DEFAULT_PHASE_ANGLES, values=_DEFAULT_PHASE_VALUES)

Bases: ansys.speos.core.input_files._base._ValueComparable

Scattering phase function given as a scattering efficiency per angle.

Parameters:

wavelengthsSequence[float], optional

Wavelengths the efficiency is given at, in nm. Leave it empty when the phase function does not depend on the wavelength, in which case each row of values holds a single entry. By default, [].

anglesSequence[float], optional

Scattering angles theta, in degrees. By default, [0.0, 90.0, 180.0].

valuesSequence[Sequence[float]], optional

Relative scattering intensity, one row per angle and one column per wavelength. By default, [[100.0], [100.0], [100.0]], an isotropic phase function.

Parameters:

• wavelengths (Sequence[float])

• angles (Sequence[float])

• values (Sequence[Sequence[float]])

Overview

Methods

validate

Check the phase function.

Properties

wavelengths	Spectral wavelengths in nm, returned as a copy.
angles	Scattering angles in degrees, returned as a copy.
values	Relative intensities, returned with copied row containers.

Attributes

MODEL	Identifier of the model in a *.material file.
VOLUMIC_HEADER	Header of the scattering block holding the model.

Import detail

from ansys.speos.core.input_files.material import VolumeScatteringUserDefined

Property detail

property VolumeScatteringUserDefined.wavelengths: List[float]

Spectral wavelengths in nm, returned as a copy.

Parameters:

valuesSequence[float]

New wavelengths the efficiency is given at, in nm. Leave it empty when the phase function does not depend on the wavelength, in which case each row of values holds a single entry.

Returns:

List[float]

Empty for a nonspectral function, otherwise at least two wavelengths.

property VolumeScatteringUserDefined.angles: List[float]

Scattering angles in degrees, returned as a copy.

Parameters:

valuesSequence[float]

New scattering angles theta, in degrees.

Returns:

List[float]

Finite scattering angles.

property VolumeScatteringUserDefined.values: List[List[float]]

Relative intensities, returned with copied row containers.

Parameters:

valuesSequence[Sequence[float]]

New relative scattering intensity, one row per angle and one column per wavelength.

Returns:

List[List[float]]

One row per angle, one column per wavelength or one nonspectral value.

Attribute detail

VolumeScatteringUserDefined.MODEL: ClassVar[int] = 0

Identifier of the model in a *.material file.

VolumeScatteringUserDefined.VOLUMIC_HEADER: ClassVar[str] = 'OPTIS - Volumic Scattering file v1'

Header of the scattering block holding the model.

Method detail

VolumeScatteringUserDefined.validate()

Check the phase function.

Raises:

ValueError

If no angle is given, or the value grid does not match the angles and the wavelengths.