interfaces/clib/include/cantera_clib/ct.h

Go to the documentation of this file.

/**
 *  CT - Generated CLib %Cantera interface library.
 *
 *  @file ct.h
 *
 *  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.
 */
 
// This file is part of Cantera. See License.txt in the top-level directory or
// at https://cantera.org/license.txt for license and copyright information.
 
#ifndef CT_H
#define CT_H
 
#include <stdint.h>  // for 32-bit int32_t / 64-bit int64_t
#include "cantera_clib/clib_defs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIct ct Library
     *  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.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIct
     *  @{
     */
 
    /**
     *  Returns the Cantera version.
     *
     *  Wraps C++ function: `string version()`
     *
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t ct_version(int32_t bufLen, char* buf);
 
    /**
     *  Returns the hash of the git commit from which Cantera was compiled, if known.
     *
     *  Wraps C++ function: `string gitCommit()`
     *
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t ct_gitCommit(int32_t bufLen, char* buf);
 
    /**
     *  Returns true if Cantera was compiled with C++ `HDF5` support.
     *
     *  Wraps C++ function: `bool usesHDF5()`
     */
    int32_t ct_usesHDF5();
 
    /**
     *  Add a directory to the data file search path.
     *
     *  Wraps C++ function: `void addDataDirectory(const string&)`
     *
     *  @param dir          String name for the directory to be added to the search path
     */
    int32_t ct_addDataDirectory(const char* dir);
 
    /**
     *  Get the Cantera data directories.
     *
     *  Wraps C++ function: `string getDataDirectories(const string&)`
     *
     *  @param sep          Separator to use between directories in the string
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t ct_getDataDirectories(const char* sep, int32_t bufLen, char* buf);
 
    /**
     *  Find an input file.
     *
     *  Wraps C++ function: `string findInputFile(const string&)`
     *
     *  @param name         Name of the input file to be searched for
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t ct_findInputFile(const char* name, int32_t bufLen, char* buf);
 
    /**
     *  Globally disable printing of deprecation warnings.
     *
     *  Wraps C++ function: `void suppress_deprecation_warnings()`
     */
    int32_t ct_suppressDeprecationWarnings();
 
    /**
     *  Turns deprecation warnings into exceptions.
     *
     *  Wraps C++ function: `void make_deprecation_warnings_fatal()`
     */
    int32_t ct_makeDeprecationWarningsFatal();
 
    /**
     *  Globally disable printing of (user) warnings.
     *
     *  Wraps C++ function: `void suppress_warnings()`
     */
    int32_t ct_suppressWarnings();
 
    /**
     *  Returns `true` if warnings should be suppressed.
     *
     *  Wraps C++ function: `bool warnings_suppressed()`
     */
    int32_t ct_warningsSuppressed();
 
    /**
     *  Turns Cantera warnings into exceptions.
     *
     *  Wraps C++ function: `void make_warnings_fatal()`
     */
    int32_t ct_makeWarningsFatal();
 
    /**
     *  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)`
     *
     *  @param suppress     Undocumented.
     */
    int32_t ct_suppressThermoWarnings(int32_t suppress);
 
    /**
     *  Set definition used for rate constant calculation.
     *
     *  Wraps C++ function: `void use_legacy_rate_constants(bool)`
     *
     *  @param legacy       Undocumented.
     */
    int32_t ct_useLegacyRateConstants(int32_t legacy);
 
    /**
     *  Delete and free all memory associated with the application.
     *
     *  Wraps C++ function: `void appdelete()`
     */
    int32_t ct_appdelete();
 
    /**
     *  Avogadro's Number
     *
     *  Wraps C++ variable-getter: `const double Avogadro`
     */
    double ct_Avogadro();
 
    /**
     *  Boltzmann constant
     *
     *  Wraps C++ variable-getter: `const double Boltzmann`
     */
    double ct_Boltzmann();
 
    /**
     *  Planck constant
     *
     *  Wraps C++ variable-getter: `const double Planck`
     */
    double ct_Planck();
 
    /**
     *  Elementary charge
     *
     *  Wraps C++ variable-getter: `const double ElectronCharge`
     */
    double ct_ElectronCharge();
 
    /**
     *  Speed of Light in a vacuum
     *
     *  Wraps C++ variable-getter: `const double lightSpeed`
     */
    double ct_lightSpeed();
 
    /**
     *  One atmosphere [Pa].
     *
     *  Wraps C++ variable-getter: `const double OneAtm`
     */
    double ct_OneAtm();
 
    /**
     *  One bar [Pa].
     *
     *  Wraps C++ variable-getter: `const double OneBar`
     */
    double ct_OneBar();
 
    /**
     *  Fine structure constant
     *
     *  Wraps C++ variable-getter: `const double fineStructureConstant`
     */
    double ct_fineStructureConstant();
 
    /**
     *  Electron Mass
     *
     *  Wraps C++ variable-getter: `const double ElectronMass`
     */
    double ct_ElectronMass();
 
    /**
     *  Universal Gas Constant
     *
     *  Wraps C++ variable-getter: `const double GasConstant`
     */
    double ct_GasConstant();
 
    /**
     *  Stefan-Boltzmann constant
     *
     *  Wraps C++ variable-getter: `const double StefanBoltz`
     */
    double ct_StefanBoltz();
 
    /**
     *  Faraday constant
     *
     *  Wraps C++ variable-getter: `const double Faraday`
     */
    double ct_Faraday();
 
    /**
     *  Permeability of free space
     *
     *  Wraps C++ variable-getter: `const double permeability_0`
     */
    double ct_permeability0();
 
    /**
     *  Permittivity of free space
     *
     *  Wraps C++ variable-getter: `const double epsilon_0`
     */
    double ct_epsilon0();
 
    /**
     *  Get Cantera error.
     *
     *  Wraps C++ function: `custom code`
     *
     *  @param bufLen       Length of reserved array.
     *  @param buf          String containing Cantera error.
     *  @returns            Actual length of string or -1 for exception handling.
     */
    int32_t ct_getCanteraError(int32_t bufLen, char* buf);
 
    /**
     *  Set Logger callback.
     *
     *  Wraps C++ function: `custom code`
     *
     *  @param writer       Callback that is invoked to produce log output.
     */
    int32_t ct_setLogCallback(LogCallback writer);
 
    /**
     *  Write a message to the logger.
     *
     *  Wraps C++ function: `void writelog_direct(const string&)`
     *
     *  @param msg          C++ string to be written to the logger
     */
    int32_t ct_writeLog(const char* msg);
 
    /**
     *  Delete all objects and erase mapping.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Zero if successful or -1 for exception handling.
     */
    int32_t ct_resetStorage();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CT_H