From 8c0c2e16e4837fea3c49b4064424318a94767c95 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 26 Dec 2012 23:56:18 +0000 Subject: [PATCH] [Cython] Added 1D simulation docs to Sphinx --- doc/sphinx/cython/index.rst | 1 + doc/sphinx/cython/onedim.rst | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 doc/sphinx/cython/onedim.rst diff --git a/doc/sphinx/cython/index.rst b/doc/sphinx/cython/index.rst index 985fd4ac8..5020c541f 100644 --- a/doc/sphinx/cython/index.rst +++ b/doc/sphinx/cython/index.rst @@ -10,3 +10,4 @@ Contents: kinetics transport zerodim + onedim diff --git a/doc/sphinx/cython/onedim.rst b/doc/sphinx/cython/onedim.rst new file mode 100644 index 000000000..865150747 --- /dev/null +++ b/doc/sphinx/cython/onedim.rst @@ -0,0 +1,33 @@ +.. py:currentmodule:: cantera + +One-dimensional Reacting Flows +============================== + +Composite Domains +----------------- +.. autoclass:: FreeFlame +.. autoclass:: BurnerFlame +.. autoclass:: CounterflowDiffusionFlame + +Flow Domains +------------ +.. autoclass:: StagnationFlow +.. autoclass:: FreeFlow +.. autoclass:: AxisymmetricStagnationFlow + + +Boundaries +---------- +.. autoclass:: Inlet1D +.. autoclass:: Outlet1D +.. autoclass:: OutletReservoir1D +.. autoclass:: SymmetryPlane1D +.. autoclass:: Surface1D +.. autoclass:: ReactingSurface1D + +Base Classes +------------ +.. autoclass:: Domain1D +.. autoclass:: Boundary1D +.. autoclass:: Sim1D +.. autoclass:: FlameBase