libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Solver options API

Reflective API for interacting with steady state solvers and integrators. More...

Functions

int getNumRegisteredIntegrators ()
 Get the number of registered integrators. More...
 
char * getRegisteredIntegratorName (int n)
 Get the name of a registered integrator (e.g. cvode etc.) More...
 
char * getRegisteredIntegratorHint (int n)
 Get the hint of a registered integrator (e.g. cvode etc.) More...
 
char * getRegisteredIntegratorDescription (int n)
 Get the description of a registered integrator (e.g. cvode etc.) More...
 
int getNumInstantiatedIntegrators (RRHandle handle)
 Get the number of instantiated integrators. To instantiate an integrator, use setCurrentIntegrator. More...
 
int setCurrentIntegrator (RRHandle handle, char *nameOfIntegrator)
 Specify the current integrator to be used for simulation. This method instantiates a new integrator of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing integrator of this type is used. More...
 
char * getCurrentIntegratorName (RRHandle handle)
 Obtain a description of the current integrator. More...
 
char * getCurrentIntegratorDescription (RRHandle handle)
 Obtain a description of the current integrator. More...
 
char * getCurrentIntegratorHint (RRHandle handle)
 Obtain a short hint for the current integrator. More...
 
int getNumberOfCurrentIntegratorParameters (RRHandle handle)
 Get the number of adjustable settings for the current integrator. More...
 
char * getCurrentIntegratorNthParameterName (RRHandle handle, int n)
 Get the name of a parameter of the current integrator. More...
 
char * getCurrentIntegratorNthParameterDescription (RRHandle handle, int n)
 Get the description of a parameter of the current integrator. More...
 
char * getCurrentIntegratorNthParameterDisplayName (RRHandle handle, int n)
 Get the display name of a parameter of the current integrator. More...
 
char * getCurrentIntegratorNthParameterHint (RRHandle handle, int n)
 Get the hint of a parameter of the current integrator. More...
 
int getCurrentIntegratorNthParameterType (RRHandle handle, int n)
 Get the type of a parameter of the current integrator. More...
 
int resetCurrentIntegratorParameters (RRHandle handle)
 Reset the integrator parameters to their default values. More...
 
RRStringArrayPtr getListOfCurrentIntegratorParameterNames (RRHandle handle)
 Get the names of adjustable settings for the current integrator. More...
 
char * getCurrentIntegratorParameterDescription (RRHandle handle, char *parameterName)
 Get the description for a specific integrator setting. More...
 
char * getCurrentIntegratorParameterHint (RRHandle handle, char *parameterName)
 Get the hint for a specific integrator setting. More...
 
int getCurrentIntegratorParameterType (RRHandle handle, char *parameterName)
 Get the return type for a specific integrator setting. More...
 
int getCurrentIntegratorParameterInt (RRHandle handle, char *parameterName)
 Get the integer value for a specific integrator setting. More...
 
int setCurrentIntegratorParameterInt (RRHandle handle, char *parameterName, int value)
 Set the integer value for a specific integrator setting. More...
 
unsigned int getCurrentIntegratorParameterUInt (RRHandle handle, char *parameterName)
 Get the unsigned integer value for a specific integrator setting. More...
 
int setCurrentIntegratorParameterUInt (RRHandle handle, char *parameterName, unsigned int value)
 Set the unsigned integer value for a specific integrator setting. More...
 
double getCurrentIntegratorParameterDouble (RRHandle handle, char *parameterName)
 Get the double value for a specific integrator setting. More...
 
int setCurrentIntegratorParameterDouble (RRHandle handle, char *parameterName, double value)
 Set the double value for a specific integrator setting. More...
 
char * getCurrentIntegratorParameterString (RRHandle handle, char *parameterName)
 Get the string value for a specific integrator setting. More...
 
int setCurrentIntegratorParameterString (RRHandle handle, char *parameterName, char *value)
 Set the string value for a specific integrator setting. More...
 
int getCurrentIntegratorParameterBoolean (RRHandle handle, char *parameterName)
 Get the boolean value for a specific integrator setting. More...
 
int setCurrentIntegratorParameterBoolean (RRHandle handle, char *parameterName, int value)
 Set the boolean value for a specific integrator setting. More...
 
int getNumRegisteredSteadyStateSolvers ()
 Get the number of registered steady state solvers. More...
 
char * getRegisteredSteadyStateSolverName (int n)
 Get the name of a registered steady state solver (e.g. cvode etc.) More...
 
char * getRegisteredSteadyStateSolverHint (int n)
 Get the hint of a registered steady state solver (e.g. cvode etc.) More...
 
char * getRegisteredSteadyStateSolverDescription (int n)
 Get the description of a registered steady state solver (e.g. cvode etc.) More...
 
int setCurrentSteadyStateSolver (RRHandle handle, char *nameOfSteadyStateSolver)
 Specify the current steady state solver to be used for simulation. This method instantiates a new steady state solver of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing steady state solver of this type is used. More...
 
char * getCurrentSteadyStateSolverName (RRHandle handle)
 Obtain a description of the current steady state solver. More...
 
char * getCurrentSteadyStateSolverDescription (RRHandle handle)
 Obtain a description of the current steady state solver. More...
 
char * getCurrentSteadyStateSolverHint (RRHandle handle)
 Obtain a short hint for the current steady state solver. More...
 
int getNumberOfCurrentSteadyStateSolverParameters (RRHandle handle)
 Get the number of adjustable settings for the current steady state solver. More...
 
char * getCurrentSteadyStateSolverNthParameterName (RRHandle handle, int n)
 Get the name of a parameter of the current steady state solver. More...
 
char * getCurrentSteadyStateSolverNthParameterDisplayName (RRHandle handle, int n)
 Get the display name of a parameter of the current steady state solver. More...
 
char * getCurrentSteadyStateSolverNthParameterDescription (RRHandle handle, int n)
 Get the description of a parameter of the current steady state solver. More...
 
char * getCurrentSteadyStateSolverNthParameterHint (RRHandle handle, int n)
 Get the hint of a parameter of the current steady state solver. More...
 
int getCurrentSteadyStateSolverNthParameterType (RRHandle handle, int n)
 Get the type of a parameter of the current steady state solver. More...
 
int resetCurrentSteadyStateSolverParameters (RRHandle handle)
 Reset the steady state solver parameters to their default values. More...
 
const char * solverTypeToString (int code)
 Get a string description of the type [STATIC MEMORY - DO NOT FREE] Can call on return value of e.g. getCurrentSteadyStateSolverNthParameterType to retrieve human-readable string representation. More...
 
RRStringArrayPtr getListOfCurrentSteadyStateSolverParameterNames (RRHandle handle)
 Get the names of adjustable settings for the current steady state solver. More...
 
char * getCurrentSteadyStateSolverParameterDescription (RRHandle handle, char *parameterName)
 Get the description for a specific steady state solver setting. More...
 
char * getCurrentSteadyStateSolverParameterHint (RRHandle handle, char *parameterName)
 Get the hint for a specific steady state solver setting. More...
 
int getCurrentSteadyStateSolverParameterType (RRHandle handle, char *parameterName)
 Get the return type for a specific steady state solver setting. More...
 
int getCurrentSteadyStateSolverParameterInt (RRHandle handle, char *parameterName)
 Get the integer value for a specific steady state solver setting. More...
 
int setCurrentSteadyStateSolverParameterInt (RRHandle handle, char *parameterName, int value)
 Set the integer value for a specific steady state solver setting. More...
 
unsigned int getCurrentSteadyStateSolverParameterUInt (RRHandle handle, char *parameterName)
 Get the unsigned integer value for a specific steady state solver setting. More...
 
int setCurrentSteadyStateSolverParameterUInt (RRHandle handle, char *parameterName, unsigned int value)
 Set the unsigned integer value for a specific steady state solver setting. More...
 
double getCurrentSteadyStateSolverParameterDouble (RRHandle handle, char *parameterName)
 Get the double value for a specific steady state solver setting. More...
 
int setCurrentSteadyStateSolverParameterDouble (RRHandle handle, char *parameterName, double value)
 Set the double value for a specific steady state solver setting. More...
 
char * getCurrentSteadyStateSolverParameterString (RRHandle handle, char *parameterName)
 Get the string value for a specific steady state solver setting. More...
 
int setCurrentSteadyStateSolverParameterString (RRHandle handle, char *parameterName, char *value)
 Set the string value for a specific steady state solver setting. More...
 
int getCurrentSteadyStateSolverParameterBoolean (RRHandle handle, char *parameterName)
 Get the boolean value for a specific steady state solver setting. More...
 
int setCurrentSteadyStateSolverParameterBoolean (RRHandle handle, char *parameterName, int value)
 Set the boolean value for a specific steady state solver setting. More...
 

Detailed Description

Reflective API for interacting with steady state solvers and integrators.

Function Documentation

char* getCurrentIntegratorDescription ( RRHandle  handle)

Obtain a description of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a description of the current integrator.
char* getCurrentIntegratorHint ( RRHandle  handle)

Obtain a short hint for the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a short hint of the current integrator.
char* getCurrentIntegratorName ( RRHandle  handle)

Obtain a description of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a description of the current integrator.
char* getCurrentIntegratorNthParameterDescription ( RRHandle  handle,
int  n 
)

Get the description of a parameter of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)
char* getCurrentIntegratorNthParameterDisplayName ( RRHandle  handle,
int  n 
)

Get the display name of a parameter of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)
char* getCurrentIntegratorNthParameterHint ( RRHandle  handle,
int  n 
)

Get the hint of a parameter of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)
char* getCurrentIntegratorNthParameterName ( RRHandle  handle,
int  n 
)

Get the name of a parameter of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)
int getCurrentIntegratorNthParameterType ( RRHandle  handle,
int  n 
)

Get the type of a parameter of the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)
int getCurrentIntegratorParameterBoolean ( RRHandle  handle,
char *  parameterName 
)

Get the boolean value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns a boolean value for the integrator setting.
char* getCurrentIntegratorParameterDescription ( RRHandle  handle,
char *  parameterName 
)

Get the description for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns a description for the integrator setting.
double getCurrentIntegratorParameterDouble ( RRHandle  handle,
char *  parameterName 
)

Get the double value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns a double value for the integrator setting.
char* getCurrentIntegratorParameterHint ( RRHandle  handle,
char *  parameterName 
)

Get the hint for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns a hint for the integrator setting.
int getCurrentIntegratorParameterInt ( RRHandle  handle,
char *  parameterName 
)

Get the integer value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns an integer value for the integrator setting.
char* getCurrentIntegratorParameterString ( RRHandle  handle,
char *  parameterName 
)

Get the string value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns a string value for the integrator setting.
int getCurrentIntegratorParameterType ( RRHandle  handle,
char *  parameterName 
)

Get the return type for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns a integer that indicates the return type for the integrator setting. 0-STRING, 1-BOOL, 2-INT32, 3-UINT32, 4-INT64, 5-UINT64, 6-FLOAT, 7-DOUBLE, 8-CHAR, 9-UCHAR, 10-EMPTY
unsigned int getCurrentIntegratorParameterUInt ( RRHandle  handle,
char *  parameterName 
)

Get the unsigned integer value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
Returns
Returns an integer value for the integrator setting.
char* getCurrentSteadyStateSolverDescription ( RRHandle  handle)

Obtain a description of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a description of the current steady state solver.
char* getCurrentSteadyStateSolverHint ( RRHandle  handle)

Obtain a short hint for the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a short hint of the current steady state solver.
char* getCurrentSteadyStateSolverName ( RRHandle  handle)

Obtain a description of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a description of the current steady state solver.
char* getCurrentSteadyStateSolverNthParameterDescription ( RRHandle  handle,
int  n 
)

Get the description of a parameter of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)
char* getCurrentSteadyStateSolverNthParameterDisplayName ( RRHandle  handle,
int  n 
)

Get the display name of a parameter of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)
char* getCurrentSteadyStateSolverNthParameterHint ( RRHandle  handle,
int  n 
)

Get the hint of a parameter of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)
char* getCurrentSteadyStateSolverNthParameterName ( RRHandle  handle,
int  n 
)

Get the name of a parameter of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)
int getCurrentSteadyStateSolverNthParameterType ( RRHandle  handle,
int  n 
)

Get the type of a parameter of the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nThe index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)
int getCurrentSteadyStateSolverParameterBoolean ( RRHandle  handle,
char *  parameterName 
)

Get the boolean value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns a boolean value for the steady state solver setting.
char* getCurrentSteadyStateSolverParameterDescription ( RRHandle  handle,
char *  parameterName 
)

Get the description for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns a description for the steady state solver setting.
double getCurrentSteadyStateSolverParameterDouble ( RRHandle  handle,
char *  parameterName 
)

Get the double value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns a double value for the steady state solver setting.
char* getCurrentSteadyStateSolverParameterHint ( RRHandle  handle,
char *  parameterName 
)

Get the hint for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns a hint for the steady state solver setting.
int getCurrentSteadyStateSolverParameterInt ( RRHandle  handle,
char *  parameterName 
)

Get the integer value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns an integer value for the steady state solver setting.
char* getCurrentSteadyStateSolverParameterString ( RRHandle  handle,
char *  parameterName 
)

Get the string value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns a string value for the steady state solver setting.
int getCurrentSteadyStateSolverParameterType ( RRHandle  handle,
char *  parameterName 
)

Get the return type for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns a integer that indicates the return type for the steady state solver setting. 0-STRING, 1-BOOL, 2-INT32, 3-UINT32, 4-INT64, 5-UINT64, 6-FLOAT, 7-DOUBLE, 8-CHAR, 9-UCHAR, 10-EMPTY
unsigned int getCurrentSteadyStateSolverParameterUInt ( RRHandle  handle,
char *  parameterName 
)

Get the unsigned integer value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
Returns
Returns an integer value for the steady state solver setting.
RRStringArrayPtr getListOfCurrentIntegratorParameterNames ( RRHandle  handle)

Get the names of adjustable settings for the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a list that contains the names of adjustable integrator settings.
RRStringArrayPtr getListOfCurrentSteadyStateSolverParameterNames ( RRHandle  handle)

Get the names of adjustable settings for the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns a list that contains the names of adjustable steady state solver settings.
int getNumberOfCurrentIntegratorParameters ( RRHandle  handle)

Get the number of adjustable settings for the current integrator.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns an integer that corresponds to the number of adjustable integrator settings.
int getNumberOfCurrentSteadyStateSolverParameters ( RRHandle  handle)

Get the number of adjustable settings for the current steady state solver.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns an integer that corresponds to the number of adjustable steady state solver settings.
int getNumInstantiatedIntegrators ( RRHandle  handle)

Get the number of instantiated integrators. To instantiate an integrator, use setCurrentIntegrator.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns an integer that corresponds to the number of currently registered integrators.
int getNumRegisteredIntegrators ( )

Get the number of registered integrators.

Returns
Returns an integer that corresponds to the number of currently registered integrators.
int getNumRegisteredSteadyStateSolvers ( )

Get the number of registered steady state solvers.

Returns
Returns an integer that corresponds to the number of currently registered steady state solvers.
char* getRegisteredIntegratorDescription ( int  n)

Get the description of a registered integrator (e.g. cvode etc.)

Parameters
[in]nThe index of the registered integrator
Note
Callee owns memory
char* getRegisteredIntegratorHint ( int  n)

Get the hint of a registered integrator (e.g. cvode etc.)

Parameters
[in]nThe index of the registered integrator
Note
Callee owns memory
char* getRegisteredIntegratorName ( int  n)

Get the name of a registered integrator (e.g. cvode etc.)

Parameters
[in]nThe index of the registered integrator
Note
Callee owns memory
char* getRegisteredSteadyStateSolverDescription ( int  n)

Get the description of a registered steady state solver (e.g. cvode etc.)

Parameters
[in]nThe index of the registered steady state solver
Note
Callee owns memory
char* getRegisteredSteadyStateSolverHint ( int  n)

Get the hint of a registered steady state solver (e.g. cvode etc.)

Parameters
[in]nThe index of the registered steady state solver
Note
Callee owns memory
char* getRegisteredSteadyStateSolverName ( int  n)

Get the name of a registered steady state solver (e.g. cvode etc.)

Parameters
[in]nThe index of the registered steady state solver
Note
Callee owns memory
int resetCurrentIntegratorParameters ( RRHandle  handle)

Reset the integrator parameters to their default values.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns True if successful.
int resetCurrentSteadyStateSolverParameters ( RRHandle  handle)

Reset the steady state solver parameters to their default values.

Parameters
[in]handleHandle to a RoadRunner instance.
Returns
Returns True if successful.
int setCurrentIntegrator ( RRHandle  handle,
char *  nameOfIntegrator 
)

Specify the current integrator to be used for simulation. This method instantiates a new integrator of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing integrator of this type is used.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nameOfIntegratorName of the integrator to be used.
Returns
Returns True if successful.
int setCurrentIntegratorParameterBoolean ( RRHandle  handle,
char *  parameterName,
int  value 
)

Set the boolean value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
[in]valueThe boolean value for the integrator setting.
Returns
Returns True if successful.
int setCurrentIntegratorParameterDouble ( RRHandle  handle,
char *  parameterName,
double  value 
)

Set the double value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
[in]valueThe double value for the integrator setting.
Returns
Returns True if successful.
int setCurrentIntegratorParameterInt ( RRHandle  handle,
char *  parameterName,
int  value 
)

Set the integer value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
[in]valueThe integer value for the integrator setting.
Returns
Returns True if successful.
int setCurrentIntegratorParameterString ( RRHandle  handle,
char *  parameterName,
char *  value 
)

Set the string value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
[in]valueThe string value for the integrator setting.
Returns
Returns True if successful.
int setCurrentIntegratorParameterUInt ( RRHandle  handle,
char *  parameterName,
unsigned int  value 
)

Set the unsigned integer value for a specific integrator setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the integrator setting.
[in]valueThe integer value for the integrator setting.
Returns
Returns True if successful.
int setCurrentSteadyStateSolver ( RRHandle  handle,
char *  nameOfSteadyStateSolver 
)

Specify the current steady state solver to be used for simulation. This method instantiates a new steady state solver of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing steady state solver of this type is used.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]nameOfSteadyStateSolverName of the steady state solver to be used.
Returns
Returns True if successful.
int setCurrentSteadyStateSolverParameterBoolean ( RRHandle  handle,
char *  parameterName,
int  value 
)

Set the boolean value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
[in]valueThe boolean value for the steady state solver setting.
Returns
Returns True if successful.
int setCurrentSteadyStateSolverParameterDouble ( RRHandle  handle,
char *  parameterName,
double  value 
)

Set the double value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
[in]valueThe double value for the steady state solver setting.
Returns
Returns True if successful.
int setCurrentSteadyStateSolverParameterInt ( RRHandle  handle,
char *  parameterName,
int  value 
)

Set the integer value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
[in]valueThe integer value for the steady state solver setting.
Returns
Returns True if successful.
int setCurrentSteadyStateSolverParameterString ( RRHandle  handle,
char *  parameterName,
char *  value 
)

Set the string value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
[in]valueThe string value for the steady state solver setting.
Returns
Returns True if successful.
int setCurrentSteadyStateSolverParameterUInt ( RRHandle  handle,
char *  parameterName,
unsigned int  value 
)

Set the unsigned integer value for a specific steady state solver setting.

Parameters
[in]handleHandle to a RoadRunner instance.
[in]paramterNameName of the steady state solver setting.
[in]valueThe integer value for the steady state solver setting.
Returns
Returns True if successful.
const char* solverTypeToString ( int  code)

Get a string description of the type [STATIC MEMORY - DO NOT FREE] Can call on return value of e.g. getCurrentSteadyStateSolverNthParameterType to retrieve human-readable string representation.

Parameters
[in]codeType code for the parameter