libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Floating species group

Get information about floating species. More...

Functions

RRVectorPtr getFloatingSpeciesConcentrations (RRHandle handle)
 Retrieve in a vector the concentrations for all the floating species. More...
 
bool setFloatingSpeciesInitialConcentrationByIndex (RRHandle handle, int index, double value)
 Set the initial concentration for a particular floating species. More...
 
bool getFloatingSpeciesInitialConcentrationByIndex (RRHandle handle, int index, double *value)
 Get the initial concentration for a particular floating species. More...
 
bool setFloatingSpeciesByIndex (RRHandle handle, const int index, const double value)
 Set the concentration for a particular floating species. More...
 
bool getFloatingSpeciesByIndex (RRHandle handle, const int index, double *value)
 Retrieve the concentration for a particular floating species. More...
 
bool setFloatingSpeciesConcentrations (RRHandle handle, const RRVectorPtr vec)
 Set the floating species concentration to the vector vec. More...
 
int getNumberOfFloatingSpecies (RRHandle handle)
 Returns the number of floating species in the model. More...
 
int getNumberOfDependentSpecies (RRHandle handle)
 Returns the number of dependent species in the model. More...
 
int getNumberOfIndependentSpecies (RRHandle handle)
 Returns the number of independent species in the model. More...
 
RRStringArrayPtr getFloatingSpeciesIds (RRHandle handle)
 Obtain the list of floating species Id. More...
 

Detailed Description

Get information about floating species.

Function Documentation

bool getFloatingSpeciesByIndex ( RRHandle  handle,
const int  index,
double *  value 
)

Retrieve the concentration for a particular floating species.

Parameters
[in]handleHandle to a RoadRunner instance
indexThe index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
valueThe value returned by the method
Returns
Returns true if successful
RRVectorPtr getFloatingSpeciesConcentrations ( RRHandle  handle)

Retrieve in a vector the concentrations for all the floating species.

Example:

1 RRVectorPtr values = getFloatingSpeciesConcentrations (void);
Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns the vector of floating species concentrations or null if an error occurred
RRStringArrayPtr getFloatingSpeciesIds ( RRHandle  handle)

Obtain the list of floating species Id.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct
bool getFloatingSpeciesInitialConcentrationByIndex ( RRHandle  handle,
int  index,
double *  value 
)

Get the initial concentration for a particular floating species.

Parameters
[in]handleHandle to a RoadRunner instance
indexThe index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
[in]valueThe concentration of the species
Returns
Returns true if successful
int getNumberOfDependentSpecies ( RRHandle  handle)

Returns the number of dependent species in the model.

Parameters
[in]handleHandle to a RoadRunner instance
int getNumberOfFloatingSpecies ( RRHandle  handle)

Returns the number of floating species in the model.

Parameters
[in]handleHandle to a RoadRunner instance
int getNumberOfIndependentSpecies ( RRHandle  handle)

Returns the number of independent species in the model.

Parameters
[in]handleHandle to a RoadRunner instance
bool setFloatingSpeciesByIndex ( RRHandle  handle,
const int  index,
const double  value 
)

Set the concentration for a particular floating species.

Parameters
[in]handleHandle to a RoadRunner instance
indexThe index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
valueThe concentration of the species to set
Returns
Returns true if successful
bool setFloatingSpeciesConcentrations ( RRHandle  handle,
const RRVectorPtr  vec 
)

Set the floating species concentration to the vector vec.

Example:

1 myVector = createVector (getNumberOfFloatingSpecies(RRHandle handle));
2 setVectorElement (myVector, 0, 1.2);
3 setVectorElement (myVector, 1, 5.7);
4 setVectorElement (myVector, 2, 3.4);
5 setFloatingSpeciesConcentrations(myVector);
Parameters
[in]handleHandle to a RoadRunner instance
[in]vecPointer to a RRVector
Returns
Returns true if successful
bool setFloatingSpeciesInitialConcentrationByIndex ( RRHandle  handle,
int  index,
double  value 
)

Set the initial concentration for a particular floating species.

Parameters
[in]handleHandle to a RoadRunner instance
indexThe index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
valueThe concentration of the species to set
Returns
Returns true if successful