Integration Results Interface: x(t)
[Numerical Analysis]

Collaboration diagram for Integration Results Interface: x(t):

This module contains the functions to create input data for formula evaluation and retrieve results from integration. More...

Functions
SBML_ODESOLVER_API cvodeData_t *	CvodeData_create (odeModel_t *om)
	Creates cvodeData from an odeModel and initial values from the original SBML model.
SBML_ODESOLVER_API void	CvodeData_initializeValues (cvodeData_t *data)
	Writes values from the input SBML model into the data structure.
SBML_ODESOLVER_API void	CvodeData_free (cvodeData_t *data)
	Frees cvodeData.
SBML_ODESOLVER_API int	CvodeResults_getNout (cvodeResults_t *results)
	Returns the number of time points for which results exist.
SBML_ODESOLVER_API double	CvodeResults_getTime (cvodeResults_t *results, int n)
	Returns the time point number n, where 0 <= n < CvodeResults_getNout.
SBML_ODESOLVER_API double	CvodeResults_getValue (cvodeResults_t *results, variableIndex_t *vi, int timestep)
	Returns the value of a variable or parameter of the odeModel at time step timestep via its variableIndex, where 0 <= timestep < CvodeResults_getNout, and the variableIndex can be retrieved from the input odeModel.
SBML_ODESOLVER_API double	CvodeResults_getSensitivityByNum (cvodeResults_t *results, int value, int parameter, int timestep)
	Returns the sensitivity of ODE variable y to parameter p at timestep nr.
SBML_ODESOLVER_API double	CvodeResults_getSensitivity (cvodeResults_t *results, variableIndex_t *y, variableIndex_t *p, int timestep)
	Returns the sensitivity of ODE variable y to parameter p at timestep nr.
SBML_ODESOLVER_API void	CvodeResults_free (cvodeResults_t *results)
	Frees results structure cvodeResults filled by the CVODE integrator.

---

Detailed Description

This module contains the functions to create input data for formula evaluation and retrieve results from integration.

---

Function Documentation

SBML_ODESOLVER_API cvodeData_t * CvodeData_create (  odeModel_t *  om  )

Creates cvodeData from an odeModel and initial values from the original SBML model. This function is internally used by integratorInstance creation. It is available as an API function, so users can create this structure from an odeModel to evaluate formulae in odeModel independent of integratorInstance.

SBML_ODESOLVER_API void CvodeData_initializeValues (  cvodeData_t *  data  )

Writes values from the input SBML model into the data structure.

SBML_ODESOLVER_API void CvodeData_free (  cvodeData_t *  data  )

Frees cvodeData.

SBML_ODESOLVER_API int CvodeResults_getNout (  cvodeResults_t *  results  )

Returns the number of time points for which results exist.

SBML_ODESOLVER_API double CvodeResults_getTime (  cvodeResults_t *  results, int  n )

Returns the time point number n, where 0 <= n < CvodeResults_getNout.

SBML_ODESOLVER_API double CvodeResults_getValue (  cvodeResults_t *  results, variableIndex_t *  vi, int  timestep )

Returns the value of a variable or parameter of the odeModel at time step timestep via its variableIndex, where 0 <= timestep < CvodeResults_getNout, and the variableIndex can be retrieved from the input odeModel.

SBML_ODESOLVER_API double CvodeResults_getSensitivityByNum (  cvodeResults_t *  results, int  value, int  parameter, int  timestep )

Returns the sensitivity of ODE variable y to parameter p at timestep nr. `timestep, where 0 <= timestep < CvodeResults_getNout. Must not be called, if sensitivity wasn't calculated! !! will need adaptation to selected sens.analysis !!!

SBML_ODESOLVER_API double CvodeResults_getSensitivity (  cvodeResults_t *  results, variableIndex_t *  y, variableIndex_t *  p, int  timestep )

Returns the sensitivity of ODE variable y to parameter p at timestep nr. `timestep, where 0 <= timestep < CvodeResults_getNout. Must not be called, if sensitivity wasn't calculated! !! will need adaptation to selected sens.analysis !!!

SBML_ODESOLVER_API void CvodeResults_free (  cvodeResults_t *  results  )

Frees results structure cvodeResults filled by the CVODE integrator.

---