Skip to main content

Schedule

Enum Schedule 

Source
pub enum Schedule {
    OneWay,
    Staggered,
    Iterative {
        max_iter: u32,
        tol: f64,
    },
    Multirate,
}
Expand description

How the domains are interleaved.

Variants§

§

OneWay

One pass in declared order, no feedback expected. Unconditionally stable; the only schedule whose domains could safely run concurrently.

§

Staggered

One pass in declared order, with each domain seeing the previous ones’ output from this step and the later ones’ from the last. Cheap, and stable only while the coupling is weak.

§

Iterative

Repeat the pass until every domain’s residual is under tol, or fail.

The cost is max_iter passes; the benefit is stability where a staggered scheme diverges no matter how small the step. Failing to converge is reported as a Violation rather than accepted, because an unconverged coupling that is allowed through is the most expensive kind of wrong answer: it looks like physics.

Fields

§max_iter: u32

Give up after this many sweeps. Reaching it is a Violation, not a result.

§tol: f64

The residual every domain must fall under for the step to be accepted.

§

Multirate

As Schedule::Staggered, but each evolving domain takes as many equal substeps as its own stability limit needs.

Trait Implementations§

Source§

impl Clone for Schedule

Source§

fn clone(&self) -> Schedule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Schedule

Source§

impl Debug for Schedule

Source§

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

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

impl PartialEq for Schedule

Source§

fn eq(&self, other: &Schedule) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Schedule

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> 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> 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.