[Doc] Add local tables of contents to Reactor and 1D documentation

This makes these pages, which document many classes, easier to navigate.
This commit is contained in:
Ray Speth
2014-09-02 22:34:08 +00:00
parent 671d6eb576
commit 0fd419028a
2 changed files with 85 additions and 0 deletions

View File

@@ -3,31 +3,79 @@
One-dimensional Reacting Flows
==============================
.. contents::
:local:
Composite Domains
-----------------
FreeFlame
^^^^^^^^^
.. autoclass:: FreeFlame(gas, grid=None)
BurnerFlame
^^^^^^^^^^^
.. autoclass:: BurnerFlame(gas, grid=None)
CounterflowDiffusionFlame
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: CounterflowDiffusionFlame(gas, grid=None)
Flow Domains
------------
FreeFlow
^^^^^^^^
.. autoclass:: FreeFlow(thermo)
:inherited-members:
AxisymmetricStagnationFlow
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: AxisymmetricStagnationFlow(thermo)
:inherited-members:
Boundaries
----------
Inlet1D
^^^^^^^
.. autoclass:: Inlet1D(phase, name=None)
Outlet1D
^^^^^^^^
.. autoclass:: Outlet1D(phase, name=None)
OutletReservoir1D
^^^^^^^^^^^^^^^^^
.. autoclass:: OutletReservoir1D(phase, name=None)
SymmetryPlane1D
^^^^^^^^^^^^^^^
.. autoclass:: SymmetryPlane1D(phase, name=None)
Surface1D
^^^^^^^^^
.. autoclass:: Surface1D(phase, name=None)
ReactingSurface1D
^^^^^^^^^^^^^^^^^
.. autoclass:: ReactingSurface1D(phase, name=None)
Base Classes
------------
Domain1D
^^^^^^^^
.. autoclass:: Domain1D(name=None)
Boundary1D
^^^^^^^^^^
.. autoclass:: Boundary1D(phase, name=None)
Sim1D
^^^^^
.. autoclass:: Sim1D(domains)
FlameBase
^^^^^^^^^
.. autoclass:: FlameBase(domains, gas, grid=None)

View File

@@ -3,6 +3,9 @@
Zero-Dimensional Reactor Networks
=================================
.. contents::
:local:
Defining Functions
------------------
@@ -11,7 +14,12 @@ Defining Functions
Base Classes
------------
ReactorBase
^^^^^^^^^^^
.. autoclass:: ReactorBase(contents=None, name=None)
FlowDevice
^^^^^^^^^^
.. autoclass:: FlowDevice(upstream, downstream, *, name=None)
Reactor Networks
@@ -22,17 +30,46 @@ Reactor Networks
Reactors
--------
Reservoir
^^^^^^^^^
.. autoclass:: Reservoir(contents=None, name=None)
Reactor
^^^^^^^
.. autoclass:: Reactor(contents=None, *, name=None, energy='on')
IdealGasReactor
^^^^^^^^^^^^^^^
.. autoclass:: IdealGasReactor(contents=None, *, name=None, energy='on')
ConstPressureReactor
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: ConstPressureReactor(contents=None, *, name=None, energy='on')
IdealGasConstPressureReactor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: IdealGasConstPressureReactor(contents=None, *, name=None, energy='on')
FlowReactor
^^^^^^^^^^^
.. autoclass:: FlowReactor(contents=None, *, name=None, energy='on')
Flow Controllers
----------------
Wall
^^^^
.. autoclass:: Wall(left, right, *, name=None, A=None, K=None, U=None, Q=None, velocity=None, kinetics=(None,None))
MassFlowController
^^^^^^^^^^^^^^^^^^
.. autoclass:: MassFlowController(upstream, downstream, *, name=None, mdot=None)
Valve
^^^^^
.. autoclass:: Valve(upstream, downstream, *, name=None, K=None)
PressureController
^^^^^^^^^^^^^^^^^^
.. autoclass:: PressureController(upstream, downstream, *, name=None, master=None, K=None)