Skip to main content

AugmentedSystem

Struct AugmentedSystem 

Source
pub struct AugmentedSystem<S: Scalar, Sys: ParametricOdeSystem<S>> {
    pub system: Sys,
    /* private fields */
}
Expand description

Wraps a ParametricOdeSystem as an OdeSystem over the augmented state z = [y; vec(S)] (column-major sensitivity flattening).

The augmented dimension is N · (1 + N_s). The augmented Jacobian is block_diag(J_y, J_y, …, J_y) (CVODES simultaneous-corrector form).

Fields§

§system: Sys

The underlying parameterised system.

Implementations§

Source§

impl<S: Scalar, Sys: ParametricOdeSystem<S>> AugmentedSystem<S, Sys>

Source

pub fn new(system: Sys) -> Self

Wrap a ParametricOdeSystem into an OdeSystem-shaped augmented system suitable for any crate::Solver.

Source

pub fn augmented_dim(&self) -> usize

Total augmented dimension N · (1 + N_s).

Source

pub fn initial_augmented(&self, y0: &[S]) -> Vec<S>

Build the initial augmented state [y_0; vec(∂y_0/∂p)].

Trait Implementations§

Source§

impl<S: Scalar, Sys: ParametricOdeSystem<S>> OdeSystem<S> for AugmentedSystem<S, Sys>

Source§

fn rhs(&self, t: S, z: &[S], dz: &mut [S])

Augmented RHS: dy/dt = f(t,y,p), dS_{:,k}/dt = J_y · S_{:,k} + J_p_{:,k}.

Source§

fn jacobian(&self, t: S, z: &[S], jac: &mut [S])

Augmented Jacobian, row-major over the full N(1+N_s) × N(1+N_s) block.

Fills the N_s + 1 diagonal blocks with J_y. Off-diagonal blocks (which would carry ∂(J_y · S_{:,k})/∂y second-derivative coupling) are zero — the standard CVODES simultaneous-corrector approximation. Implicit solvers in v1 perform dense LU on the full block; the block-diagonal-aware fast path is a tracked follow-up.

Source§

fn dim(&self) -> usize

Dimension of the system.
Source§

fn is_autonomous(&self) -> bool

Is the system autonomous? (f does not depend on t explicitly)
Source§

fn has_mass_matrix(&self) -> bool

Does this system have a mass matrix?
Source§

fn mass_matrix(&self, mass: &mut [S])

Get the mass matrix M for the DAE: M * y’ = f(t, y) Read more
Source§

fn is_singular_mass(&self) -> bool

Is the mass matrix singular? (i.e., is this a DAE?)
Source§

fn algebraic_indices(&self) -> Vec<usize>

Return indices of algebraic variables (where M[i,i] = 0). Read more

Auto Trait Implementations§

§

impl<S, Sys> !Freeze for AugmentedSystem<S, Sys>

§

impl<S, Sys> !RefUnwindSafe for AugmentedSystem<S, Sys>

§

impl<S, Sys> Send for AugmentedSystem<S, Sys>
where Sys: Send,

§

impl<S, Sys> !Sync for AugmentedSystem<S, Sys>

§

impl<S, Sys> Unpin for AugmentedSystem<S, Sys>
where Sys: Unpin, S: Unpin,

§

impl<S, Sys> UnsafeUnpin for AugmentedSystem<S, Sys>
where Sys: UnsafeUnpin,

§

impl<S, Sys> UnwindSafe for AugmentedSystem<S, Sys>
where Sys: UnwindSafe, S: UnwindSafe,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V