MaterialKettlerHelmholtz

class ansys.speos.core.input_files.material.MaterialKettlerHelmholtz(a0=1.0, a1=0.0, a2=0.0, a3=0.0, a4=0.0, a5=0.0)

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

Dispersion of a glass given by the Kettler-Helmholtz coefficients.

Parameters:

a0float, optional

Constant coefficient of the Kettler-Helmholtz equation. By default, 1.0.

a1, a2, a3, a4, a5float, optional

Other coefficients of the Kettler-Helmholtz equation. By default, 0.0.

Parameters:

• a0 (float)

• a1 (float)

• a2 (float)

• a3 (float)

• a4 (float)

• a5 (float)

Overview

Methods

validate

Check all coefficients are finite.

Properties

a0	Constant coefficient.
a1	First coefficient.
a2	Second coefficient.
a3	Third coefficient.
a4	Fourth coefficient.
a5	Fifth coefficient.

Attributes

KEYWORD

Keyword identifying the model in a *.material file.

Import detail

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

Property detail

property MaterialKettlerHelmholtz.a0: float

Constant coefficient.

Parameters:

valuefloat

New coefficients of the Kettler-Helmholtz equation.

Returns:

float

Finite coefficient.

property MaterialKettlerHelmholtz.a1: float

First coefficient.

Parameters:

valuefloat

New coefficients of the Kettler-Helmholtz equation.

Returns:

float

Finite coefficient.

property MaterialKettlerHelmholtz.a2: float

Second coefficient.

Parameters:

valuefloat

New coefficients of the Kettler-Helmholtz equation.

Returns:

float

Finite coefficient.

property MaterialKettlerHelmholtz.a3: float

Third coefficient.

Parameters:

valuefloat

New coefficients of the Kettler-Helmholtz equation.

Returns:

float

Finite coefficient.

property MaterialKettlerHelmholtz.a4: float

Fourth coefficient.

Parameters:

valuefloat

New coefficients of the Kettler-Helmholtz equation.

Returns:

float

Finite coefficient.

property MaterialKettlerHelmholtz.a5: float

Fifth coefficient.

Parameters:

valuefloat

New coefficients of the Kettler-Helmholtz equation.

Returns:

float

Finite coefficient.

Attribute detail

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

Keyword identifying the model in a *.material file.

Method detail

MaterialKettlerHelmholtz.validate()

Check all coefficients are finite.

Raises:

ValueError

If a coefficient is nonfinite.