MaterialBirefringentCurve

class ansys.speos.core.input_files.material.MaterialBirefringentCurve(wavelength=550.0, index_a=1.5, index_b=1.51, index_c=1.65, optical_class=MaterialOpticalClass.negative_uniaxial)

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

Refractive indices of a birefringent material along its three axes.

Speos does not make the indices of a birefringent material vary with the wavelength when they are given explicitly, so a single index per axis is stored.

Parameters:

wavelengthfloat, optional

Wavelength the indices are given at, in nm. By default, 550.0.

index_afloat, optional

Refractive index along the a axis. By default, 1.5.

index_bfloat, optional

Refractive index along the b axis. By default, 1.51.

index_cfloat, optional

Refractive index along the c axis. By default, 1.65.

optical_classMaterialOpticalClass, optional

Optical class. By default, MaterialOpticalClass.negative_uniaxial.

Parameters:

• wavelength (float)

• index_a (float)

• index_b (float)

• index_c (float)

• optical_class (MaterialOpticalClass)

Overview

Methods

validate

Check finite indices and the optical class.

Properties

wavelength	Wavelength of the indices, in nm.
index_a	Refractive index along the a axis.
index_b	Refractive index along the b axis.
index_c	Refractive index along the c axis.
optical_class	Optical class of the material.

Attributes

KEYWORD

Keyword identifying the model in a *.material file.

Import detail

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

Property detail

property MaterialBirefringentCurve.wavelength: float

Wavelength of the indices, in nm.

Parameters:

valuefloat

New wavelength the indices are given at, in nm.

Returns:

float

Finite wavelength.

property MaterialBirefringentCurve.index_a: float

Refractive index along the a axis.

Parameters:

valuefloat

New refractive index along the a axis.

Returns:

float

Finite index.

property MaterialBirefringentCurve.index_b: float

Refractive index along the b axis.

Parameters:

valuefloat

New refractive index along the b axis.

Returns:

float

Finite index.

property MaterialBirefringentCurve.index_c: float

Refractive index along the c axis.

Parameters:

valuefloat

New refractive index along the c axis.

Returns:

float

Finite index.

property MaterialBirefringentCurve.optical_class: MaterialOpticalClass

Optical class of the material.

Parameters:

valueMaterialOpticalClass

New optical class.

Returns:

MaterialOpticalClass

Negative uniaxial, positive uniaxial, or biaxial.

Attribute detail

MaterialBirefringentCurve.KEYWORD: ClassVar[str] = 'Dispersion_Curve'

Keyword identifying the model in a *.material file.

Method detail

MaterialBirefringentCurve.validate()

Check finite indices and the optical class.

Raises:

ValueError

If a numeric value or optical class is invalid.