Detailed Description

CT - Generated CLib Cantera interface library.

The main library of the generated CLib API contains Cantera service functions.

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 interfaces/clib/include/cantera_clib/ct.h.

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

Go to the source code of this file.

Functions
int32_t	ct_version (int32_t bufLen, char *buf)
	Returns the Cantera version.

int32_t	ct_gitCommit (int32_t bufLen, char *buf)
	Returns the hash of the git commit from which Cantera was compiled, if known.

int32_t	ct_usesHDF5 ()
	Returns true if Cantera was compiled with C++ `HDF5` support.

int32_t	ct_addDataDirectory (const char *dir)
	Add a directory to the data file search path.

int32_t	ct_getDataDirectories (const char sep, int32_t bufLen, char buf)
	Get the Cantera data directories.

int32_t	ct_findInputFile (const char name, int32_t bufLen, char buf)
	Find an input file.

int32_t	ct_suppressDeprecationWarnings ()
	Globally disable printing of deprecation warnings.

int32_t	ct_makeDeprecationWarningsFatal ()
	Turns deprecation warnings into exceptions.

int32_t	ct_suppressWarnings ()
	Globally disable printing of (user) warnings.

int32_t	ct_warningsSuppressed ()
	Returns `true` if warnings should be suppressed.

int32_t	ct_makeWarningsFatal ()
	Turns Cantera warnings into exceptions.

int32_t	ct_suppressThermoWarnings (int32_t suppress)
	Globally disable printing of warnings about problematic thermo data, such as NASA polynomials with discontinuities at the midpoint temperature.

int32_t	ct_useLegacyRateConstants (int32_t legacy)
	Set definition used for rate constant calculation.

int32_t	ct_appdelete ()
	Delete and free all memory associated with the application.

double	ct_Avogadro ()
	Avogadro's Number.

double	ct_Boltzmann ()
	Boltzmann constant.

double	ct_Planck ()
	Planck constant.

double	ct_ElectronCharge ()
	Elementary charge.

double	ct_lightSpeed ()
	Speed of Light in a vacuum.

double	ct_OneAtm ()
	One atmosphere [Pa].

double	ct_OneBar ()
	One bar [Pa].

double	ct_fineStructureConstant ()
	Fine structure constant.

double	ct_ElectronMass ()
	Electron Mass.

double	ct_GasConstant ()
	Universal Gas Constant.

double	ct_StefanBoltz ()
	Stefan-Boltzmann constant.

double	ct_Faraday ()
	Faraday constant.

double	ct_permeability0 ()
	Permeability of free space.

double	ct_epsilon0 ()
	Permittivity of free space.

int32_t	ct_getCanteraError (int32_t bufLen, char *buf)
	Get Cantera error.

int32_t	ct_setLogCallback (LogCallback writer)
	Set Logger callback.

int32_t	ct_writeLog (const char *msg)
	Write a message to the logger.

int32_t	ct_resetStorage ()
	Delete all objects and erase mapping.

Detailed Description

Functions