libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Steady state routines

Compute and obtain basic information about the steady state. More...

Functions

bool steadyState (RRHandle handle, double *value)
 Compute the steady state of the current model. More...
 
RRVectorPtr computeSteadyStateValues (RRHandle handle)
 A convenient method for returning a vector of the steady state species concentrations. More...
 
bool setSteadyStateSelectionList (RRHandle handle, const char *list)
 Set the selection list of the steady state analysis. More...
 
RRStringArrayPtr getSteadyStateSelectionList (RRHandle handle)
 Get the selection list for the steady state analysis. More...
 

Detailed Description

Compute and obtain basic information about the steady state.

Function Documentation

RRVectorPtr computeSteadyStateValues ( RRHandle  handle)

A convenient method for returning a vector of the steady state species concentrations.

Example:

1 RRVectorHandle values = computeSteadyStateValues (void);
Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns the vector of steady state values or null if an error occurred. The order of species in the vector is indicated by the order of species Ids in a call to getFloatingSpeciesIds(void)
RRStringArrayPtr getSteadyStateSelectionList ( RRHandle  handle)

Get the selection list for the steady state analysis.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, otherwise it returns a list of strings representing symbols in the selection list
bool setSteadyStateSelectionList ( RRHandle  handle,
const char *  list 
)

Set the selection list of the steady state analysis.

Use getAvailableTimeCourseSymbols(void) to retrieve the list of all possible symbols.

Example:

1 setSteadyStateSelectionList ("S1, J1, J2")
2 
3 or
4 
5 setSteadyStateSelectionList ("S1 J1 J2")
Parameters
[in]handleHandle to a RoadRunner instance
[in]listThe string argument should be a space separated list of symbols.
Returns
Returns true if successful
bool steadyState ( RRHandle  handle,
double *  value 
)

Compute the steady state of the current model.

Example:

1 status = steadyState (rrHandle, &closenessToSteadyState);
Parameters
[in]handleHandle to a RoadRunner instance
valueThis value is set during the call and indicates how close the solution is to the steady state. The smaller the value the better. Values less than 1E-6 usually indicate a steady state has been found. If necessary call the method a second time to improve the solution.
Returns
Returns true if successful