5c2b5cbde0
Adding a docstring for the class means this class is finally included in the Doxygen-generated documentation.
55 lines
1.2 KiB
C++
55 lines
1.2 KiB
C++
/**
|
|
* @file FuncEval.h
|
|
*/
|
|
|
|
// Copyright 2001 California Institute of Technology
|
|
|
|
#ifndef CT_FUNCEVAL_H
|
|
#define CT_FUNCEVAL_H
|
|
|
|
#include "cantera/base/ct_defs.h"
|
|
|
|
namespace Cantera
|
|
{
|
|
/**
|
|
* Virtual base class for ODE right-hand-side function evaluators.
|
|
* Classes derived from FuncEval evaluate the right-hand-side function
|
|
* \f$ \vec{F}(t,\vec{y})\f$ in
|
|
* \f[
|
|
* \dot{\vec{y}} = \vec{F}(t,\vec{y}).
|
|
* \f]
|
|
* @ingroup odeGroup
|
|
*/
|
|
class FuncEval
|
|
{
|
|
public:
|
|
FuncEval() {}
|
|
virtual ~FuncEval() {}
|
|
|
|
/**
|
|
* Evaluate the right-hand-side function. Called by the integrator.
|
|
* @param[in] t time.
|
|
* @param[in] y solution vector, length neq()
|
|
* @param[out] ydot rate of change of solution vector, length neq()
|
|
* @param[in] p sensitivity parameter vector, length nparams()
|
|
*/
|
|
virtual void eval(double t, double* y, double* ydot, double* p)=0;
|
|
|
|
/**
|
|
* Fill the solution vector with the initial conditions
|
|
* at initial time t0.
|
|
*/
|
|
virtual void getInitialConditions(double t0, size_t leny, double* y)=0;
|
|
|
|
//! Number of equations.
|
|
virtual size_t neq()=0;
|
|
|
|
//! Number of sensitivity parameters.
|
|
virtual size_t nparams() {
|
|
return 0;
|
|
}
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|