VolumeScatteringHenyeyGreenstein

class ansys.speos.core.input_files.material.VolumeScatteringHenyeyGreenstein(wavelengths=(), anisotropies=_DEFAULT_ANISOTROPIES)

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

Henyey-Greenstein scattering phase function.

Parameters:

wavelengthsSequence[float], optional

Wavelengths the anisotropy factor is given at, in nm. A single wavelength means that the phase function does not depend on the wavelength. By default, [].

anisotropiesSequence[float], optional

Anisotropy factor g at each wavelength, between -1 and 1. By default, [0.9].

Parameters:

• wavelengths (Sequence[float])

• anisotropies (Sequence[float])

Overview

Methods

validate

Check the phase function.

Properties

wavelengths	Spectral wavelengths in nm, returned as a copy.
anisotropies	Anisotropy factors, returned as a copy.

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 VolumeScatteringHenyeyGreenstein

Property detail

property VolumeScatteringHenyeyGreenstein.wavelengths: List[float]

Spectral wavelengths in nm, returned as a copy.

Parameters:

valuesSequence[float]

New wavelengths the anisotropy factor is given at, in nm. A single wavelength means that the phase function does not depend on the wavelength.

Returns:

List[float]

Empty for a nonspectral parameter set.

property VolumeScatteringHenyeyGreenstein.anisotropies: List[float]

Anisotropy factors, returned as a copy.

Parameters:

valuesSequence[float]

New anisotropy factor g at each wavelength, between -1 and 1.

Returns:

List[float]

Factors between -1 and 1.

Attribute detail

VolumeScatteringHenyeyGreenstein.MODEL: ClassVar[int] = 1

Identifier of the model in a *.material file.

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

Header of the scattering block holding the model.

Method detail

VolumeScatteringHenyeyGreenstein.validate()

Check the phase function.

Raises:

ValueError

If no anisotropy factor is given, the lists do not match, or an anisotropy factor is outside the -1 to 1 range.