Struct WaveSet 

pub(crate) struct WaveSet {
    basis: MultipoleBasis,
    ks: [Complex; 2],
    helicity: bool,
    radial: Radial,
    normalizations: Vec<Complex>,
    radial_table_len: usize,
    harmonic_tables: Vec<Option<SolidTable>>,
    radial_ranges: Vec<Option<(u32, u32)>>,
}

Evaluates the waves of a multipole basis at any point, for one pair of medium wavenumbers, polarization convention and radial kind.

Fields

basis: MultipoleBasis

ks: [Complex; 2]

helicity: bool

radial: Radial

normalizations: Vec<Complex>

Point-independent normalization of each spherical mode; empty for cylinders.

radial_table_len: usize

Scaled radial functions cached per position and wavenumber: the largest spherical degree plus three, or zero for cylinders.

harmonic_tables: Vec<Option<SolidTable>>

Dense harmonic recurrences per (position, wavenumber). Sparse mode sets and interleaved centres use single harmonics instead of repeatedly filling tables.

radial_ranges: Vec<Option<(u32, u32)>>

Degree ranges whose outgoing radial values share one Hankel sequence, selected independently of mode order so column permutations retain the same values.

Implementations

impl WaveSet

fn write_state(&self, writer: &mut Writer)

fn read_state(reader: &mut Reader<'_>) -> Result<Self>

Rebuild only basis-dependent normalization and recurrence plans. Sampling values and derivatives remains the responsibility of the later operation.

pub(crate) fn new( basis: MultipoleBasis, ks: [Complex; 2], helicity: bool, radial: Radial, ) -> Result<Self>

fn of_valid_basis( basis: MultipoleBasis, ks: [Complex; 2], helicity: bool, radial: Radial, ) -> Result<Self>

Self::new for a basis that has passed validate.

pub(crate) fn cache<const N: usize>(&self) -> SampleCache<N>

fn wavenumber(&self, pol: u8) -> usize

Index of the wavenumber of polarization pol; equal wavenumbers share one.

pub(crate) fn wave<const N: usize>( &self, i: usize, point: [f64; 3], cache: &mut SampleCache<N>, ) -> Result<(VectorWave, [Complex; 3])>

Wave i at point and, for cylindrical waves at level WITH_AXIAL, its axial-wavenumber derivative. Derivatives are evaluated only above VALUES.

fn cached_parts<const N: usize>( &self, pidx: usize, wavenumber: usize, mode: Mode, point: [f64; 3], cache: &mut SampleCache<N>, ) -> Result<[VectorWave; 2]>

The spherical parts of mode at point from the cached radial functions and a scaled solid harmonic. It rejects what spherical_wave rejects: a wavenumber whose square underflows and a relative position that overflows.

fn sampled_operator<const N: usize>( &self, points: &[[f64; 3]], value: impl Fn(usize, usize, VectorWave, [Complex; 3]) -> [Complex; 3] + Sync, ) -> Result<DMatrix<Complex>>

Sample an operator with shared radial and harmonic work per point. Both the primal and its pushforward write directly into column-major storage.

fn pullback<const N: usize>( &self, points: &[[f64; 3]], coefficients: Option<&[Complex]>, cotangent: impl Fn(usize, usize) -> [Complex; 3] + Sync, ) -> Result<(FieldGradient, Vec<f64>)>

The pullback over all points; level WITH_AXIAL adds per-mode axial gradients.

Trait Implementations

impl Debug for WaveSet

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

Formats the value using the given formatter.