cantera/doc/sphinx/cxx-guide/headers.rst
Ray Speth 14b9454819 [C++] Clean up of top-level headers
These headers should only include general functionality, i.e. base classes and
factory methods. Users working directly with derived types can include the
relevant headers directly.

Deprecate some top-level headers which are not really useful.
2016-05-14 16:10:10 -04:00

41 lines
1 KiB
ReStructuredText

****************
C++ Header Files
****************
Cantera provides some header files designed for use in C++ application
programs. These are designed to include those portions of Cantera needed for
particular types of calculations.
These headers are designed for use in C++ application programs, and are not
included by the Cantera core. The headers and their functions are:
``IdealGasMix.h``
Provides class :ct:`IdealGasMix`.
``Interface.h``
Provides class :ct:`Interface`.
``integrators.h``
ODE Integrators.
``kinetics.h``
Base kinetics classes and functions for creating :ct:`Kinetics` objects from
input files.
``onedim.h``
One-dimensional reacting flows.
``reactionpaths.h``
Reaction path diagrams.
``thermo.h``
Base thermodynamic classes and functions for creating :ct:`ThermoPhase`
objects from input files.
``transport.h``
Base transport property classes and functions for creating :ct:`Transport`
objects from input files.
``zerodim.h``
Zero-dimensional reactor networks.