Struct IterativeResidual 

pub struct IterativeResidual {
    operator: Arc<IterativeSphereCluster>,
    incident: DMatrix<Complex>,
    options: GmresOptions,
    solution: IterativeSolution,
}

What IterativeSphereCluster::record saves for its pullback: the shared cluster, the incident fields, the GMRES options and the solution.

Fields

operator: Arc<IterativeSphereCluster>

incident: DMatrix<Complex>

options: GmresOptions

solution: IterativeSolution

Implementations

impl IterativeResidual

pub fn state_size(lmax: u32, particles: usize, columns: usize) -> Result<usize>

Callback-state bytes for an illumination with these static dimensions. The layout keeps geometry, Mie residuals, solver options, incident and scattered columns, and the primal convergence certificates.

impl IterativeResidual

pub const fn solution(&self) -> &IterativeSolution

The forward solution and its convergence certificates; the pullback reads the solution.

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

The shape of the solution: local multipoles and incident columns.

pub fn particles(&self) -> usize

Number of particles, for binding-level tangent validation.

fn response(&self) -> Result<DMatrix<Complex>>

The exciting field B + C X, shared by both derivative directions. Reuse the coupling action’s output allocation without copying saved incident data.

pub fn pushforward( &self, k0: f64, radii: &[f64], epsilon: &[Complex], positions: &[[f64; 3]], incident: &DMatrix<Complex>, ) -> Result<IterativeSolution>

Differentiate the converged equation, retaining the matrix-free operator: (I - T C) dX = dT (B + C X) + T (dB + dC X).

Tangent and adjoint solves use relative-only convergence: the primal rtol, or the default 1e-10 if it was zero. The primal atol applies only to the primal solve, so small directions retain their relative accuracy. Restart and iteration limits are unchanged, and each solve returns an independent residual certificate. No Krylov history is retained or differentiated.

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

Gradients of the cluster and the incident fields from cotangent, the gradient of a real loss with respect to the solution.

One adjoint GMRES solve per column gives Y = (I - T C)⁻ᴴ G; each particle pair then contributes to the position and k0 gradients. Those contributions add in chunks of particles fixed by the particle count, and the chunk sums in chunk order; the radius and permittivity gradients add in particle order. The thread count changes none of the gradients. Convergence follows the same relative-only policy as Self::pushforward.

Trait Implementations

impl Debug for IterativeResidual

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

Formats the value using the given formatter.

impl SavedState for IterativeResidual

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.