Struct LatticeExpansionResidual 

pub struct LatticeExpansionResidual {
    destination: Basis,
    source: Basis,
    ks: [Complex; 2],
    lattice: BlochLattice,
    eta: Complex,
    couplings: Couplings,
}

What lattice_expansion saves for its pullback: the bases, the wavenumbers, the lattice, the split and the distinct couplings.

Equal axial wavenumbers select the coupled entries, and the pullback holds that selection fixed.

The pullback evaluates the lattice-sum gradients in parallel and adds them in request order, so its result does not depend on the thread count.

Fields

destination: Basis

source: Basis

ks: [Complex; 2]

lattice: BlochLattice

eta: Complex

couplings: Couplings

Implementations

impl LatticeExpansionResidual

pub fn state_size( destination_modes: usize, destination_positions: usize, source_modes: usize, source_positions: usize, ) -> Result<usize>

Fixed byte count from the destination and source basis shapes.

impl LatticeExpansionResidual

pub fn pushforward( &self, destination: &[[f64; 3]], source: &[[f64; 3]], ks: [Complex; 2], kpar: &[f64], vectors: &DMatrix<f64>, ) -> Result<DMatrix<Complex>>

Directional derivative in positions, medium wavenumbers and lattice geometry.

pub fn pushforward_axial( &self, destination: &[[f64; 3]], source: &[[f64; 3]], ks: [Complex; 2], kpar: &[f64], vectors: &DMatrix<f64>, axial: &[f64], ) -> Result<DMatrix<Complex>>

Also vary the sorted distinct shared axial wavenumbers, holding matching mode groups fixed.

fn pushforward_impl( &self, destination: &[[f64; 3]], source: &[[f64; 3]], ks: [Complex; 2], kpar: &[f64], vectors: &DMatrix<f64>, axial: Option<&[f64]>, ) -> Result<DMatrix<Complex>>

pub fn shape(&self) -> (usize, usize)

Destination and source mode counts: the shape of the coupling matrix.

fn geometry(&self, key: CouplingKey) -> (Complex, Complex, [f64; 3], Complex)

The wavenumber, the transverse wavenumber, the source-to-destination displacement r and the axial phase exp(-i kz r_z) of a request.

pub fn pullback( &self, cotangent: &DMatrix<Complex>, ) -> Result<LatticeExpansionGradient>

Differentiate positions, medium wavenumbers and lattice geometry.

pub fn pullback_axial( &self, cotangent: &DMatrix<Complex>, ) -> Result<(LatticeExpansionGradient, Vec<f64>)>

Also differentiate sorted distinct axial wavenumbers with matching groups fixed.

fn pullback_impl<const AXIAL: bool>( &self, cotangent: &DMatrix<Complex>, ) -> Result<(LatticeExpansionGradient, Vec<f64>)>

Trait Implementations

impl Debug for LatticeExpansionResidual

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SavedState for LatticeExpansionResidual

fn save_state(&self) -> Result<Vec<u8>>

Copy the saved numerical state into its fixed byte layout.

fn from_state(bytes: &[u8]) -> Result<Self>

Restore numerical state from bytes produced by this extension.