ctkin.h File Reference

CTKIN - Generated CLib Cantera interface library. More...

Detailed Description

CTKIN - Generated CLib Cantera interface library.

Generated CLib API for Cantera's Kinetics class.

This library of functions is designed to encapsulate Cantera functionality and make it available for use in languages and applications other than C++. A set of library functions is provided that are declared "extern C". All Cantera objects are stored and referenced by integers - no pointers are passed to or from the calling application.

This file was generated by sourcegen. It will be re-generated by the Cantera build process. Do not manually edit.

Warning

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

Definition in file ctkin.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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.