Struct BandsResidual 

pub struct BandsResidual {
    periodic: PeriodicResidual,
    eigen: EigResidual,
    period: f64,
    wavenumbers: Vec<Complex>,
}

What bands saves for its pullback: the residuals of the transfer matrix and of its eigensystem, the period and the Bloch wavenumbers.

Fields

periodic: PeriodicResidual

eigen: EigResidual

period: f64

wavenumbers: Vec<Complex>

Implementations

impl BandsResidual

pub fn state_size(n: usize) -> Result<usize>

Byte count for saved Bloch bands with n modes per propagation direction.

impl BandsResidual

pub fn wavenumbers(&self) -> &[Complex]

Normal Bloch wavenumbers from the principal complex logarithm, which the pullback reads.

pub const fn vectors(&self) -> &DMatrix<Complex>

Unit right Bloch eigenvectors, with the largest component real positive.

pub fn pushforward( &self, blocks: &Blocks, period: f64, ) -> Result<(Vec<Complex>, DMatrix<Complex>)>

Bloch wavenumber and eigenvector tangents with a fixed logarithm branch. The recorded eigensystem defines the normalization and phase convention.

pub fn pullback( &self, wavenumbers: &[Complex], vectors: DMatrix<Complex>, ) -> Result<BandsGradient>

Return S-matrix and repeat-distance cotangents; logarithm branch is fixed.

Trait Implementations

impl Debug for BandsResidual

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

Formats the value using the given formatter.

impl SavedState for BandsResidual

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.