VolumeScatteringGegenbauer

class ansys.speos.core.input_files.material.VolumeScatteringGegenbauer(wavelengths=(), anisotropies=_DEFAULT_ANISOTROPIES, alphas=_DEFAULT_ALPHAS)

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

Gegenbauer scattering phase function.

Parameters:

wavelengthsSequence[float], optional

Wavelengths the factors are 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 at each wavelength. By default, [0.9].

alphasSequence[float], optional

Alpha coefficient at each wavelength. By default, [0.5].

Parameters:

• wavelengths (Sequence[float])

• anisotropies (Sequence[float])

• alphas (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.
alphas	Alpha coefficients, returned as a copy.

Attributes

MODEL	Identifier of the model in a *.material file.
VOLUMIC_HEADER	Header of the scattering block, which the Gegenbauer model bumps to v3.

Import detail

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

Property detail

property VolumeScatteringGegenbauer.wavelengths: List[float]

Spectral wavelengths in nm, returned as a copy.

Parameters:

valuesSequence[float]

New wavelengths the factors are 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 VolumeScatteringGegenbauer.anisotropies: List[float]

Anisotropy factors, returned as a copy.

Parameters:

valuesSequence[float]

New anisotropy factor at each wavelength.

Returns:

List[float]

Finite factors.

property VolumeScatteringGegenbauer.alphas: List[float]

Alpha coefficients, returned as a copy.

Parameters:

valuesSequence[float]

New alpha coefficient at each wavelength.

Returns:

List[float]

Finite coefficients.

Attribute detail

VolumeScatteringGegenbauer.MODEL: ClassVar[int] = 6

Identifier of the model in a *.material file.

VolumeScatteringGegenbauer.VOLUMIC_HEADER: ClassVar[str] = 'OPTIS - Volumic Scattering file v3'

Header of the scattering block, which the Gegenbauer model bumps to v3.

Method detail

VolumeScatteringGegenbauer.validate()

Check the phase function.

Raises:

ValueError

If no factor is given or the lists do not match.