Files
cantera/interfaces/clib
Ingmar Schoegl 8a0b024970 [sourcegen] Remove _auto from header configuration
While '_auto' was useful for testing purposes, it is no longer needed.
All relevant files start with 'ct', which is sufficient.
2025-10-18 23:52:00 -05:00
..
2025-06-04 13:24:20 -05:00
2025-06-06 15:02:03 -04:00

@page CAPImain Generated C Interface

Generated C Interface (CLib)

@remark The generated CLib API is a re-implementation of %Cantera's legacy C interface. It replaces the legacy CLib API starting in %Cantera 3.2.

@remark While many function names remain unchanged, the generated CLib is not meant to be a drop-in replacement. Breaking changes involve improved consistency with the C++ code base in terms of nomenclature and function/method signatures.

The generated C interface consists of a set of libraries that are designed to encapsulate %Cantera functionality and to make it available for use in languages and applications other than C++. Each library provides functions that are declared extern "C". All %Cantera objects are stored and referenced by integers - no pointers are passed to or from the calling application.

CLib Libraries

@warning The generated CLib API is an experimental part of %Cantera and may be changed without notice.

The @ref CAPIindex page provides a list of currently available libraries.

Code Generation

The generated CLib interface is installed by default if %Cantera was built with default options. A test suite ensures that code performs as expected:

scons test-clib
scons test-clib-demo