OGS 6.2.1-76-gbb689931b
MathLib::ODE::detail::FunctionHandles Class Referenceabstract

Detailed Description

Interface providing acces to functions computing $\dot y$ and its Jacobian to code interfacing with external ODE solver libraries.

Note
The methods of this class accept raw pointers as arguments, not Eigen::Matrix types.

Definition at line 30 of file FunctionHandles.h.

#include <FunctionHandles.h>

Inheritance diagram for MathLib::ODE::detail::FunctionHandles:

Public Member Functions

virtual bool call (const double t, double const *const y, double *const ydot)=0
 
virtual bool callJacobian (const double t, double const *const y, double *const ydot, double *const jac)=0
 
virtual bool hasJacobian () const =0
 Tells whether a Jacobian function has been set. More...
 
virtual unsigned getNumberOfEquations () const =0
 Returns the number of equations in the ODE system. More...
 
virtual ~FunctionHandles ()=default
 

Constructor & Destructor Documentation

◆ ~FunctionHandles()

virtual MathLib::ODE::detail::FunctionHandles::~FunctionHandles ( )
virtualdefault

Member Function Documentation

◆ call()

virtual bool MathLib::ODE::detail::FunctionHandles::call ( const double  t,
double const *const  y,
double *const  ydot 
)
pure virtual

Calls a function computing $\dot y$.

Returns
true or false indicating whether the function succeeded.

Implemented in MathLib::ODE::detail::FunctionHandlesImpl< N >.

◆ callJacobian()

virtual bool MathLib::ODE::detail::FunctionHandles::callJacobian ( const double  t,
double const *const  y,
double *const  ydot,
double *const  jac 
)
pure virtual

Calls a function computing $\mathtt{jac} := \partial \dot y/\partial //! y$.

Returns
true or false indicating whether the function succeeded.

Implemented in MathLib::ODE::detail::FunctionHandlesImpl< N >.

Referenced by MathLib::ODE::CVodeSolverImpl::preSolve().

◆ getNumberOfEquations()

virtual unsigned MathLib::ODE::detail::FunctionHandles::getNumberOfEquations ( ) const
pure virtual

Returns the number of equations in the ODE system.

Implemented in MathLib::ODE::detail::FunctionHandlesImpl< N >.

◆ hasJacobian()

virtual bool MathLib::ODE::detail::FunctionHandles::hasJacobian ( ) const
pure virtual

Tells whether a Jacobian function has been set.

Implemented in MathLib::ODE::detail::FunctionHandlesImpl< N >.


The documentation for this class was generated from the following file: