Struct FieldResidual 

pub struct FieldResidual {
    waves: WaveSet,
    points: Vec<[f64; 3]>,
    coefficients: Vec<Complex>,
}

What field saves for its pullback: the wave set, the points and the coefficients. Its size grows with the samples plus the modes, not their product.

Fields

waves: WaveSet

points: Vec<[f64; 3]>

coefficients: Vec<Complex>

Implementations

impl FieldResidual

pub fn state_size( modes: usize, positions: usize, points: usize, cylindrical: bool, ) -> Result<usize>

Saved-state byte count determined solely by the input dimensions and wave family, independent of material values or derivative directions.

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

Samples and Cartesian components: the shape of the field array.

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

Number of mode coefficients and expansion centres in the input.

pub fn pushforward( &self, coefficients: &[Complex], points: &[[f64; 3]], positions: &[[f64; 3]], ks: [Complex; 2], ) -> Result<Vec<[Complex; 3]>>

Field tangent in one direction of coefficients, sample points, expansion centres and medium wavenumbers. Each sample reuses the primal wave caches.

pub fn pushforward_axial( &self, coefficients: &[Complex], points: &[[f64; 3]], positions: &[[f64; 3]], ks: [Complex; 2], kz: &[f64], ) -> Result<Vec<[Complex; 3]>>

Self::pushforward with an axial-wavenumber tangent per cylindrical mode.

fn pushforward_impl<const N: usize>( &self, coefficients: &[Complex], tangent: GeometryTangent<'_>, ) -> Result<Vec<[Complex; 3]>>

pub fn pullback(&self, cotangent: &[[Complex; 3]]) -> Result<FieldGradient>

Input gradients from cotangent, the gradient of a real loss with respect to the field, one Cartesian vector per sample. The waves are evaluated again per sample; no dense Jacobian is stored.

Each point gradient comes from its own sample only. The coefficient, position and wavenumber gradients add in chunks of consecutive samples fixed by the sample count, and the chunk sums in chunk order (numerics::parallel::try_fold_ordered), so the thread count does not change them.

pub fn pullback_axial( &self, cotangent: &[[Complex; 3]], ) -> Result<(FieldGradient, Vec<f64>)>

Self::pullback plus a real axial-wavenumber gradient for each mode of a cylindrical basis; the axial gradients add their chunk sums the same way.

fn pullback_impl<const N: usize>( &self, cotangent: &[[Complex; 3]], ) -> Result<(FieldGradient, Vec<f64>)>

Trait Implementations

impl Debug for FieldResidual

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

Formats the value using the given formatter.

impl SavedState for FieldResidual

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.