SphereClusterResidual

Struct SphereClusterResidual 

Source
pub struct SphereClusterResidual {
    k0: f64,
    positions: Vec<[f64; 3]>,
    plan: TranslationPlan,
    spheres: Vec<SphereResidual>,
    interaction: InteractionResidual,
}
Expand description

What sphere_cluster saves for its pullback: the Mie residual of each sphere, the translation plan between two spheres, the positions and the interaction solve.

Fields§

§k0: f64§positions: Vec<[f64; 3]>§plan: TranslationPlan§spheres: Vec<SphereResidual>§interaction: InteractionResidual

Implementations§

Source§

impl SphereClusterResidual

Source

pub fn state_size(lmax: usize, particles: usize) -> Result<usize>

Byte count for a cluster’s saved numerical state, from its static layout.

Source

pub fn particles(&self) -> usize

Number of spheres in the recorded cluster.

Source

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

Interacting T-matrix in the local multipole bases.

Source

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

The shape of the interacting T-matrix.

Source

pub fn pushforward( &self, k0: f64, radii: &[f64], epsilon: &[Complex], positions: &[[f64; 3]], ) -> Result<DMatrix<Complex>>

Directional derivative for vacuum wavenumber, radii, permittivities and positions. Particle and translation tangents feed one solve with the saved LU.

Source

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

Gradients of k0, the radii, the permittivities and the positions from cotangent, the gradient of a real loss with respect to the interacting T-matrix.

The spheres run in parallel; their gradients add in sphere order, so the Rayon pool does not change them. The LU solve and the matrix products of InteractionResidual::pullback_blocks run in faer with the worker count of linalg.

Trait Implementations§

Source§

impl Clone for SphereClusterResidual

Source§

fn clone(&self) -> SphereClusterResidual

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SphereClusterResidual

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SavedState for SphereClusterResidual

Source§

fn save_state(&self) -> Result<Vec<u8>>

Copy the saved numerical state into its fixed byte layout.
Source§

fn from_state(bytes: &[u8]) -> Result<Self>

Restore numerical state from bytes produced by this extension.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,