Variables + Parameters
[ODE Model: f(x,p,t) = dx/dt]

Collaboration diagram for Variables + Parameters:

Getting the variableIndex structure. More...

Functions
SBML_ODESOLVER_API variableIndex_t *	ODEModel_getVariableIndexByNum (odeModel_t *om, int i)
	Creates and returns a variable index for ith variable.
SBML_ODESOLVER_API variableIndex_t *	ODEModel_getVariableIndex (odeModel_t *om, const char *symbol)
	Creates and returns the variableIndex for the string "symbol".
SBML_ODESOLVER_API variableIndex_t *	ODEModel_getOdeVariableIndex (odeModel_t *om, int i)
	Creates and returns a variable index for ith ODE variable.
SBML_ODESOLVER_API variableIndex_t *	ODEModel_getAssignedVariableIndex (odeModel_t *om, int i)
	Creates and returns a variable index for ith assigned variable.
SBML_ODESOLVER_API variableIndex_t *	ODEModel_getConstantIndex (odeModel_t *om, int i)
	Creates and returns a variable index for ith constant.
SBML_ODESOLVER_API void	VariableIndex_free (variableIndex_t *vi)
	Frees a variableIndex structure.

---

Detailed Description

Getting the variableIndex structure.

The variableIndex can be used to retrieve formulae from odeModel, and to get and set current values in the integratorInstance.

---

Function Documentation

SBML_ODESOLVER_API variableIndex_t* ODEModel_getVariableIndexByNum (  odeModel_t *  om, int  i )

Creates and returns a variable index for ith variable. Returns NULL if i > nvalues. This functions works for all types of variables (ODE_VARIABLE, ASSIGNED_VARIABLE, ALGEBRAIC_VARIABLE and CONSTANT). This variableIndex can be used to get and set values during an integration run with IntegratorInstance_getVariable and IntegratorInstance_setVariable, respectively. The variableIndex must be freed by the calling application.

SBML_ODESOLVER_API variableIndex_t* ODEModel_getVariableIndex (  odeModel_t *  om, const char *  symbol )

Creates and returns the variableIndex for the string "symbol". where `symbol' is the ID (corresponding to the SBML ID in the input model) of one of the models variables (ODE_VARIABLE, ASSIGNED_VARIABLE, ALGEBRAIC_VARIABLE and CONSTANT) or NULL if the symbol was not found. The variableIndex must be freed by the calling application.

SBML_ODESOLVER_API variableIndex_t* ODEModel_getOdeVariableIndex (  odeModel_t *  om, int  i )

Creates and returns a variable index for ith ODE variable. Returns NULL if not existing (i > ODEModel_getNeq(om)). The variableIndex must be freed by the calling application.

SBML_ODESOLVER_API variableIndex_t* ODEModel_getAssignedVariableIndex (  odeModel_t *  om, int  i )

Creates and returns a variable index for ith assigned variable. Returns NULL if not existing (i > ODEModel_getNumAssignedVar(om)). The variableIndex must be freed by the calling application.

SBML_ODESOLVER_API variableIndex_t* ODEModel_getConstantIndex (  odeModel_t *  om, int  i )

Creates and returns a variable index for ith constant. Returns NULL if not existing (i > ODEModel_getNumConstants(om)). The variableIndex must be freed by the calling application.

SBML_ODESOLVER_API void VariableIndex_free (  variableIndex_t *  vi  )

Frees a variableIndex structure.

---