Struct Couplings 

struct Couplings {
    requests: Vec<(CouplingKey, (usize, usize))>,
    entries: Vec<u32>,
}

The distinct coefficients of a cylindrical coupling matrix and the entries they fill. A coefficient depends on the mode pair only through its key, and entries of different axial wavenumbers or polarizations vanish.

Fields

requests: Vec<(CouplingKey, (usize, usize))>

Each key with its first entry (row, column).

entries: Vec<u32>

The request of each coupled entry in the order of for_each_coupled. Residuals keep this until their pullback, so it holds one compact index per entry instead of the entry’s position.

Implementations

impl Couplings

fn new(destination: &Basis, source: &Basis, ks: [Complex; 2]) -> Result<Self>

Equal wavenumbers share one slot.

fn for_each( &self, destination: &Basis, source: &Basis, f: impl FnMut(usize, usize, usize), )

Call f(row, column, request) for each coupled entry.

fn matrix( &self, destination: &Basis, source: &Basis, values: &[Complex], ) -> Result<DMatrix<Complex>>

The matrix whose coupled entries take their request’s value.

fn gather( &self, destination: &Basis, source: &Basis, cotangent: &DMatrix<Complex>, ) -> Vec<[Complex; 2]>

The cotangents of each request, summed over its entries by source polarization.

Trait Implementations

impl Debug for Couplings

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

Formats the value using the given formatter.