VolumeScatteringDoubleHenyeyGreenstein

class ansys.speos.core.input_files.material.VolumeScatteringDoubleHenyeyGreenstein(wavelengths=(), anisotropies_1=_DEFAULT_ANISOTROPIES, anisotropies_2=_DEFAULT_ANISOTROPIES, ratios=_DEFAULT_RATIOS)

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

Double Henyey-Greenstein 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, [].

anisotropies_1Sequence[float], optional

First anisotropy factor at each wavelength, between -1 and 1. By default, [0.9].

anisotropies_2Sequence[float], optional

Second anisotropy factor at each wavelength, between -1 and 1. By default, [0.9].

ratiosSequence[float], optional

Weight between the first and the second anisotropy factor, at each wavelength. Values must be between 0 and 1. By default, [0.5].

Parameters:

• wavelengths (Sequence[float])

• anisotropies_1 (Sequence[float])

• anisotropies_2 (Sequence[float])

• ratios (Sequence[float])

Overview

Methods

validate

Check the phase function.

Properties

wavelengths	Spectral wavelengths in nm, returned as a copy.
anisotropies_1	First anisotropy column, returned as a copy.
anisotropies_2	Second anisotropy column, returned as a copy.
ratios	Mixture weights, 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 VolumeScatteringDoubleHenyeyGreenstein

Property detail

property VolumeScatteringDoubleHenyeyGreenstein.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 VolumeScatteringDoubleHenyeyGreenstein.anisotropies_1: List[float]

First anisotropy column, returned as a copy.

Parameters:

valuesSequence[float]

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

Returns:

List[float]

Factors between -1 and 1.

property VolumeScatteringDoubleHenyeyGreenstein.anisotropies_2: List[float]

Second anisotropy column, returned as a copy.

Parameters:

valuesSequence[float]

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

Returns:

List[float]

Factors between -1 and 1.

property VolumeScatteringDoubleHenyeyGreenstein.ratios: List[float]

Mixture weights, returned as a copy.

Parameters:

valuesSequence[float]

New weight between the first and the second anisotropy factor, at each wavelength. Values must be between 0 and 1.

Returns:

List[float]

Mixture weights between 0 and 1.

Attribute detail

VolumeScatteringDoubleHenyeyGreenstein.MODEL: ClassVar[int] = 5

Identifier of the model in a *.material file.

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

Header of the scattering block holding the model.

Method detail

VolumeScatteringDoubleHenyeyGreenstein.validate()

Check the phase function.

Raises:

ValueError

If no factor is given, the lists do not match, an anisotropy is outside -1 to 1, or a mixture weight is outside 0 to 1.