Module interface

Module interface 

Source
Expand description

Chiral Fresnel and Cartesian planar interfaces, and propagation of up/down reference planes.

Upstream: treams.coeffs.fresnel, treams.SMatrices.interface and treams.SMatrices.propagation.

Modulesยง

saved ๐Ÿ”’
Fixed numeric layouts for interface and propagation derivative state. treams-rs extension.

Structsยง

FresnelGradient
Cotangents of the inputs of fresnel, in the order of its arguments; each array lists the medium on the negative side (below), then the positive side (above).
FresnelResidual
What fresnel saves for its pullback: the wavenumbers, the normal wavenumbers and the impedances. The pullback differentiates the closed forms again instead of keeping a Jacobian.
InterfaceGradient
Cotangents of the inputs of interface, in the order of its arguments; the media are listed negative side (below), then positive side (above).
InterfaceResidual
What interface() saves for its pullback: the media, the transverse wavevector, the axis, the inverse of the tangential-field matching matrix and the blocks.
PropagationGradient
Cotangents of the inputs of propagation, in the order of its arguments.
PropagationResidual
What propagation saves for its pullback: the wavevectors, the displacement and the diagonal phases.

Functionsยง

fresnel
Planar interface from full and normal wavenumbers and impedances, each indexed by medium (negative side, then positive side) and then by polarization.
fresnel_values ๐Ÿ”’
The chiral Fresnel coefficients res[out][in][out pol][in pol], transcribed from upstream treams.coeffs.fresnel with its variable names.
interface
Interface from wavenumbers and impedances, indexed by medium (negative side, then positive side), and the real transverse wavevector q.
interface_blocks ๐Ÿ”’
The four 2-by-2 polarization blocks of a 4-by-4 interface matrix.
interface_boundary ๐Ÿ”’
The tangential-field matching lhs s = rhs of an interface. The columns of lhs are the outgoing waves (up in the positive medium, down in the negative one), those of rhs the incoming waves (up in the negative medium, down in the positive one).
interface_matrix ๐Ÿ”’
Blocks [[b0, b1], [b2, b3]] of 2-by-2 polarization blocks as one 4-by-4 matrix.
normal_component ๐Ÿ”’
The normal wavenumber sqrt(k^2 - q.q) on the branch with a nonnegative imaginary part.
port_boundary ๐Ÿ”’
Tangential fields [E_a, E_b, H_a, H_b] of the plane waves in one medium, indexed by propagation direction (0 = up) and polarization; a and b are the two axes after axis in cyclic order.
propagation
Propagate by a Cartesian displacement, given upgoing wavevectors for every mode.

Type Aliasesยง

BoundaryJets ๐Ÿ”’
One 4-by-4 matrix (lhs or rhs) of the tangential-field matching, as jets.
InterfaceMatrix ๐Ÿ”’
The four 2-by-2 scattering blocks of one interface as a 4-by-4 matrix.