ctsol.h File Reference

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

Detailed Description

CTSOL - Generated CLib Cantera interface library.

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

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

Go to the source code of this file.

Functions
int32_t	sol_newSolution (const char *infile, const char *name, const char *transport)
	Create and initialize a new Solution manager from an input file.
int32_t	sol_newInterface (const char *infile, const char *name, int32_t adjacentLen, const int32_t *adjacent)
	Create and initialize a new Interface from an input file.
int32_t	sol_del (int32_t handle)
	Delete Solution object.
int32_t	sol_name (int32_t handle, int32_t bufLen, char *buf)
	Return the name of this Solution object.
int32_t	sol_setName (int32_t handle, const char *name)
	Set the name of this Solution object.
int32_t	sol_thermo (int32_t handle)
	Accessor for the ThermoPhase pointer.
int32_t	sol_kinetics (int32_t handle)
	Accessor for the Kinetics pointer.
int32_t	sol_transport (int32_t handle)
	Accessor for the Transport pointer.
int32_t	sol_transportModel (int32_t handle, int32_t bufLen, char *buf)
	Retrieve transport model name.
int32_t	sol_setTransportModel (int32_t handle, const char *model)
	Set the Transport object by name.
int32_t	sol_nAdjacent (int32_t handle)
	Get the number of adjacent phases.
int32_t	sol_adjacent (int32_t handle, int32_t i)
	Get the Solution object for an adjacent phase by index.
int32_t	sol_adjacentName (int32_t handle, int32_t i, int32_t bufLen, char *buf)
	Get the name of an adjacent phase by index.
int32_t	sol_source (int32_t handle, int32_t bufLen, char *buf)
	Retrieve source used for object creation; usually an input file name.
int32_t	sol_cabinetSize ()
	Return size of Solution storage.