Cantera  2.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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. More...
 
virtual void getInitialConditions (double t0, size_t leny, double *y)=0
 Fill the solution vector with the initial conditions at initial time t0. More...
 
virtual size_t neq ()=0
 Number of equations. More...
 
virtual size_t nparams ()
 Number of sensitivity parameters. More...
 

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 23 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
[in]ttime.
[in]ysolution vector, length neq()
[out]ydotrate of change of solution vector, length neq()
[in]psensitivity parameter vector, length nparams()

Implemented in ReactorNet, and ImplicitSurfChem.

Referenced by cvode_jac(), cvode_rhs(), and Cantera::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 ReactorNet, and ImplicitSurfChem.

Referenced by CVodeInt::initialize(), and CVodesIntegrator::initialize().

virtual size_t neq ( )
pure virtual

Number of equations.

Implemented in ReactorNet, and ImplicitSurfChem.

Referenced by CVodeInt::initialize(), and CVodesIntegrator::initialize().

virtual size_t nparams ( )
inlinevirtual

Number of sensitivity parameters.

Reimplemented in ReactorNet.

Definition at line 48 of file FuncEval.h.

Referenced by CVodesIntegrator::initialize().


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