research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Python] Include docs for all classes in Sphinx docs

Browse source
This commit is contained in:
Ray Speth 2015-05-25 00:22:03 -04:00
parent ae5132060e
commit 468369df13
4 changed files with 35 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/sphinx/cython/importing.rst
View file

@ -12,6 +12,22 @@ thermodynamic, chemical kinetic, and (optionally) transport properties.
.. autoclass:: DustyGas(infile, phaseid='')
Pure Fluid Phases
-----------------
The following convenience functions can be used to create `PureFluid` objects
with the indicated equation of state:
.. autofunction:: CarbonDioxide
.. autofunction:: Heptane
.. autofunction:: Hfc134a
.. autofunction:: Hydrogen
.. autofunction:: Methane
.. autofunction:: Nitrogen
.. autofunction:: Oxygen
.. autofunction:: Water
Utility Functions
-----------------

2
doc/sphinx/cython/kinetics.rst
View file

@ -5,6 +5,8 @@ Chemical Kinetics
.. autoclass:: Kinetics(infile='', phaseid='', phases=())
.. autoclass:: InterfaceKinetics
Reactions
---------

8
doc/sphinx/cython/onedim.rst
View file

@ -21,6 +21,14 @@ CounterflowDiffusionFlame
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: CounterflowDiffusionFlame(gas, grid=None)
CounterflowPremixedFlame
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: CounterflowPremixedFlame(gas, grid=None)
ImpingingJet
^^^^^^^^^^^^
.. autoclass:: ImpingingJet(gas, grid=None)
Flow Domains
------------

11
doc/sphinx/cython/zerodim.rst
View file

@ -55,13 +55,20 @@ FlowReactor
.. autoclass:: FlowReactor(contents=None, *, name=None, energy='on')
Flow Controllers
----------------
Walls
-----
Wall
^^^^
.. autoclass:: Wall(left, right, *, name=None, A=None, K=None, U=None, Q=None, velocity=None, kinetics=(None,None))
WallSurface
^^^^^^^^^^^
.. autoclass:: WallSurface(wall, side)
Flow Controllers
----------------
MassFlowController
^^^^^^^^^^^^^^^^^^
.. autoclass:: MassFlowController(upstream, downstream, *, name=None, mdot=None)