Struct diffsol::op::unit::UnitCallable

pub struct UnitCallable<M: Matrix> { /* private fields */ }

A dummy operator that returns the input vector. Can be used either as a NonLinearOp or LinearOp.

Implementations

impl<M: Matrix> UnitCallable<M>

pub fn new(n: usize) -> Self

Trait Implementations

impl<M: Matrix> Default for UnitCallable<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: Matrix> LinearOp for UnitCallable<M>

fn gemv_inplace(&self, x: &Self::V, _t: Self::T, beta: Self::T, y: &mut Self::V)

Computer the operator via a GEMV operation (i.e. y = t * A * x + beta * y)

fn call_inplace(&self, x: &Self::V, t: Self::T, y: &mut Self::V)

Compute the operator at a given state and time

fn matrix(&self, t: Self::T) -> Self::M

Compute the matrix representation of the operator and return it.

fn matrix_inplace(&self, t: Self::T, y: &mut Self::M)

Compute the matrix representation of the operator and store it in the matrix y.

fn _default_matrix_inplace(&self, t: Self::T, y: &mut Self::M)

Default implementation of the matrix computation.

impl<M: Matrix> NonLinearOp for UnitCallable<M>

fn call_inplace(&self, x: &Self::V, _t: Self::T, y: &mut Self::V)

Compute the operator at a given state and time.

fn jac_mul_inplace( &self, _x: &Self::V, _t: Self::T, v: &Self::V, y: &mut Self::V )

Compute the product of the Jacobian with a given vector.

fn call(&self, x: &Self::V, t: Self::T) -> Self::V

Compute the operator at a given state and time, and return the result.

fn jac_mul(&self, x: &Self::V, t: Self::T, v: &Self::V) -> Self::V

Compute the product of the Jacobian with a given vector, and return the result.

fn jacobian_inplace(&self, x: &Self::V, t: Self::T, y: &mut Self::M)

Compute the Jacobian of the operator and store it in the matrix y. y should have been previously initialised using the output of Op::sparsity.

fn _default_jacobian_inplace(&self, x: &Self::V, t: Self::T, y: &mut Self::M)

Default implementation of the Jacobian computation.

fn jacobian(&self, x: &Self::V, t: Self::T) -> Self::M

Compute the Jacobian of the operator and return it.

impl<M: Matrix> Op for UnitCallable<M>

type T = <M as MatrixCommon>::T

type V = <M as MatrixCommon>::V

type M = M

fn nstates(&self) -> usize

Return the number of input states of the operator.

fn nout(&self) -> usize

Return the number of outputs of the operator.

fn nparams(&self) -> usize

Return the number of parameters of the operator.

fn set_params(&mut self, p: Rc<Self::V>)

Set the parameters of the operator to the given value.

fn sparsity(&self) -> Option<&<Self::M as Matrix>::Sparsity>

Return sparsity information for the jacobian or matrix (if available)

fn statistics(&self) -> OpStatistics

Return statistics about the operator (e.g. how many times it was called, how many times the jacobian was computed, etc.)