ct Library

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

Collaboration diagram for ct Library:

Detailed Description

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

Warning

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

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.

Function Documentation

ct_version()

int32_t ct_version	(	int32_t	bufLen,
		char *	buf
	)

Returns the Cantera version.

Wraps C++ function: string version()

Parameters

[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 92 of file ct.cpp.

ct_gitCommit()

int32_t ct_gitCommit	(	int32_t	bufLen,
		char *	buf
	)

Returns the hash of the git commit from which Cantera was compiled, if known.

Wraps C++ function: string gitCommit()

Parameters

[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 104 of file ct.cpp.

ct_usesHDF5()

int32_t ct_usesHDF5

(

)

Returns true if Cantera was compiled with C++ HDF5 support.

Wraps C++ function: bool usesHDF5()

Definition at line 116 of file ct.cpp.

ct_addDataDirectory()

int32_t ct_addDataDirectory

(

const char *

dir

)

Add a directory to the data file search path.

Wraps C++ function: void addDataDirectory(const string&)

Parameters

dir	String name for the directory to be added to the search path

Definition at line 127 of file ct.cpp.

ct_getDataDirectories()

int32_t ct_getDataDirectories	(	const char *	sep,
		int32_t	bufLen,
		char *	buf
	)

Get the Cantera data directories.

Wraps C++ function: string getDataDirectories(const string&)

Parameters

	sep	Separator to use between directories in the string
[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 138 of file ct.cpp.

ct_findInputFile()

int32_t ct_findInputFile	(	const char *	name,
		int32_t	bufLen,
		char *	buf
	)

Find an input file.

Wraps C++ function: string findInputFile(const string&)

Parameters

	name	Name of the input file to be searched for
[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 150 of file ct.cpp.

ct_suppressDeprecationWarnings()

int32_t ct_suppressDeprecationWarnings

(

)

Globally disable printing of deprecation warnings.

Wraps C++ function: void suppress_deprecation_warnings()

Definition at line 162 of file ct.cpp.

ct_makeDeprecationWarningsFatal()

int32_t ct_makeDeprecationWarningsFatal

(

)

Turns deprecation warnings into exceptions.

Wraps C++ function: void make_deprecation_warnings_fatal()

Definition at line 173 of file ct.cpp.

ct_suppressWarnings()

int32_t ct_suppressWarnings

(

)

Globally disable printing of (user) warnings.

Wraps C++ function: void suppress_warnings()

Definition at line 184 of file ct.cpp.

ct_warningsSuppressed()

int32_t ct_warningsSuppressed

(

)

Returns true if warnings should be suppressed.

Wraps C++ function: bool warnings_suppressed()

Definition at line 195 of file ct.cpp.

ct_makeWarningsFatal()

int32_t ct_makeWarningsFatal

(

)

Turns Cantera warnings into exceptions.

Wraps C++ function: void make_warnings_fatal()

Definition at line 206 of file ct.cpp.

ct_suppressThermoWarnings()

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.

Wraps C++ function: void suppress_thermo_warnings(bool)

Parameters

suppress

Undocumented.

Definition at line 217 of file ct.cpp.

ct_useLegacyRateConstants()

int32_t ct_useLegacyRateConstants

(

int32_t

legacy

)

Set definition used for rate constant calculation.

Wraps C++ function: void use_legacy_rate_constants(bool)

Parameters

legacy

Undocumented.

Definition at line 229 of file ct.cpp.

ct_appdelete()

int32_t ct_appdelete

(

)

Delete and free all memory associated with the application.

Wraps C++ function: void appdelete()

Definition at line 241 of file ct.cpp.

ct_Avogadro()

double ct_Avogadro

(

)

Avogadro's Number.

Wraps C++ variable-getter: const double Avogadro

Definition at line 252 of file ct.cpp.

ct_Boltzmann()

double ct_Boltzmann

(

)

Boltzmann constant.

Wraps C++ variable-getter: const double Boltzmann

Definition at line 262 of file ct.cpp.

ct_Planck()

double ct_Planck

(

)

Planck constant.

Wraps C++ variable-getter: const double Planck

Definition at line 272 of file ct.cpp.

ct_ElectronCharge()

double ct_ElectronCharge

(

)

Elementary charge.

Wraps C++ variable-getter: const double ElectronCharge

Definition at line 282 of file ct.cpp.

ct_lightSpeed()

double ct_lightSpeed

(

)

Speed of Light in a vacuum.

Wraps C++ variable-getter: const double lightSpeed

Definition at line 292 of file ct.cpp.

ct_OneAtm()

double ct_OneAtm

(

)

One atmosphere [Pa].

Wraps C++ variable-getter: const double OneAtm

Definition at line 302 of file ct.cpp.

ct_OneBar()

double ct_OneBar

(

)

One bar [Pa].

Wraps C++ variable-getter: const double OneBar

Definition at line 312 of file ct.cpp.

ct_fineStructureConstant()

double ct_fineStructureConstant

(

)

Fine structure constant.

Wraps C++ variable-getter: const double fineStructureConstant

Definition at line 322 of file ct.cpp.

ct_ElectronMass()

double ct_ElectronMass

(

)

Electron Mass.

Wraps C++ variable-getter: const double ElectronMass

Definition at line 332 of file ct.cpp.

ct_GasConstant()

double ct_GasConstant

(

)

Universal Gas Constant.

Wraps C++ variable-getter: const double GasConstant

Definition at line 342 of file ct.cpp.

ct_StefanBoltz()

double ct_StefanBoltz

(

)

Stefan-Boltzmann constant.

Wraps C++ variable-getter: const double StefanBoltz

Definition at line 352 of file ct.cpp.

ct_Faraday()

double ct_Faraday

(

)

Faraday constant.

Wraps C++ variable-getter: const double Faraday

Definition at line 362 of file ct.cpp.

ct_permeability0()

double ct_permeability0

(

)

Permeability of free space.

Wraps C++ variable-getter: const double permeability_0

Definition at line 372 of file ct.cpp.

ct_epsilon0()

double ct_epsilon0

(

)

Permittivity of free space.

Wraps C++ variable-getter: const double epsilon_0

Definition at line 382 of file ct.cpp.

ct_getCanteraError()

int32_t ct_getCanteraError	(	int32_t	bufLen,
		char *	buf
	)

Get Cantera error.

Wraps C++ function: custom code

Parameters

bufLen	Length of reserved array.
buf	String containing Cantera error.

Returns

Actual length of string or -1 for exception handling.

Definition at line 392 of file ct.cpp.

ct_setLogCallback()

int32_t ct_setLogCallback

(

LogCallback

writer

)

Set Logger callback.

Wraps C++ function: custom code

Parameters

writer

Callback that is invoked to produce log output.

Definition at line 406 of file ct.cpp.

ct_writeLog()

int32_t ct_writeLog

(

const char *

msg

)

Write a message to the logger.

Wraps C++ function: void writelog_direct(const string&)

Parameters

msg	C++ string to be written to the logger

Definition at line 420 of file ct.cpp.

ct_resetStorage()

int32_t ct_resetStorage

(

)

Delete all objects and erase mapping.

Wraps C++ reserved CLib function: custom code

Returns

Zero if successful or -1 for exception handling.

Definition at line 431 of file ct.cpp.