Struct QmatResidual 

pub struct QmatResidual {
    destination: Vec<Mode>,
    source: Vec<Mode>,
    surface: Surface,
    ks: [[Complex; 2]; 2],
    zs: [Complex; 2],
    radial: Radial,
    radial_area_factor: bool,
}

What qmat saves for its pullback: the modes, the surface and the media, without any wave values; the pullback evaluates the waves again.

Fields

destination: Vec<Mode>

source: Vec<Mode>

surface: Surface

ks: [[Complex; 2]; 2]

zs: [Complex; 2]

radial: Radial

radial_area_factor: bool

Implementations

impl QmatResidual

fn validate(&self) -> Result<()>

pub fn state_size( samples: usize, destinations: usize, sources: usize, ) -> Result<usize>

Bytes in the private callback state for the quadrature and mode counts.

fn wave_sets(&self) -> Result<[WaveSet; 2]>

The inner test waves, whose orders are reversed, and the outer waves.

fn weight(&self, node: usize) -> f64

Integration weight of a node: the quadrature weight, sin(theta) and, with radial_area_factor, the radius.

fn measure(&self, node: usize) -> f64

The quadrature weight times sin(theta), which does not depend on the radius.

fn rows_by_order(&self) -> HashMap<i32, Vec<usize>>

The rows of each azimuthal order; only equal orders couple.

fn factors(&self) -> [[Complex; 2]; 2]

The impedance factor HELICITY[a] z_outer + HELICITY[b] z_inner of each (row helicity a, column helicity b) pair.

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

Matrix shape, for binding-level cotangent validation.

pub fn samples(&self) -> usize

Number of fixed quadrature nodes, for binding-level tangent validation.

pub fn pushforward( &self, radii: &[f64], slopes: &[f64], ks: [[Complex; 2]; 2], zs: [Complex; 2], ) -> Result<DMatrix<Complex>>

Directional derivative with respect to the surface radii and slopes, wavenumbers and impedances. Quadrature nodes and weights stay fixed. Each wave’s local derivatives are contracted once per node, before the matrix entries are assembled, sharing the same cached waves as the pullback.

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

Gradients of the surface radii and slopes, the wavenumbers and the impedances from cotangent, the gradient of a real loss with respect to the matrix. The quadrature nodes and weights stay fixed. The sums run over the nodes in order, so the gradients do not depend on the thread count.

Trait Implementations

impl Debug for QmatResidual

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

Formats the value using the given formatter.

impl SavedState for QmatResidual

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.