Enum Family 

pub enum Family {
    Spherical {
        l: i32,
        m: i32,
    },
    Cylindrical {
        m: i32,
    },
}

The family of a lattice sum: spherical or cylindrical.

Each variant is the scalar outgoing wave the sum adds up. vectorwaves::Family selects vector waves instead; code outside each module names both with their module.

Upstream: the lsumsw* and lsumcw* functions of treams.lattice.

Variants

Spherical

h_l^(1)(kr) Y_lm(theta, phi).

Fields

l: i32

Degree.

m: i32

Order.

Cylindrical

H_m^(1)(kr) exp(i m phi).

Fields

m: i32

Signed order.

Implementations

impl Family

pub(super) fn validate(self, dim: usize) -> Result<()>

Checks the labels, and for cylindrical sums the lattice dimension: spherical sums take 0 <= l <= MAX_DEGREE and |m| <= l, cylindrical sums take |m| <= MAX_DEGREE and dim <= 2.

The bound keeps the Kambe integrals of the sums within the orders that special::MAX_LABEL = 2 MAX_DEGREE + 4 admits: spherical real-space terms and their derivatives take orders 2 l and 2 l + 2, and the reciprocal terms of 1D spherical sums orders down to -(2 l + 3).

pub(super) fn axes(self, dim: usize) -> [usize; 3]

The Cartesian axis of each lattice coordinate: z for 1D spherical sums, and x, y, z in order otherwise (x for 1D cylindrical sums, xy for 2D sums).

Trait Implementations

impl Clone for Family

fn clone(&self) -> Family

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Family

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

Formats the value using the given formatter.

impl Copy for Family