diffsol::ode_solver::diffsl

Struct DiffSlContext

source
pub struct DiffSlContext<M: Matrix<T = T>, CG: CodegenModule> { /* private fields */ }
Expand description

Context for the ODE equations specified using the DiffSL language.

This contains the compiled code and the data structures needed to evaluate the ODE equations. Note that the example below uses the LLVM backend (requires one of the diffsl-llvm features), but the Cranelift backend can also be used using diffsl::CraneliftModule instead of diffsl::LlvmModule (requires diffsl-cranelift feature).

§Example

use diffsol::{OdeBuilder, Bdf, OdeSolverState, OdeSolverMethod, DiffSlContext, diffsl::LlvmModule};
         
// dy/dt = -ay
// y(0) = 1
let context = DiffSlContext::<nalgebra::DMatrix<f64>, LlvmModule>::new("
    in = [a]
    a { 1 }
    u { 1.0 }
    F { -a*u }
    out { u }
").unwrap();
let problem = OdeBuilder::new()
 .rtol(1e-6)
 .p([0.1])
 .build_diffsl(&context).unwrap();
let mut solver = Bdf::default();
let t = 0.4;
let state = OdeSolverState::new(&problem, &solver).unwrap();
solver.set_problem(state, &problem);
while solver.state().unwrap().t <= t {
   solver.step().unwrap();
}
let y = solver.interpolate(t);

Implementations§

source§

impl<M: Matrix<T = T>, CG: CodegenModule> DiffSlContext<M, CG>

source

pub fn new(text: &str) -> Result<Self, DiffsolError>

Create a new context for the ODE equations specified using the DiffSL language. The input parameters are not initialized and must be set using the OdeEquations::set_params function before solving the ODE.

source

pub fn recompile(&mut self, text: &str) -> Result<(), DiffsolError>

Trait Implementations§

source§

impl<M: Matrix<T = T>, CG: CodegenModule> Default for DiffSlContext<M, CG>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<M, CG> !Freeze for DiffSlContext<M, CG>

§

impl<M, CG> !RefUnwindSafe for DiffSlContext<M, CG>

§

impl<M, CG> Send for DiffSlContext<M, CG>
where CG: Send, <M as MatrixCommon>::V: Send,

§

impl<M, CG> !Sync for DiffSlContext<M, CG>

§

impl<M, CG> Unpin for DiffSlContext<M, CG>
where CG: Unpin, <M as MatrixCommon>::V: Unpin,

§

impl<M, CG> UnwindSafe for DiffSlContext<M, CG>
where CG: UnwindSafe, <M as MatrixCommon>::V: 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> 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 = 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.