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:

RRVectorHandle values = computeSteadyStateValues (void);

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns the vector of steady state values or null if an error occured. 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] handle Handle 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:

setSteadyStateSelectionList ("S1, J1, J2")
or
setSteadyStateSelectionList ("S1 J1 J2")

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	list	The string argument should be a space separated list of symbols.

Compute the steady state of the current model.

Example:

status = steadyState (rrHandle, &closenessToSteadyState);

Parameters

[in]	handle	Handle to a RoadRunner instance
	value	This 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.