Boundary species group

Get information about boundary species. More...

Functions
C_DECL_SPEC RRVectorPtr rrcCallConv	getBoundarySpeciesConcentrations (RRHandle handle)
	Retrieve the concentrations for all the boundary species in a vector. More...
C_DECL_SPEC bool rrcCallConv	setBoundarySpeciesByIndex (RRHandle handle, const unsigned int index, const double value)
	Set the concentration for a particular boundary species. More...
C_DECL_SPEC bool rrcCallConv	getBoundarySpeciesByIndex (RRHandle handle, const int index, double *value)
	Retrieve the concentration for a particular floating species. More...
C_DECL_SPEC bool rrcCallConv	setBoundarySpeciesConcentrations (RRHandle handle, const RRVectorPtr vec)
	Set the boundary species concentration to the vector vec. More...
C_DECL_SPEC int rrcCallConv	getNumberOfBoundarySpecies (RRHandle handle)
	Returns the number of boundary species in the model. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getBoundarySpeciesIds (RRHandle handle)
	Obtain the list of boundary species Ids. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getBoundarySpeciesConcentrationIds (RRHandle handle)
	Obtain the list of boundary species concentration Ids. More...

Detailed Description

Get information about boundary species.

Function Documentation

getBoundarySpeciesByIndex()

C_DECL_SPEC bool rrcCallConv getBoundarySpeciesByIndex	(	RRHandle	handle,
		const int	index,
		double *	value
	)

Retrieve the concentration for a particular floating species.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	The index to the boundary species (corresponds to position in getBoundarySpeciesIds(RRHandle handle))
	value	The value returned by the method

Returns

Returns true if successful

getBoundarySpeciesConcentrationIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesConcentrationIds

(

RRHandle

handle

)

Obtain the list of boundary species concentration Ids.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct

getBoundarySpeciesConcentrations()

C_DECL_SPEC RRVectorPtr rrcCallConv getBoundarySpeciesConcentrations

(

RRHandle

handle

)

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

Example:

RRVectorPtr values = getBoundarySpeciesConcentrations (void); 

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns the vector of boundary species concentrations or null if an error occurred

getBoundarySpeciesIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesIds

(

RRHandle

handle

)

Obtain the list of boundary species Ids.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct

getNumberOfBoundarySpecies()

C_DECL_SPEC int rrcCallConv getNumberOfBoundarySpecies

(

RRHandle

handle

)

Returns the number of boundary species in the model.

Parameters

[in]

handle

Handle to a RoadRunner instance

setBoundarySpeciesByIndex()

C_DECL_SPEC bool rrcCallConv setBoundarySpeciesByIndex	(	RRHandle	handle,
		const unsigned int	index,
		const double	value
	)

Set the concentration for a particular boundary species.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	The index to the boundary species (corresponds to position in getBoundarySpeciesIds(void))
	value	The concentration of the species to set

Returns

Returns true if successful

setBoundarySpeciesConcentrations()

C_DECL_SPEC bool rrcCallConv setBoundarySpeciesConcentrations	(	RRHandle	handle,
		const RRVectorPtr	vec
	)

Set the boundary species concentration to the vector vec.

Example:

myVector = createVector (getNumberOfBoundarySpecies(RRHandle handle));
setVectorElement (myVector, 0, 1.2);
setVectorElement (myVector, 1, 5.7);
setVectorElement (myVector, 2, 3.4);
setBoundarySpeciesConcentrations(myVector);

Parameters

[in]	handle	Handle to a RoadRunner instance
	vec	A vector of boundary species concentrations

Returns

Returns true if successful