CVODES Forward Sensitivity: dx(t)/dp
[CVODES ODE Solver: x(t)]

Collaboration diagram for CVODES Forward Sensitivity: dx(t)/dp:

This module contains the functions that set up and call SUNDIALS CVODES forward sensitivity analysis routines. More...

Functions
void	fS (int Ns, realtype t, N_Vector y, N_Vector ydot, int iS, N_Vector yS, N_Vector ySdot, void *fS_data, N_Vector tmp1, N_Vector tmp2)
	fS routine: Called by CVODES to compute the sensitivity RHS for one parameter.
int	IntegratorInstance_getForwardSens (integratorInstance_t *engine)
	Calls CVODES to provide forward sensitivities after a call to cvodeOneStep.
int	IntegratorInstance_createCVODESSolverStructures (integratorInstance_t *engine)
SBML_ODESOLVER_API void	IntegratorInstance_printCVODESStatistics (integratorInstance_t *engine, FILE *f)
	Prints some final statistics of the calls to CVODES forward sensitivity analysis routines.

---

Detailed Description

This module contains the functions that set up and call SUNDIALS CVODES forward sensitivity analysis routines.

---

Function Documentation

void fS (  int  Ns, realtype  t, N_Vector  y, N_Vector  ydot, int  iS, N_Vector  yS, N_Vector  ySdot, void *  fS_data, N_Vector  tmp1, N_Vector  tmp2 )

fS routine: Called by CVODES to compute the sensitivity RHS for one parameter. CVODES sensitivity analysis calls this function any time required, with current values for variables x, time t and sensitivities s. The function evaluates df/dx*s + df/dp for one p and writes the results back to CVODE's N_Vector(ySdot) vector. The function is not `static' only for including it in the documentation! update ODE variables from CVODE update assignment rules update time evaluate sensitivity RHS: df/x*s + df/dp for one p

int IntegratorInstance_getForwardSens (  integratorInstance_t *  engine  )

Calls CVODES to provide forward sensitivities after a call to cvodeOneStep. produces appropriate error messages on failures and returns 1 if the integration can continue, 0 otherwise.

int IntegratorInstance_createCVODESSolverStructures (  integratorInstance_t *  engine  )

construct sensitivity related structures !! this function will require additional input for non-default case, via sensitivity input settings! !!!

SBML_ODESOLVER_API void IntegratorInstance_printCVODESStatistics (  integratorInstance_t *  engine, FILE *  f )

Prints some final statistics of the calls to CVODES forward sensitivity analysis routines.

---