Cantera  3.1.0a1
Loading...
Searching...
No Matches
ODE and DAE Function Utilities

Detailed Description

Classes

class  FuncEval
 Virtual base class for ODE/DAE right-hand-side function evaluators. More...
 
class  Integrator
 Abstract base class for ODE system integrators. More...
 

Functions

static int cvodes_rhs (sunrealtype t, N_Vector y, N_Vector ydot, void *f_data)
 Function called by cvodes to evaluate ydot given y.
 
IntegratornewIntegrator (const string &itype)
 Create new Integrator object.
 

Function Documentation

◆ cvodes_rhs()

static int cvodes_rhs ( sunrealtype  t,
N_Vector  y,
N_Vector  ydot,
void *  f_data 
)
static

Function called by cvodes to evaluate ydot given y.

The CVODE integrator allows passing in a void* pointer to access external data. This pointer is cast to a pointer to a instance of class FuncEval. The equations to be integrated should be specified by deriving a class from FuncEval that evaluates the desired equations.

Definition at line 39 of file CVodesIntegrator.cpp.

◆ newIntegrator()

Integrator * newIntegrator ( const string &  itype)

Create new Integrator object.

Parameters
itypeIntegration mode; either CVODE or IDA

Definition at line 14 of file Integrators.cpp.