API reference#
This section is under construction.
- class remsol.BackEnd#
Enum for schosing the back end of the simulation.
- Scattering = BackEnd.Scattering#
- Transfer = BackEnd.Transfer#
- class remsol.BoundaryCondition#
Enum for choosing the boundary condition at the edges of the multilayer stack.
- PEC = BoundaryCondition.PEC#
- SemiInfinite = BoundaryCondition.SemiInfinite#
- class remsol.IndexData#
Struct representing the index data of the multi-layer. This is also available in the Python API.
- n#
The index of refraction of the multi-layer.
- x#
The x values of the index data.
- class remsol.Layer(n, d)#
Struct representing a layer in the stack. This class is also available in the Python API.
- class remsol.MultiLayer(layers)#
Structs repressenting the multilayer structure. Implements methods for calculating the modes and fields of the structure. This is also available in the Python API.
- all_neff(omega, polarization=None)#
Returns all effective indices supported by the structure. # Arguments * omega - The angular frequency. * polarization - The polarization of the modes. # Returns A list of effective indices, sorted from highest to lowest.
- field(omega, polarization=None, mode=None)#
Calculates the field profile of the requested mode. # Arguments * omega - The angular frequency of the mode. * polarization - The polarization of the mode. * mode - The mode number. # Returns The field profile of the mode, or a zeroed FieldData if the mode does not exist.
- index()#
Returs the index profile of the multi-layer.
- neff(omega, polarization=None, mode=None)#
Calculates neff of the requested mode. # Arguments * omega - The angular frequency of the mode. * polarization - The polarization of the mode. * mode - The mode number. # Returns The effective index of refraction of the mode, or None if the mode does not exist.
- plot_step#
The step size for plotting the field.
- set_left_boundary(bc)#
Sets the left boundary condition of the structure.
- set_right_boundary(bc)#
Sets the right boundary condition of the structure.
- class remsol.PEC#
Boundary marker struct representing a Perfect Electric Conductor (PEC). Place as the first or last element of a MultiLayer list to apply a PEC boundary condition.