2528df0f75
These changes make it unnecessary to copy header files around during the build process, which tends to confuse IDEs and debuggers. The headers which comprise Cantera's external C++ interface are now in the 'include' directory. All of the samples and demos are now in the 'samples' subdirectory.
89 lines
3.7 KiB
Text
89 lines
3.7 KiB
Text
/**
|
|
|
|
\page start Getting Started with Cantera in C++
|
|
|
|
\section cxxsimpledemo A Very Simple C++ Program
|
|
|
|
A short C++ program that uses %Cantera is shown below. This program
|
|
reads in a specification of a gas mixture from an input file, and then
|
|
builds a new object representing the mixture. It then sets the
|
|
thermodynamic state and composition of the gas mixture, and prints out
|
|
a summary of its properties.
|
|
|
|
\include demo1a.cpp
|
|
|
|
This program produces the output below:
|
|
\verbatim
|
|
temperature 500 K
|
|
pressure 202650 Pa
|
|
density 0.361163 kg/m^3
|
|
mean mol. weight 7.40903 amu
|
|
|
|
1 kg 1 kmol
|
|
----------- ------------
|
|
enthalpy -2.47725e+06 -1.835e+07 J
|
|
internal energy -3.03836e+06 -2.251e+07 J
|
|
entropy 20700.1 1.534e+05 J/K
|
|
Gibbs function -1.28273e+07 -9.504e+07 J
|
|
heat capacity c_p 3919.29 2.904e+04 J/K
|
|
heat capacity c_v 2797.09 2.072e+04 J/K
|
|
|
|
X Y Chem. Pot. / RT
|
|
------------- ------------ ------------
|
|
H2 0.8 0.217667 -15.6441
|
|
H 0 0
|
|
O 0 0
|
|
O2 0 0
|
|
OH 0 0
|
|
H2O 0.1 0.243153 -82.9531
|
|
HO2 0 0
|
|
H2O2 0 0
|
|
AR 0.1 0.53918 -20.5027
|
|
\endverbatim
|
|
|
|
As C++ programs go, this one is \e very short. It is the %Cantera
|
|
equivalent of the "Hello, World" program most programming textbooks
|
|
begin with. But it illustrates some important points in writing
|
|
%Cantera C++ programs.
|
|
|
|
- <b>The Cantera.h header</b>\n
|
|
Note that the program begins with
|
|
\code
|
|
#include <cantera/Cantera.h>
|
|
\endcode
|
|
All %Cantera application programs must begin by including this header
|
|
file. The syntax of the include statement shown here is recommended,
|
|
since usually the %Cantera header files are installed within a
|
|
subdirectory named "cantera" in a directory on the search path
|
|
used by the compiler. If you need to include additional %Cantera headers,
|
|
always include Cantera.h first.
|
|
\see \ref cxx-headers
|
|
|
|
- <b>Catching CanteraError exceptions</b>\n
|
|
The entire body of the program is put inside a function that is invoked
|
|
within a \c try block in the main program. In this way, exceptions
|
|
thrown in the function or in any procedure it calls may be caught. In
|
|
this program, a \c catch block is defined for exceptions of type
|
|
CanteraError. The %Cantera kernel throws exceptions of this type, so it
|
|
is always a good idea to catch them. In the \c catch block, function
|
|
\c showErrors() may be called to print the error message associated
|
|
with the exception.
|
|
\see \ref cxx-exceptions
|
|
|
|
- <b>The 'report' function</b> The report function generates a
|
|
nicely-formatted report of the properties of a phase, including its
|
|
composition in both mole (X) and mass (Y) units. For each species
|
|
present, the non-dimensional chemical potential is also printed. This
|
|
is handy particularly when doing equilibrium calculations. This
|
|
function is very useful to see at a glance the state of some phase.
|
|
|
|
\section cxx-examples More Examples
|
|
The program above is simple, but doesn't do much. The links listed below show how to build on this demo program to do some useful things.
|
|
- \ref cxx-equildemo
|
|
- \ref cxx-thermodemo
|
|
|
|
|
|
\see \ref cxx-ctnew
|
|
|
|
|
|
*/
|