StructureAni¶

class modesolverpy.structure_base.StructureAni(structure_xx, structure_yy, structure_zz, structure_xy=None, structure_yx=None)[source]¶

Bases: object

Anisottropic structure object.

This is used with the fully-vectorial simulation when an anisotropic material is being used.

The form of the refractive index is

\[\begin{split}n = \begin{bmatrix} n_{xx} & n_{xy} & 0 \\ n_{yx} & n_{yy} & 0 \\ 0 & 0 & n_{zz} \end{bmatrix}.\end{split}\]

Parameters:

structure_xx (Structure) – The structure with refractive index, \(n_{xx}\).
structure_yy (Structure) – The structure with refractive index, \(n_{yy}\). Presumably the same structure as structure_xx, but with different refractive index parameters.
structure_zz (Structure) – The structure with refractive index, \(n_{zz}\). Presumably the same structure as structure_xx, but with different refractive index parameters.
structure_xy (None, Structure) – The structure with refractive index, \(n_{yx}\). Presumably the same structure as structure_xx, but with different refractive index parameters. Default is None.
structure_yx (None, Structure) – The structure with refractive index, \(n_{yx}\). Presumably the same structure as structure_xx, but with different refractive index parameters. Default is None.

Attributes Summary

`eps`
`eps_func`
`n`
`n_func`
`x`
`x_ctr`
`x_pts`
`x_step`
`xc`
`xc_max`
`xc_min`
`xc_pts`
`y`
`y_ctr`
`y_pts`
`y_step`
`yc`
`yc_max`
`yc_min`
`yc_pts`

Methods Summary

`change_wavelength`(wavelength)	Changes the wavelength of the structure.
`write_to_file`([filename, plot])	Write the refractive index profile to file.

Attributes Documentation

eps¶

eps_func¶

n¶

n_func¶

x¶

x_ctr¶

x_pts¶

x_step¶

xc¶

xc_max¶

xc_min¶

xc_pts¶

y¶

y_ctr¶

y_pts¶

y_step¶

yc¶

yc_max¶

yc_min¶

yc_pts¶

Methods Documentation

change_wavelength(wavelength)[source]¶

Changes the wavelength of the structure.

This will affect the mode solver and potentially the refractive indices used (provided functions were provided as refractive indices).

Parameters:	wavelength (float) – The new wavelength.

write_to_file(filename='material_index.dat', plot=True)[source]¶

Write the refractive index profile to file.

Parameters:	filename (str) – The nominal filename the refractive index data should be saved to. plot (bool) – True if plots should be generates, otherwise False. Default is True.