libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Rates of change group

Get information about rates of change. More...

Functions

RRVectorPtr getRatesOfChange (RRHandle handle)
 Retrieve the vector of rates of change as determined by the current state of the model. More...
 
RRStringArrayPtr getRatesOfChangeIds (RRHandle handle)
 Retrieve the string list of rates of change Ids. More...
 
bool getRateOfChange (RRHandle handle, const int, double *value)
 Retrieve the rate of change for a given floating species. More...
 
RRVectorPtr getRatesOfChangeEx (RRHandle handle, const RRVectorPtr vec)
 Retrieve the vector of rates of change given a vector of floating species concentrations. More...
 

Detailed Description

Get information about rates of change.

Function Documentation

bool getRateOfChange ( RRHandle  handle,
const int  ,
double *  value 
)

Retrieve the rate of change for a given floating species.

Example:

1 status = getRateOfChange (&index, *value);
Parameters
[in]handleHandle to a RoadRunner instance
[out]valuePointer to double, holding the rate of change
Returns
Returns false if it fails, otherwise value contains the rate of change.
RRVectorPtr getRatesOfChange ( RRHandle  handle)

Retrieve the vector of rates of change as determined by the current state of the model.

Example:

1 values = getRatesOfChange (RRHandle handle);
Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, otherwise returns a vector of rates of change values
RRVectorPtr getRatesOfChangeEx ( RRHandle  handle,
const RRVectorPtr  vec 
)

Retrieve the vector of rates of change given a vector of floating species concentrations.

Example:

1 values = getRatesOfChangeEx (vector);
Parameters
[in]handleHandle to a RoadRunner instance
[in]vecVector handle holding rates of change
Returns
Returns null if it fails
RRStringArrayPtr getRatesOfChangeIds ( RRHandle  handle)

Retrieve the string list of rates of change Ids.

Example:

1 Ids = getRatesOfChangeIds (RRHandle handle);
Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, otherwise returns a list of rates of change Ids