Calculate control coefficients and sensitivities. More...

Functions
C_DECL_SPEC RRListPtr rrcCallConv	getElasticityCoefficientIds (RRHandle handle)
	Obtain the list of elasticity coefficient Ids. More...

C_DECL_SPEC RRListPtr rrcCallConv	getUnscaledFluxControlCoefficientIds (RRHandle handle)
	Obtain the list of unscaled flux control coefficient Ids. More...

C_DECL_SPEC RRListPtr rrcCallConv	getFluxControlCoefficientIds (RRHandle handle)
	Obtain the list of flux control coefficient Ids. More...

C_DECL_SPEC RRListPtr rrcCallConv	getUnscaledConcentrationControlCoefficientIds (RRHandle handle)
	Obtain the list of unscaled concentration control coefficient Ids. More...

C_DECL_SPEC RRListPtr rrcCallConv	getConcentrationControlCoefficientIds (RRHandle handle)
	Obtain the list of concentration coefficient Ids. More...

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv	getUnscaledElasticityMatrix (RRHandle handle)
	Retrieve the unscaled elasticity matrix for the current model. More...

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv	getScaledElasticityMatrix (RRHandle handle)
	Retrieve the scaled elasticity matrix for the current model. More...

C_DECL_SPEC bool rrcCallConv	getScaledFloatingSpeciesElasticity (RRHandle handle, const char reactionId, const char speciesId, double *value)
	Retrieve the scaled elasticity matrix for the current model. More...

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv	getUnscaledConcentrationControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of unscaled concentration control coefficients for the current model. More...

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv	getScaledConcentrationControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of scaled concentration control coefficients for the current model. More...

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv	getUnscaledFluxControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of unscaled flux control coefficients for the current model. More...

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv	getScaledFluxControlCoefficientMatrix (RRHandle handle)
	Retrieve the matrix of scaled flux control coefficients for the current model. More...

C_DECL_SPEC bool rrcCallConv	getuCC (RRHandle handle, const char variable, const char parameter, double *value)
	Retrieve a single unscaled control coefficient. More...

C_DECL_SPEC bool rrcCallConv	getCC (RRHandle handle, const char variable, const char parameter, double *value)
	Retrieve a single control coefficient. More...

C_DECL_SPEC bool rrcCallConv	getEE (RRHandle handle, const char name, const char species, double *value)
	Retrieve a single elasticity coefficient. More...

C_DECL_SPEC bool rrcCallConv	getuEE (RRHandle handle, const char name, const char species, double *value)
	Retrieve a single unscaled elasticity coefficient. More...

Detailed Description

Calculate control coefficients and sensitivities.

Function Documentation

◆ getCC()

C_DECL_SPEC bool rrcCallConv getCC	(	RRHandle	handle,
		const char *	variable,
		const char *	parameter,
		double *	value
	)

Retrieve a single control coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	variable	This is the dependent variable of the coefficient, for example a flux or species concentration
[in]	parameter	This is the independent parameter, for example a kinetic constant or boundary species
[out]	value	This is the value of the control coefficient returns to the caller

Returns: Returns true if successful

◆ getConcentrationControlCoefficientIds()

C_DECL_SPEC RRListPtr rrcCallConv getConcentrationControlCoefficientIds ( RRHandle handle )

Obtain the list of concentration coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if successful it returns a list of Ids

◆ getEE()

C_DECL_SPEC bool rrcCallConv getEE	(	RRHandle	handle,
		const char *	name,
		const char *	species,
		double *	value
	)

Retrieve a single elasticity coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	name	This is the reaction variable for the elasticity
[in]	species	This is the independent parameter, for example a floating of boundary species
[out]	value	This is the value of the elasticity coefficient returns to the caller

Returns: Returns true if successful

◆ getElasticityCoefficientIds()

C_DECL_SPEC RRListPtr rrcCallConv getElasticityCoefficientIds ( RRHandle handle )

Obtain the list of elasticity coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if successful it returns a list

◆ getFluxControlCoefficientIds()

C_DECL_SPEC RRListPtr rrcCallConv getFluxControlCoefficientIds ( RRHandle handle )

Obtain the list of flux control coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if successful it returns a list of Ids

◆ getScaledConcentrationControlCoefficientMatrix()

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledConcentrationControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of scaled concentration control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of scaled concentration control coefficients

◆ getScaledElasticityMatrix()

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledElasticityMatrix ( RRHandle handle )

Retrieve the scaled elasticity matrix for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of scaled elasticities.

◆ getScaledFloatingSpeciesElasticity()

C_DECL_SPEC bool rrcCallConv getScaledFloatingSpeciesElasticity	(	RRHandle	handle,
		const char *	reactionId,
		const char *	speciesId,
		double *	value
	)

Retrieve the scaled elasticity matrix for the current model.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	reactionId	The reaction Id for computing the elasticity
[in]	speciesId	The floating species to compute the elasticity for
[out]	value	The return value for the elasticity

Returns: Returns false if it fails

◆ getScaledFluxControlCoefficientMatrix()

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledFluxControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of scaled flux control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of scaled flux control coefficients

◆ getuCC()

C_DECL_SPEC bool rrcCallConv getuCC	(	RRHandle	handle,
		const char *	variable,
		const char *	parameter,
		double *	value
	)

Retrieve a single unscaled control coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	variable	This is the dependent variable of the coefficient, for example a flux or species concentration
[in]	parameter	This is the independent parameter, for example a kinetic constant or boundary species
[out]	value	This is the value of the unscaled control coefficient returns to the caller

Returns: Returns true if successful

◆ getuEE()

C_DECL_SPEC bool rrcCallConv getuEE	(	RRHandle	handle,
		const char *	name,
		const char *	species,
		double *	value
	)

Retrieve a single unscaled elasticity coefficient.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	name	This is the reaction variable for the unscaled elasticity
[in]	species	This is the independent parameter, for example a floating of boundary species
[out]	value	This is the value of the unscaled elasticity coefficient returns to the caller

Returns: Returns true if successful

◆ getUnscaledConcentrationControlCoefficientIds()

C_DECL_SPEC RRListPtr rrcCallConv getUnscaledConcentrationControlCoefficientIds ( RRHandle handle )

Obtain the list of unscaled concentration control coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if successful it returns a list of Ids

◆ getUnscaledConcentrationControlCoefficientMatrix()

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledConcentrationControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of unscaled concentration control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of unscaled concentration control coefficients The first column will contain the real values and the second column the imaginary values

◆ getUnscaledElasticityMatrix()

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledElasticityMatrix ( RRHandle handle )

Retrieve the unscaled elasticity matrix for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns nil if it fails, otherwise returns a matrix of unscaled elasticities

◆ getUnscaledFluxControlCoefficientIds()

C_DECL_SPEC RRListPtr rrcCallConv getUnscaledFluxControlCoefficientIds ( RRHandle handle )

Obtain the list of unscaled flux control coefficient Ids.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, if successful it returns a list of Ids

◆ getUnscaledFluxControlCoefficientMatrix()

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledFluxControlCoefficientMatrix ( RRHandle handle )

Retrieve the matrix of unscaled flux control coefficients for the current model.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise returns a matrix of unscaled flux control coefficients

Functions

Detailed Description

Function Documentation

◆ getCC()

◆ getConcentrationControlCoefficientIds()

◆ getEE()

◆ getElasticityCoefficientIds()

◆ getFluxControlCoefficientIds()

◆ getScaledConcentrationControlCoefficientMatrix()

◆ getScaledElasticityMatrix()

◆ getScaledFloatingSpeciesElasticity()

◆ getScaledFluxControlCoefficientMatrix()

◆ getuCC()

◆ getuEE()

◆ getUnscaledConcentrationControlCoefficientIds()

◆ getUnscaledConcentrationControlCoefficientMatrix()

◆ getUnscaledElasticityMatrix()

◆ getUnscaledFluxControlCoefficientIds()

◆ getUnscaledFluxControlCoefficientMatrix()