Struct VectorWaveResidual 

pub struct VectorWaveResidual {
    family: Family,
    labels: Vec<WaveLabel>,
    arguments: [Vec<Complex>; 6],
    helicity: bool,
    size: usize,
}

What vector_wave_array saves for its pullback: the family, the labels, the convention and the arguments, each one value for all outputs or one per output.

The pullback computes each output’s gradients on its own and adds the gradients of a scalar argument in output order on the calling thread, so its result does not depend on the thread count.

Fields

family: Family

labels: Vec<WaveLabel>

arguments: [Vec<Complex>; 6]

helicity: bool

size: usize

Implementations

impl VectorWaveResidual

pub fn new( family: Family, labels: Vec<WaveLabel>, arguments: [Vec<Complex>; 6], helicity: bool, ) -> Result<Self>

Retain broadcast inputs without evaluating the waves.

pub fn values(&self) -> Result<Vec<[Complex; 3]>>

Evaluate the values of the retained wave inputs.

impl VectorWaveResidual

fn element(&self, i: usize) -> (WaveLabel, [Complex; 6])

fn fixed_plane(&self) -> Option<(WaveLabel, [Complex; 3])>

The label and wave vector that several plane waves share, and hence their one polarization, when they differ only in their points.

fn point(&self, i: usize) -> [Complex; 3]

The point (x, y, z) of plane wave i.

pub fn pushforward( &self, tangents: [&[Complex]; 6], ) -> Result<Vec<[Complex; 3]>>

Directional derivative of every wave from scalar or elementwise argument tangents. It carries one direction, irrespective of the number of arguments.

pub fn pullback(&self, cotangent: &[[Complex; 3]]) -> Result<[Vec<Complex>; 6]>

The gradients of the six arguments from one complex vector cotangent per output; an argument given as one value for all outputs gets the sum of its gradients.

Trait Implementations

impl Debug for VectorWaveResidual

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

Formats the value using the given formatter.