Generated CLib API for Cantera's Kinetics class. More...

Collaboration diagram for ctkin Library:

Detailed Description

Generated CLib API for Cantera's Kinetics class.

Warning: This library is an experimental part of the Cantera API and may be changed or removed without notice.

Functions
int32_t	kin_getType (int32_t handle, int32_t bufLen, char *buf)
	Identifies the Kinetics manager type.

int32_t	kin_nReactions (int32_t handle)
	Number of reactions in the reaction mechanism.

int32_t	kin_reaction (int32_t handle, int32_t i)
	Return the Reaction object for reaction.

int32_t	kin_nPhases (int32_t handle)
	The number of phases participating in the reaction mechanism.

int32_t	kin_phase (int32_t handle, int32_t n)
	Return pointer to phase associated with Kinetics by index.

int32_t	kin_reactionPhase (int32_t handle)
	Return pointer to phase where the reactions occur.

int32_t	kin_phaseIndex (int32_t handle, const char *ph)
	Return the phase index of a phase in the list of phases defined within the object.

int32_t	kin_nTotalSpecies (int32_t handle)
	The total number of species in all phases participating in the kinetics mechanism.

double	kin_reactantStoichCoeff (int32_t handle, int32_t k, int32_t i)
	Stoichiometric coefficient of species k as a reactant in reaction i.

double	kin_productStoichCoeff (int32_t handle, int32_t k, int32_t i)
	Stoichiometric coefficient of species k as a product in reaction i.

int32_t	kin_getFwdRatesOfProgress (int32_t handle, int32_t fwdROPLen, double *fwdROP)
	Return the forward rates of progress of the reactions.

int32_t	kin_getRevRatesOfProgress (int32_t handle, int32_t revROPLen, double *revROP)
	Return the Reverse rates of progress of the reactions.

int32_t	kin_getNetRatesOfProgress (int32_t handle, int32_t netROPLen, double *netROP)
	Net rates of progress.

int32_t	kin_getEquilibriumConstants (int32_t handle, int32_t kcLen, double *kc)
	Return a vector of Equilibrium constants.

int32_t	kin_getFwdRateConstants (int32_t handle, int32_t kfwdLen, double *kfwd)
	Return the forward rate constants.

int32_t	kin_getRevRateConstants (int32_t handle, int32_t krevLen, double *krev, int32_t doIrreversible)
	Return the reverse rate constants.

int32_t	kin_getCreationRates (int32_t handle, int32_t cdotLen, double *cdot)
	Species creation rates [kmol/m^3/s or kmol/m^2/s].

int32_t	kin_getDestructionRates (int32_t handle, int32_t ddotLen, double *ddot)
	Species destruction rates [kmol/m^3/s or kmol/m^2/s].

int32_t	kin_getNetProductionRates (int32_t handle, int32_t wdotLen, double *wdot)
	Species net production rates [kmol/m^3/s or kmol/m^2/s].

double	kin_multiplier (int32_t handle, int32_t i)
	The current value of the multiplier for reaction i.

int32_t	kin_setMultiplier (int32_t handle, int32_t i, double f)
	Set the multiplier for reaction i to f.

int32_t	kin_isReversible (int32_t handle, int32_t i)
	True if reaction i has been declared to be reversible.

int32_t	kin_speciesIndex (int32_t handle, const char *nm)
	This routine will look up a species number based on the input string nm.

int32_t	kin_advanceCoverages (int32_t handle, double tstep)
	Advance the surface coverages in time.

int32_t	kin_getDeltaEnthalpy (int32_t handle, int32_t deltaHLen, double *deltaH)
	Return the vector of values for the reactions change in enthalpy.

int32_t	kin_getDeltaGibbs (int32_t handle, int32_t deltaGLen, double *deltaG)
	Return the vector of values for the reaction Gibbs free energy change.

int32_t	kin_getDeltaEntropy (int32_t handle, int32_t deltaSLen, double *deltaS)
	Return the vector of values for the reactions change in entropy.

int32_t	kin_getDeltaSSEnthalpy (int32_t handle, int32_t deltaHLen, double *deltaH)
	Return the vector of values for the change in the standard state enthalpies of reaction.

int32_t	kin_getDeltaSSGibbs (int32_t handle, int32_t deltaGLen, double *deltaG)
	Return the vector of values for the reaction standard state Gibbs free energy change.

int32_t	kin_getDeltaSSEntropy (int32_t handle, int32_t deltaSLen, double *deltaS)
	Return the vector of values for the change in the standard state entropies for each reaction.

int32_t	kin_del (int32_t handle)
	Destructor; required by some APIs although object is managed by Solution.

int32_t	kin_cabinetSize ()
	Return size of Kinetics storage.

int32_t	kin_parentHandle (int32_t handle)
	Return handle to parent of Kinetics object.

Function Documentation

◆ kin_getType()

int32_t kin_getType	(	int32_t	handle,
		int32_t	bufLen,
		char *	buf
	)

Identifies the Kinetics manager type.

Wraps C++ getter: virtual string Kinetics::kineticsType()

Parameters

	handle	Handle to queried Kinetics object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns: Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 47 of file ctkin.cpp.

◆ kin_nReactions()

int32_t kin_nReactions ( int32_t handle )

Number of reactions in the reaction mechanism.

Wraps C++ getter: size_t Kinetics::nReactions()

Parameters

handle Handle to queried Kinetics object.

Definition at line 59 of file ctkin.cpp.

◆ kin_reaction()

int32_t kin_reaction	(	int32_t	handle,
		int32_t	i
	)

Return the Reaction object for reaction.

Wraps C++ accessor: shared_ptr<Reaction> Kinetics::reaction(size_t)

Uses:

size_t Kinetics::nReactions()

Parameters

handle	Handle to queried Kinetics object.
i	Undocumented.

Returns: Handle to stored Reaction object or -1 for exception handling.

Definition at line 69 of file ctkin.cpp.

◆ kin_nPhases()

int32_t kin_nPhases ( int32_t handle )

The number of phases participating in the reaction mechanism.

Wraps C++ getter: size_t Kinetics::nPhases()

Parameters

handle Handle to queried Kinetics object.

Definition at line 82 of file ctkin.cpp.

◆ kin_phase()

int32_t kin_phase	(	int32_t	handle,
		int32_t	n
	)

Return pointer to phase associated with Kinetics by index.

Wraps C++ accessor: shared_ptr<ThermoPhase> Kinetics::phase(size_t)

Uses:

size_t Kinetics::nPhases()

Parameters

handle	Handle to queried Kinetics object.
n	Index of the ThermoPhase being sought.

Returns: Handle to stored ThermoPhase object or -1 for exception handling.

Definition at line 92 of file ctkin.cpp.

◆ kin_reactionPhase()

int32_t kin_reactionPhase ( int32_t handle )

Return pointer to phase where the reactions occur.

Wraps C++ getter: shared_ptr<ThermoPhase> Kinetics::reactionPhase()

Parameters

handle Handle to queried Kinetics object.

Returns: Handle to stored ThermoPhase object or -1 for exception handling.

Definition at line 105 of file ctkin.cpp.

◆ kin_phaseIndex()

int32_t kin_phaseIndex	(	int32_t	handle,
		const char *	ph
	)

Return the phase index of a phase in the list of phases defined within the object.

Wraps C++ method: size_t Kinetics::phaseIndex(const string&)

Parameters

handle	Handle to queried Kinetics object.
ph	string name of the phase

Definition at line 116 of file ctkin.cpp.

◆ kin_nTotalSpecies()

int32_t kin_nTotalSpecies ( int32_t handle )

The total number of species in all phases participating in the kinetics mechanism.

Wraps C++ getter: size_t Kinetics::nTotalSpecies()

Parameters

handle Handle to queried Kinetics object.

Definition at line 126 of file ctkin.cpp.

◆ kin_reactantStoichCoeff()

double kin_reactantStoichCoeff	(	int32_t	handle,
		int32_t	k,
		int32_t	i
	)

Stoichiometric coefficient of species k as a reactant in reaction i.

Wraps C++ method: virtual double Kinetics::reactantStoichCoeff(size_t, size_t)

Parameters

handle	Handle to queried Kinetics object.
k	kinetic species index
i	reaction index

Definition at line 136 of file ctkin.cpp.

◆ kin_productStoichCoeff()

double kin_productStoichCoeff	(	int32_t	handle,
		int32_t	k,
		int32_t	i
	)

Stoichiometric coefficient of species k as a product in reaction i.

Wraps C++ method: virtual double Kinetics::productStoichCoeff(size_t, size_t)

Parameters

handle	Handle to queried Kinetics object.
k	kinetic species index
i	reaction index

Definition at line 146 of file ctkin.cpp.

◆ kin_getFwdRatesOfProgress()

int32_t kin_getFwdRatesOfProgress	(	int32_t	handle,
		int32_t	fwdROPLen,
		double *	fwdROP
	)

Return the forward rates of progress of the reactions.

Wraps C++ getter: virtual void Kinetics::getFwdRatesOfProgress(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	fwdROPLen	Length of array reserved for fwdROP.
	fwdROP	Output vector containing forward rates of progress of the reactions. Length: nReactions().

Definition at line 156 of file ctkin.cpp.

◆ kin_getRevRatesOfProgress()

int32_t kin_getRevRatesOfProgress	(	int32_t	handle,
		int32_t	revROPLen,
		double *	revROP
	)

Return the Reverse rates of progress of the reactions.

Wraps C++ getter: virtual void Kinetics::getRevRatesOfProgress(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	revROPLen	Length of array reserved for revROP.
	revROP	Output vector containing reverse rates of progress of the reactions. Length: nReactions().

Definition at line 169 of file ctkin.cpp.

◆ kin_getNetRatesOfProgress()

int32_t kin_getNetRatesOfProgress	(	int32_t	handle,
		int32_t	netROPLen,
		double *	netROP
	)

Net rates of progress.

Wraps C++ getter: virtual void Kinetics::getNetRatesOfProgress(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	netROPLen	Length of array reserved for netROP.
	netROP	Output vector of the net ROP. Length: nReactions().

Definition at line 182 of file ctkin.cpp.

◆ kin_getEquilibriumConstants()

int32_t kin_getEquilibriumConstants	(	int32_t	handle,
		int32_t	kcLen,
		double *	kc
	)

Return a vector of Equilibrium constants.

Wraps C++ getter: virtual void Kinetics::getEquilibriumConstants(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	kcLen	Length of array reserved for kc.
	kc	Output vector containing the equilibrium constants. Length: nReactions().

Definition at line 195 of file ctkin.cpp.

◆ kin_getFwdRateConstants()

int32_t kin_getFwdRateConstants	(	int32_t	handle,
		int32_t	kfwdLen,
		double *	kfwd
	)

Return the forward rate constants.

Wraps C++ getter: virtual void Kinetics::getFwdRateConstants(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	kfwdLen	Length of array reserved for kfwd.
	kfwd	Output vector containing the forward reaction rate constants. Length: nReactions().

Definition at line 208 of file ctkin.cpp.

◆ kin_getRevRateConstants()

int32_t kin_getRevRateConstants	(	int32_t	handle,
		int32_t	krevLen,
		double *	krev,
		int32_t	doIrreversible
	)

Return the reverse rate constants.

Wraps C++ method: virtual void Kinetics::getRevRateConstants(double*, bool)

Parameters

	handle	Handle to queried Kinetics object.
[in]	krevLen	Length of array reserved for krev.
	krev	Output vector of reverse rate constants
	doIrreversible	boolean indicating whether irreversible reactions should be included.

Definition at line 221 of file ctkin.cpp.

◆ kin_getCreationRates()

int32_t kin_getCreationRates	(	int32_t	handle,
		int32_t	cdotLen,
		double *	cdot
	)

Species creation rates [kmol/m^3/s or kmol/m^2/s].

Wraps C++ getter: virtual void Kinetics::getCreationRates(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	cdotLen	Length of array reserved for cdot.
	cdot	Output vector of creation rates. Length: m_kk.

Definition at line 233 of file ctkin.cpp.

◆ kin_getDestructionRates()

int32_t kin_getDestructionRates	(	int32_t	handle,
		int32_t	ddotLen,
		double *	ddot
	)

Species destruction rates [kmol/m^3/s or kmol/m^2/s].

Wraps C++ getter: virtual void Kinetics::getDestructionRates(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	ddotLen	Length of array reserved for ddot.
	ddot	Output vector of destruction rates. Length: m_kk.

Definition at line 246 of file ctkin.cpp.

◆ kin_getNetProductionRates()

int32_t kin_getNetProductionRates	(	int32_t	handle,
		int32_t	wdotLen,
		double *	wdot
	)

Species net production rates [kmol/m^3/s or kmol/m^2/s].

Wraps C++ getter: virtual void Kinetics::getNetProductionRates(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	wdotLen	Length of array reserved for wdot.
	wdot	Output vector of net production rates. Length: m_kk.

Definition at line 259 of file ctkin.cpp.

◆ kin_multiplier()

double kin_multiplier	(	int32_t	handle,
		int32_t	i
	)

The current value of the multiplier for reaction i.

Wraps C++ method: double Kinetics::multiplier(size_t)

Parameters

handle	Handle to queried Kinetics object.
i	index of the reaction

Definition at line 272 of file ctkin.cpp.

◆ kin_setMultiplier()

int32_t kin_setMultiplier	(	int32_t	handle,
		int32_t	i,
		double	f
	)

Set the multiplier for reaction i to f.

Wraps C++ method: virtual void Kinetics::setMultiplier(size_t, double)

Parameters

handle	Handle to queried Kinetics object.
i	index of the reaction
f	value of the multiplier.

Definition at line 282 of file ctkin.cpp.

◆ kin_isReversible()

int32_t kin_isReversible	(	int32_t	handle,
		int32_t	i
	)

True if reaction i has been declared to be reversible.

Wraps C++ method: bool Kinetics::isReversible(size_t)

Parameters

handle	Handle to queried Kinetics object.
i	reaction index

Definition at line 293 of file ctkin.cpp.

◆ kin_speciesIndex()

int32_t kin_speciesIndex	(	int32_t	handle,
		const char *	nm
	)

This routine will look up a species number based on the input string nm.

Wraps C++ method: size_t Kinetics::kineticsSpeciesIndex(const string&)

Parameters

handle	Handle to queried Kinetics object.
nm	Input string name of the species

Definition at line 304 of file ctkin.cpp.

◆ kin_advanceCoverages()

int32_t kin_advanceCoverages	(	int32_t	handle,
		double	tstep
	)

Advance the surface coverages in time.

Wraps C++ setter: void InterfaceKinetics::advanceCoverages(double)

Parameters

handle	Handle to queried InterfaceKinetics object.
tstep	Time value to advance the surface coverages

Definition at line 314 of file ctkin.cpp.

◆ kin_getDeltaEnthalpy()

int32_t kin_getDeltaEnthalpy	(	int32_t	handle,
		int32_t	deltaHLen,
		double *	deltaH
	)

Return the vector of values for the reactions change in enthalpy.

Wraps C++ getter: virtual void Kinetics::getDeltaEnthalpy(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	deltaHLen	Length of array reserved for deltaH.
	deltaH	Output vector of deltaH's for reactions Length: nReactions().

Definition at line 325 of file ctkin.cpp.

◆ kin_getDeltaGibbs()

int32_t kin_getDeltaGibbs	(	int32_t	handle,
		int32_t	deltaGLen,
		double *	deltaG
	)

Return the vector of values for the reaction Gibbs free energy change.

Wraps C++ getter: virtual void Kinetics::getDeltaGibbs(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	deltaGLen	Length of array reserved for deltaG.
	deltaG	Output vector of deltaG's for reactions Length: nReactions().

Definition at line 338 of file ctkin.cpp.

◆ kin_getDeltaEntropy()

int32_t kin_getDeltaEntropy	(	int32_t	handle,
		int32_t	deltaSLen,
		double *	deltaS
	)

Return the vector of values for the reactions change in entropy.

Wraps C++ getter: virtual void Kinetics::getDeltaEntropy(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	deltaSLen	Length of array reserved for deltaS.
	deltaS	Output vector of deltaS's for reactions Length: nReactions().

Definition at line 351 of file ctkin.cpp.

◆ kin_getDeltaSSEnthalpy()

int32_t kin_getDeltaSSEnthalpy	(	int32_t	handle,
		int32_t	deltaHLen,
		double *	deltaH
	)

Return the vector of values for the change in the standard state enthalpies of reaction.

Wraps C++ getter: virtual void Kinetics::getDeltaSSEnthalpy(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	deltaHLen	Length of array reserved for deltaH.
	deltaH	Output vector of ss deltaH's for reactions Length: nReactions().

Definition at line 364 of file ctkin.cpp.

◆ kin_getDeltaSSGibbs()

int32_t kin_getDeltaSSGibbs	(	int32_t	handle,
		int32_t	deltaGLen,
		double *	deltaG
	)

Return the vector of values for the reaction standard state Gibbs free energy change.

Wraps C++ getter: virtual void Kinetics::getDeltaSSGibbs(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	deltaGLen	Length of array reserved for deltaG.
	deltaG	Output vector of ss deltaG's for reactions Length: nReactions().

Definition at line 377 of file ctkin.cpp.

◆ kin_getDeltaSSEntropy()

int32_t kin_getDeltaSSEntropy	(	int32_t	handle,
		int32_t	deltaSLen,
		double *	deltaS
	)

Return the vector of values for the change in the standard state entropies for each reaction.

Wraps C++ getter: virtual void Kinetics::getDeltaSSEntropy(double*)

Parameters

	handle	Handle to queried Kinetics object.
[in]	deltaSLen	Length of array reserved for deltaS.
	deltaS	Output vector of ss deltaS's for reactions Length: nReactions().

Definition at line 390 of file ctkin.cpp.

◆ kin_del()

int32_t kin_del ( int32_t handle )

Destructor; required by some APIs although object is managed by Solution.

Wraps C++ noop: undefined

Parameters

handle Handle to Kinetics object.

Returns: Always zero.

Definition at line 403 of file ctkin.cpp.

◆ kin_cabinetSize()

int32_t kin_cabinetSize ( )

Return size of Kinetics storage.

Wraps C++ reserved CLib function: custom code

Returns: Size or -1 for exception handling.

Definition at line 409 of file ctkin.cpp.

◆ kin_parentHandle()

int32_t kin_parentHandle ( int32_t handle )

Return handle to parent of Kinetics object.

Wraps C++ reserved CLib function: custom code

Parameters

handle Handle to queried Kinetics object.

Returns: Parent handle or -1 for exception handling.

Definition at line 421 of file ctkin.cpp.

Detailed Description

Functions

Function Documentation

◆ kin_getType()

◆ kin_nReactions()

◆ kin_reaction()

◆ kin_nPhases()

◆ kin_phase()

◆ kin_reactionPhase()

◆ kin_phaseIndex()

◆ kin_nTotalSpecies()

◆ kin_reactantStoichCoeff()

◆ kin_productStoichCoeff()

◆ kin_getFwdRatesOfProgress()

◆ kin_getRevRatesOfProgress()

◆ kin_getNetRatesOfProgress()

◆ kin_getEquilibriumConstants()

◆ kin_getFwdRateConstants()

◆ kin_getRevRateConstants()

◆ kin_getCreationRates()

◆ kin_getDestructionRates()

◆ kin_getNetProductionRates()

◆ kin_multiplier()

◆ kin_setMultiplier()

◆ kin_isReversible()

◆ kin_speciesIndex()

◆ kin_advanceCoverages()

◆ kin_getDeltaEnthalpy()

◆ kin_getDeltaGibbs()

◆ kin_getDeltaEntropy()

◆ kin_getDeltaSSEnthalpy()

◆ kin_getDeltaSSGibbs()

◆ kin_getDeltaSSEntropy()

◆ kin_del()

◆ kin_cabinetSize()

◆ kin_parentHandle()