ctthermo.h File Reference

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

Detailed Description

CTTHERMO - Generated CLib Cantera interface library.

Generated CLib API for Cantera's ThermoPhase 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 ctthermo.h.

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

Go to the source code of this file.

Functions
int32_t	thermo_name (int32_t handle, int32_t bufLen, char *buf)
	Return the name of the phase.
int32_t	thermo_setName (int32_t handle, const char *nm)
	Sets the string name for the phase.
int32_t	thermo_type (int32_t handle, int32_t bufLen, char *buf)
	String indicating the thermodynamic model implemented.
int32_t	thermo_nElements (int32_t handle)
	Number of elements.
int32_t	thermo_nSpecies (int32_t handle)
	Returns the number of species in the phase.
double	thermo_temperature (int32_t handle)
	Temperature (K).
int32_t	thermo_setTemperature (int32_t handle, double temp)
	Set the internally stored temperature of the phase (K).
double	thermo_pressure (int32_t handle)
	Return the thermodynamic pressure (Pa).
int32_t	thermo_setPressure (int32_t handle, double p)
	Set the internally stored pressure (Pa) at constant temperature and composition.
double	thermo_density (int32_t handle)
	Density (kg/m^3).
int32_t	thermo_setDensity (int32_t handle, const double density_)
	Set the internally stored density (kg/m^3) of the phase.
double	thermo_molarDensity (int32_t handle)
	Molar density (kmol/m^3).
double	thermo_meanMolecularWeight (int32_t handle)
	The mean molecular weight.
double	thermo_moleFraction (int32_t handle, int32_t k)
	Return the mole fraction of a single species.
double	thermo_massFraction (int32_t handle, int32_t k)
	Return the mass fraction of a single species.
int32_t	thermo_getMoleFractions (int32_t handle, int32_t xLen, double *x)
	Get the species mole fraction vector.
int32_t	thermo_getMassFractions (int32_t handle, int32_t yLen, double *y)
	Get the species mass fractions.
int32_t	thermo_setMoleFractions (int32_t handle, int32_t xLen, const double *x)
	Set the mole fractions to the specified values.
int32_t	thermo_setMassFractions (int32_t handle, int32_t yLen, const double *y)
	Set the mass fractions to the specified values and normalize them.
int32_t	thermo_setMoleFractionsByName (int32_t handle, const char *x)
	Set the mole fractions of a group of species by name.
int32_t	thermo_setMassFractionsByName (int32_t handle, const char *x)
	Set the species mass fractions by name.
int32_t	thermo_atomicWeights (int32_t handle, int32_t bufLen, double *buf)
	Return a read-only reference to the vector of atomic weights.
int32_t	thermo_getMolecularWeights (int32_t handle, int32_t weightsLen, double *weights)
	Copy the vector of molecular weights into array weights.
int32_t	thermo_getCharges (int32_t handle, int32_t chargesLen, double *charges)
	Copy the vector of species charges into array charges.
int32_t	thermo_elementName (int32_t handle, int32_t m, int32_t bufLen, char *buf)
	Name of the element with index m.
int32_t	thermo_speciesName (int32_t handle, int32_t k, int32_t bufLen, char *buf)
	Name of the species with index k.
int32_t	thermo_elementIndex (int32_t handle, const char *name)
	Return the index of element named 'name'.
int32_t	thermo_speciesIndex (int32_t handle, const char *name)
	Returns the index of a species named 'name' within the Phase object.
double	thermo_nAtoms (int32_t handle, int32_t k, int32_t m)
	Number of atoms of element.
int32_t	thermo_addElement (int32_t handle, const char *symbol, double weight, int32_t atomicNumber, double entropy298, int32_t elem_type)
	Add an element.
double	thermo_refPressure (int32_t handle)
	Returns the reference pressure in Pa.
double	thermo_minTemp (int32_t handle, int32_t k)
	Minimum temperature for which the thermodynamic data for the species or phase are valid.
double	thermo_maxTemp (int32_t handle, int32_t k)
	Maximum temperature for which the thermodynamic data for the species are valid.
double	thermo_enthalpy_mole (int32_t handle)
	Molar enthalpy.
double	thermo_enthalpy_mass (int32_t handle)
	Specific enthalpy.
double	thermo_entropy_mole (int32_t handle)
	Molar entropy.
double	thermo_entropy_mass (int32_t handle)
	Specific entropy.
double	thermo_intEnergy_mole (int32_t handle)
	Molar internal energy.
double	thermo_intEnergy_mass (int32_t handle)
	Specific internal energy.
double	thermo_gibbs_mole (int32_t handle)
	Molar Gibbs function.
double	thermo_gibbs_mass (int32_t handle)
	Specific Gibbs function.
double	thermo_cp_mole (int32_t handle)
	Molar heat capacity at constant pressure.
double	thermo_cp_mass (int32_t handle)
	Specific heat at constant pressure.
double	thermo_cv_mole (int32_t handle)
	Molar heat capacity at constant volume.
double	thermo_cv_mass (int32_t handle)
	Specific heat at constant volume.
int32_t	thermo_getChemPotentials (int32_t handle, int32_t muLen, double *mu)
	Get the species chemical potentials.
int32_t	thermo_getElectrochemPotentials (int32_t handle, int32_t muLen, double *mu)
	Get the species electrochemical potentials.
double	thermo_electricPotential (int32_t handle)
	Returns the electric potential of this phase (V).
int32_t	thermo_setElectricPotential (int32_t handle, double v)
	Set the electric potential of this phase (V).
double	thermo_thermalExpansionCoeff (int32_t handle)
	Return the volumetric thermal expansion coefficient.
double	thermo_isothermalCompressibility (int32_t handle)
	Returns the isothermal compressibility.
int32_t	thermo_getPartialMolarEnthalpies (int32_t handle, int32_t hbarLen, double *hbar)
	Returns an array of partial molar enthalpies for the species in the mixture.
int32_t	thermo_getPartialMolarEntropies (int32_t handle, int32_t sbarLen, double *sbar)
	Returns an array of partial molar entropies of the species in the solution.
int32_t	thermo_getPartialMolarIntEnergies (int32_t handle, int32_t ubarLen, double *ubar)
	Return an array of partial molar internal energies for the species in the mixture.
int32_t	thermo_getPartialMolarCp (int32_t handle, int32_t cpbarLen, double *cpbar)
	Return an array of partial molar heat capacities for the species in the mixture.
int32_t	thermo_getPartialMolarVolumes (int32_t handle, int32_t vbarLen, double *vbar)
	Return an array of partial molar volumes for the species in the mixture.
int32_t	thermo_setState_TPX (int32_t handle, double t, double p, int32_t xLen, const double *x)
	Set the temperature (K), pressure (Pa), and mole fractions.
int32_t	thermo_setState_TPY (int32_t handle, double t, double p, int32_t yLen, const double *y)
	Set the internally stored temperature (K), pressure (Pa), and mass fractions of the phase.
int32_t	thermo_setState_TP (int32_t handle, double t, double p)
	Set the temperature (K) and pressure (Pa)
int32_t	thermo_setState_TD (int32_t handle, double t, double rho)
	Set the internally stored temperature (K) and density (kg/m^3)
int32_t	thermo_setState_DP (int32_t handle, double rho, double p)
	Set the density (kg/m**3) and pressure (Pa) at constant composition.
int32_t	thermo_setState_HP (int32_t handle, double h, double p)
	Set the internally stored specific enthalpy (J/kg) and pressure (Pa) of the phase.
int32_t	thermo_setState_UV (int32_t handle, double u, double v)
	Set the specific internal energy (J/kg) and specific volume (m^3/kg).
int32_t	thermo_setState_SV (int32_t handle, double s, double v)
	Set the specific entropy (J/kg/K) and specific volume (m^3/kg).
int32_t	thermo_setState_SP (int32_t handle, double s, double p)
	Set the specific entropy (J/kg/K) and pressure (Pa).
int32_t	thermo_setState_ST (int32_t handle, double s, double t)
	Set the specific entropy (J/kg/K) and temperature (K).
int32_t	thermo_setState_TV (int32_t handle, double t, double v)
	Set the temperature (K) and specific volume (m^3/kg).
int32_t	thermo_setState_PV (int32_t handle, double p, double v)
	Set the pressure (Pa) and specific volume (m^3/kg).
int32_t	thermo_setState_UP (int32_t handle, double u, double p)
	Set the specific internal energy (J/kg) and pressure (Pa).
int32_t	thermo_setState_VH (int32_t handle, double v, double h)
	Set the specific volume (m^3/kg) and the specific enthalpy (J/kg)
int32_t	thermo_setState_TH (int32_t handle, double t, double h)
	Set the temperature (K) and the specific enthalpy (J/kg)
int32_t	thermo_setState_SH (int32_t handle, double s, double h)
	Set the specific entropy (J/kg/K) and the specific enthalpy (J/kg)
int32_t	thermo_equilibrate (int32_t handle, const char *XY, const char *solver, double rtol, int32_t max_steps, int32_t max_iter, int32_t estimate_equil)
	Equilibrate a ThermoPhase object.
double	thermo_critTemperature (int32_t handle)
	Critical temperature (K).
double	thermo_critPressure (int32_t handle)
	Critical pressure (Pa).
double	thermo_critDensity (int32_t handle)
	Critical density (kg/m3).
double	thermo_vaporFraction (int32_t handle)
	Return the fraction of vapor at the current conditions.
double	thermo_satTemperature (int32_t handle, double p)
	Return the saturation temperature given the pressure.
double	thermo_satPressure (int32_t handle, double t)
	Return the saturation pressure given the temperature.
int32_t	thermo_setState_Psat (int32_t handle, double p, double x)
	Set the state to a saturated system at a particular pressure.
int32_t	thermo_setState_Tsat (int32_t handle, double t, double x)
	Set the state to a saturated system at a particular temperature.
int32_t	surf_getCoverages (int32_t handle, int32_t thetaLen, double *theta)
	Return a vector of surface coverages.
int32_t	surf_setCoverages (int32_t handle, int32_t thetaLen, const double *theta)
	Set the surface site fractions to a specified state.
int32_t	thermo_getConcentrations (int32_t handle, int32_t cLen, double *c)
	Get the species concentrations (kmol/m^3).
int32_t	thermo_setConcentrations (int32_t handle, int32_t concLen, const double *conc)
	Set the concentrations to the specified values within the phase.
double	surf_siteDensity (int32_t handle)
	Returns the site density.
int32_t	surf_setSiteDensity (int32_t handle, double n0)
	Set the site density of the surface phase (kmol m-2)
int32_t	surf_setCoveragesByName (int32_t handle, const char *cov)
	Set the coverages from a string of colon-separated name:value pairs.
int32_t	thermo_report (int32_t handle, int32_t show_thermo, double threshold, int32_t bufLen, char *buf)
	returns a summary of the state of the phase as a string
int32_t	thermo_print (int32_t handle, int32_t showThermo, double threshold)
	Print a summary of the state of the phase to the logger.
int32_t	thermo_del (int32_t handle)
	Destructor; required by some APIs although object is managed by Solution.
int32_t	thermo_cabinetSize ()
	Return size of ThermoPhase storage.
int32_t	thermo_parentHandle (int32_t handle)
	Return handle to parent of ThermoPhase object.