Skip to main content

IterativeSystem

Struct IterativeSystem 

Source
pub struct IterativeSystem { /* private fields */ }
Expand description

The assembled, frequency-independent, matrix-free mesh system of a geometry and its ports. See the module documentation.

Implementations§

Source§

impl IterativeSystem

Source

pub fn assemble( geometry: &Geometry, ports: &[Port], discretization: &Discretization, params: &IterativeParams, ) -> Result<Self, SolveError>

Discretizes geometry, builds the loop basis for ports and the pFFT operator of the filaments, and precomputes the port columns and the preconditioner.

§Errors

As MeshSystem::assemble, plus SolveError::Pfft if the operator cannot be built from params.pfft.

Source

pub fn ports(&self) -> &[Port]

The ports, in the order of the rows and columns of Z.

Source

pub fn filaments(&self) -> &[Filament]

Every filament (branch), segment by segment.

Source

pub fn mesh(&self) -> &MeshMatrix

The loop basis.

Source

pub fn counts(&self) -> Counts

Problem size: nodes, segments, filaments, meshes, ports.

Source

pub fn operator_stats(&self) -> PfftStats

Sizes of the pFFT operator.

Source

pub fn gmres_params(&self) -> GmresParams

The GMRES parameters every solve uses.

Source

pub fn impedance( &self, frequency: f64, ) -> Result<DMatrix<Complex<f64>>, SolveError>

The port impedance matrix Z(ω), in ohms, at frequency hertz; the iterative counterpart of MeshSystem::impedance.

§Errors

SolveError::InvalidFrequency for a negative or non-finite frequency (reported with index 0), SolveError::NotConverged if a GMRES solve misses its tolerance, SolveError::Singular if the result is not finite.

Source

pub fn solve(&self, frequency: f64) -> Result<IterativeSolution, SolveError>

As impedance, also returning how every port’s GMRES solve went.

§Errors

As impedance.

Source

pub fn sweep(&self, frequencies: &[f64]) -> Result<SweepResult, SolveError>

Z(ω) at every one of frequencies (hertz), with provenance; the iterative counterpart of MeshSystem::sweep.

Frequencies are solved concurrently, as many at a time as fit a fixed memory budget; each is an independent deterministic computation, so the result does not depend on the number of threads. Provenance::timing.inductance_s reports the time spent building the pFFT operator.

§Errors

As impedance; the first failing frequency in list order is reported.

Trait Implementations§

Source§

impl Debug for IterativeSystem

Source§

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

Formats the value using the given formatter. Read more

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
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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.