Struct ParticleClusterResidual 

pub struct ParticleClusterResidual {
    expansion: ParticleExpansion,
    interaction: InteractionResidual,
}

What particle_cluster and cylindrical_particle_cluster save for their pullback: the interaction solve, with one local block per particle, and the expansion residual of the coupling.

Fields

expansion: ParticleExpansion

interaction: InteractionResidual

Implementations

impl ParticleClusterResidual

pub fn spherical_state_size(local_sizes: &[usize]) -> Result<usize>

Byte count for a spherical cluster’s state, from its local block sizes.

pub fn cylindrical_state_size(local_sizes: &[usize]) -> Result<usize>

Byte count for a cylindrical cluster’s state, from its local block sizes.

fn section_sizes( local_sizes: &[usize], cylindrical: bool, ) -> Result<(usize, usize)>

pub fn local_shapes(&self) -> impl ExactSizeIterator<Item = (usize, usize)>

Shapes of the recorded particle T-matrices, in particle order.

pub const fn value(&self) -> &DMatrix<Complex>

Interacting response in the particles’ local multipole coordinates.

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

The shape of the interacting response.

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

Directional derivative of the local matrices, particle positions and embedding wavenumbers. Both sides of each translation share the same position tangent; the interaction reuses its forward LU.

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

Gradients of the local matrices, the positions and the wavenumbers from cotangent, the gradient of a real loss with respect to the interacting T-matrix.

The position and wavenumber gradients come from the pullback of sw::ExpansionResidual or cw::ExpansionResidual and add in their order; the LU solve and the matrix products run in faer with the worker count of linalg.

Trait Implementations

impl Debug for ParticleClusterResidual

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

Formats the value using the given formatter.

impl SavedState for ParticleClusterResidual

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.