Struct ExpansionResidual 

pub struct ExpansionResidual {
    destination: Basis,
    source: Basis,
    ks: [Complex; 2],
    radial: Radial,
    couplings: Couplings,
}

What expansion saves for its pullback: the bases, the wavenumbers, the radial kind and the distinct couplings.

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

The pullback evaluates the coefficients in parallel and adds their gradients in request order, so its result does not depend on the thread count.

Fields

destination: Basis

source: Basis

ks: [Complex; 2]

radial: Radial

couplings: Couplings

Implementations

impl ExpansionResidual

fn prepare( destination: Basis, source: Basis, ks: [Complex; 2], radial: Radial, ) -> Result<Self>

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

Fixed saved-state bytes for the two basis shapes.

pub(crate) fn write_state(&self, writer: &mut Writer)

Append state for a containing residual without an intermediate buffer.

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

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

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

Directional derivative with fixed axial mode labels.

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

Also perturb the sorted distinct shared axial wavenumbers, holding their equality partitions fixed.

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

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

Position and complex wavenumber gradients. Axial mode labels stay fixed.

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

Also differentiate each shared axial wavenumber. The final array follows the sorted distinct kz values from both bases; equality partitions stay fixed.

fn translation(&self, (i, j): (usize, usize)) -> Result<CartesianTranslation>

The translation coefficient and derivatives of request (i, j).

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

Trait Implementations

impl Debug for ExpansionResidual

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

Formats the value using the given formatter.

impl SavedState for ExpansionResidual

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.