MaterialBirefringentKettlerHelmholtz

class ansys.speos.core.input_files.material.MaterialBirefringentKettlerHelmholtz(a=None, b=None, c=None, optical_class=MaterialOpticalClass.negative_uniaxial)

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

Dispersion of a birefringent material given by the Kettler-Helmholtz coefficients.

Parameters:

a, b, cMaterialKettlerHelmholtz, optional

Coefficients of the index along the a, b and c axes. By default, an independent ansys.speos.core.input_files.material.MaterialKettlerHelmholtz model with its default coefficients per axis.

optical_classMaterialOpticalClass, optional

Optical class. By default, MaterialOpticalClass.negative_uniaxial.

Parameters:

• a (MaterialKettlerHelmholtz | None)

• b (MaterialKettlerHelmholtz | None)

• c (MaterialKettlerHelmholtz | None)

• optical_class (MaterialOpticalClass)

Overview

Methods

validate

Check the three coefficient models and optical class.

Properties

a	Coefficients along the a axis.
b	Coefficients along the b axis.
c	Coefficients along the c axis.
optical_class	Optical class of the material.

Attributes

KEYWORD	Keyword identifying the model in a *.material file.
COEFFICIENTS	Model holding the coefficients of a single axis.

Import detail

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

Property detail

property MaterialBirefringentKettlerHelmholtz.a: MaterialKettlerHelmholtz

Coefficients along the a axis.

Parameters:

valueMaterialKettlerHelmholtz

New coefficients of the index along the a, b and c axes.

Returns:

MaterialKettlerHelmholtz

Shared validated coefficient model.

property MaterialBirefringentKettlerHelmholtz.b: MaterialKettlerHelmholtz

Coefficients along the b axis.

Parameters:

valueMaterialKettlerHelmholtz

New coefficients of the index along the a, b and c axes.

Returns:

MaterialKettlerHelmholtz

Shared validated coefficient model.

property MaterialBirefringentKettlerHelmholtz.c: MaterialKettlerHelmholtz

Coefficients along the c axis.

Parameters:

valueMaterialKettlerHelmholtz

New coefficients of the index along the a, b and c axes.

Returns:

MaterialKettlerHelmholtz

Shared validated coefficient model.

property MaterialBirefringentKettlerHelmholtz.optical_class: MaterialOpticalClass

Optical class of the material.

Parameters:

valueMaterialOpticalClass

New optical class.

Returns:

MaterialOpticalClass

Negative uniaxial, positive uniaxial, or biaxial.

Attribute detail

MaterialBirefringentKettlerHelmholtz.KEYWORD: ClassVar[str] = 'Kettler-Helmotz'

Keyword identifying the model in a *.material file.

MaterialBirefringentKettlerHelmholtz.COEFFICIENTS: ClassVar[type]

Model holding the coefficients of a single axis.

Method detail

MaterialBirefringentKettlerHelmholtz.validate()

Check the three coefficient models and optical class.

Raises:

ValueError

If coefficients or optical class are invalid.