Cantera  2.0
Public Member Functions | List of all members
FuncEval Class Referenceabstract

Virtual base class for ODE right-hand-side function evaluators. More...

#include <FuncEval.h>

Inheritance diagram for FuncEval:
[legend]

Public Member Functions

virtual void eval (double t, double *y, double *ydot, double *p)=0
 Evaluate the right-hand-side function.
 
virtual void getInitialConditions (double t0, size_t leny, double *y)=0
 Fill the solution vector with the initial conditions at initial time t0.
 
virtual size_t neq ()=0
 Number of equations.
 
virtual size_t nparams ()
 Number of parameters.
 

Detailed Description

Virtual base class for ODE right-hand-side function evaluators.

Classes derived from FuncEval evaluate the right-hand-side function \( \vec{F}(t,\vec{y})\) in

\[ \dot{\vec{y}} = \vec{F}(t,\vec{y}). \]

Definition at line 26 of file FuncEval.h.

Member Function Documentation

virtual void eval ( double  t,
double *  y,
double *  ydot,
double *  p 
)
pure virtual

Evaluate the right-hand-side function.

Called by the integrator.

Parameters
ttime. (input)
ysolution vector. (input)
ydotrate of change of solution vector. (output)
pparameter vector

Implemented in ImplicitSurfChem.

Referenced by cvode_jac(), cvode_rhs(), and cvodes_rhs().

virtual void getInitialConditions ( double  t0,
size_t  leny,
double *  y 
)
pure virtual

Fill the solution vector with the initial conditions at initial time t0.

Implemented in ImplicitSurfChem.

Referenced by CVodeInt::initialize().

virtual size_t neq ( )
pure virtual

Number of equations.

Implemented in ImplicitSurfChem.

Referenced by CVodeInt::initialize().

virtual size_t nparams ( )
inlinevirtual

Number of parameters.

Definition at line 56 of file FuncEval.h.


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