MaterialDispersionCurve#

class ansys.speos.core.input_files.material.MaterialDispersionCurve(wavelengths=_DEFAULT_WAVELENGTHS, indices=_DEFAULT_INDICES)#

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

Dispersion of a volume material given by an explicit index curve.

Parameters:
wavelengthsSequence[float], optional

Wavelengths of the curve, in nm. By default, [486.0, 532.0, 643.0].

indicesSequence[float], optional

Refractive index at each wavelength. By default, [1.5, 1.5, 1.5].

Parameters:
  • wavelengths (Sequence[float])

  • indices (Sequence[float])

Overview#

validate

Check that the curve is complete and its columns match.

wavelengths

Curve wavelengths in nm, returned as a copy.

indices

Refractive index column, returned as a copy.

KEYWORD

Keyword identifying the model in a *.material file.

Import detail#

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

Property detail#

property MaterialDispersionCurve.wavelengths: List[float]#

Curve wavelengths in nm, returned as a copy.

Parameters:
valuesSequence[float]

New wavelengths of the curve, in nm.

Returns:
List[float]

Finite wavelengths.

property MaterialDispersionCurve.indices: List[float]#

Refractive index column, returned as a copy.

Parameters:
valuesSequence[float]

New refractive index at each wavelength.

Returns:
List[float]

Finite refractive indices.

Attribute detail#

MaterialDispersionCurve.KEYWORD: ClassVar[str] = 'Dispersion_Curve'#

Keyword identifying the model in a *.material file.

Method detail#

MaterialDispersionCurve.validate()#

Check that the curve is complete and its columns match.

Raises:
ValueError

If columns are empty or of unequal length.