From ea7ae8c5837622745d23b4f294a99a99543a9f44 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Wed, 30 Dec 2009 18:20:34 +0000 Subject: [PATCH] Added a stub for a high level description of transport within Cantera. --- tools/doc/doxyinput/Cantera.txt | 1 + tools/doc/doxyinput/transport.txt | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 tools/doc/doxyinput/transport.txt diff --git a/tools/doc/doxyinput/Cantera.txt b/tools/doc/doxyinput/Cantera.txt index 696124b8a..63a9fd587 100644 --- a/tools/doc/doxyinput/Cantera.txt +++ b/tools/doc/doxyinput/Cantera.txt @@ -22,5 +22,6 @@ Choose one of the links below for an introduction to %Cantera, or use - Computing Properties of Matter - \subpage thermopage + - \subpage transportpage */ diff --git a/tools/doc/doxyinput/transport.txt b/tools/doc/doxyinput/transport.txt new file mode 100644 index 000000000..ad4c8a94f --- /dev/null +++ b/tools/doc/doxyinput/transport.txt @@ -0,0 +1,23 @@ +/** + +\page transportpage Transport Properties + +%Cantera can be used to compute transport properties + + +\section nest Non-Equilibrium Statistical Thermodynamics + + +\section tbase Base Class for Transport Properties + + +The base class \link Cantera::Transport Transport \endlink is used for all +transport classes within Cantera. + + + +There is a list of classes which handle transport for species (see +\ref tranprops " Transport Properties for Species in Phases"). + + +*/