libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Current state of system

Compute derivatives, fluxes, and other values of the system at the current state. More...

Functions

bool getValue (RRHandle handle, const char *symbolId, double *value)
 Get the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols. More...
 
bool setValue (RRHandle handle, const char *symbolId, const double value)
 Set the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols. More...
 
bool evalModel (RRHandle handle)
 Evaluate the current model, that it update all assignments and rates of change. Do not carry out an integration step. More...
 
RRStringArrayPtr getEigenvalueIds (RRHandle handle)
 Obtain the list of eigenvalue Ids. More...
 
RRListPtr getAvailableTimeCourseSymbols (RRHandle handle)
 Obtain the list of all available symbols. More...
 
RRListPtr getAvailableSteadyStateSymbols (RRHandle handle)
 Obtain the list of all available steady state symbols. More...
 

Detailed Description

Compute derivatives, fluxes, and other values of the system at the current state.

Function Documentation

bool evalModel ( RRHandle  handle)

Evaluate the current model, that it update all assignments and rates of change. Do not carry out an integration step.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns false if it fails
RRListPtr getAvailableSteadyStateSymbols ( RRHandle  handle)

Obtain the list of all available steady state symbols.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns -1 if it fails, if successful it returns a pointer to a RRListPtr struct
RRListPtr getAvailableTimeCourseSymbols ( RRHandle  handle)

Obtain the list of all available symbols.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns -1 if it fails, if successful it returns a pointer to a RRListHandle struct
RRStringArrayPtr getEigenvalueIds ( RRHandle  handle)

Obtain the list of eigenvalue Ids.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns -1 if it fails, if successful it returns a pointer to a RRStringArrayPtr struct
bool getValue ( RRHandle  handle,
const char *  symbolId,
double *  value 
)

Get the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols.

Example:

1 status = getValue (rrHandle, "S1", &value);
Parameters
[in]handleHandle to a RoadRunner instance
symbolIdThe symbol that we wish to obtain the value for
valueThe value that will be retrieved
Returns
Returns true if successful
bool setValue ( RRHandle  handle,
const char *  symbolId,
const double  value 
)

Set the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols.

Example:

1 status = setValue (rrHandle, "S1", 0.5);
Parameters
[in]handleHandle to a RoadRunner instance
symbolIdThe symbol that we wish to set the value
valueThe value that will be set to the symbol
Returns
Returns true if successful