ctmix.h File Reference

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

Detailed Description

CTMIX - Generated CLib Cantera interface library.

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

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

Go to the source code of this file.

Functions
int32_t	mix_new ()
	Instantiate MultiPhase object using default constructor.
int32_t	mix_addPhase (int32_t handle, int32_t p, double moles)
	Add a phase to the mixture.
int32_t	mix_init (int32_t handle)
	Process phases and build atomic composition array.
int32_t	mix_updatePhases (int32_t handle)
	Set the states of the phase objects to the locally-stored state within this MultiPhase object.
int32_t	mix_nElements (int32_t handle)
	Number of elements.
int32_t	mix_elementIndex (int32_t handle, const char *name)
	Returns the index of the element with name.
int32_t	mix_nSpecies (int32_t handle)
	Number of species, summed over all phases.
int32_t	mix_speciesIndex (int32_t handle, int32_t k, int32_t p)
	Return the global index of the species belonging to phase number.
double	mix_temperature (int32_t handle)
	Temperature [K].
int32_t	mix_setTemperature (int32_t handle, const double T)
	Set the temperature [K].
double	mix_minTemp (int32_t handle)
	Minimum temperature for which all solution phases have valid thermo data.
double	mix_maxTemp (int32_t handle)
	Maximum temperature for which all solution phases have valid thermo data.
double	mix_charge (int32_t handle)
	Total charge summed over all phases (Coulombs).
double	mix_phaseCharge (int32_t handle, int32_t p)
	Charge (Coulombs) of phase with index.
double	mix_pressure (int32_t handle)
	Pressure [Pa].
int32_t	mix_setPressure (int32_t handle, double P)
	Set the pressure [Pa].
double	mix_nAtoms (int32_t handle, const int32_t kGlob, const int32_t mGlob)
	Returns the Number of atoms of global element.
int32_t	mix_nPhases (int32_t handle)
	Number of phases.
double	mix_phaseMoles (int32_t handle, const int32_t n)
	Return the number of moles in phase n.
int32_t	mix_setPhaseMoles (int32_t handle, const int32_t n, const double moles)
	Set the number of moles of phase with index n.
int32_t	mix_setMoles (int32_t handle, int32_t nLen, const double *n)
	Sets all of the global species mole numbers.
int32_t	mix_setMolesByName (int32_t handle, const char *x)
	Set the moles via a string containing their names.
double	mix_speciesMoles (int32_t handle, int32_t kGlob)
	Returns the moles of global species.
double	mix_elementMoles (int32_t handle, int32_t m)
	Total moles of global element.
int32_t	mix_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.
int32_t	mix_getChemPotentials (int32_t handle, int32_t muLen, double *mu)
	Returns a vector of Chemical potentials.
double	mix_enthalpy (int32_t handle)
	The enthalpy of the mixture [J].
double	mix_entropy (int32_t handle)
	The entropy of the mixture [J/K].
double	mix_gibbs (int32_t handle)
	The Gibbs function of the mixture [J].
double	mix_cp (int32_t handle)
	Heat capacity at constant pressure [J/K].
double	mix_volume (int32_t handle)
	The total mixture volume [m^3].
int32_t	mix_speciesPhaseIndex (int32_t handle, const int32_t kGlob)
	Returns the phase index of the Kth "global" species.
double	mix_moleFraction (int32_t handle, const int32_t kGlob)
	Returns the mole fraction of global species k.
int32_t	mix_del (int32_t handle)
	Delete MultiPhase object.
int32_t	mix_cabinetSize ()
	Return size of MultiPhase storage.
int32_t	mix_parentHandle (int32_t handle)
	Return handle to parent of MultiPhase object.