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

[Doc] Add local tables of contents for thermo and kinetics

Browse source
This commit is contained in:
Ray Speth 2015-05-29 17:32:23 -04:00
parent 911c2f180d
commit c7e79e64b4
2 changed files with 57 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -3,8 +3,18 @@
Chemical Kinetics
=================
.. contents::
:local:
Kinetics Managers
-----------------
Kinetics
^^^^^^^^
.. autoclass:: Kinetics(infile='', phaseid='', phases=())
InterfaceKinetics
^^^^^^^^^^^^^^^^^
.. autoclass:: InterfaceKinetics
Reactions
@ -13,45 +23,71 @@ Reactions
These classes contain the definition of a single reaction and its associated
rate expression, independent of a specific `Kinetics` object.
Reaction
^^^^^^^^
.. autoclass:: Reaction(reactants='', products='')
:no-undoc-members:
ElementaryReaction
^^^^^^^^^^^^^^^^^^
.. autoclass:: ElementaryReaction(reactants='', products='')
:no-undoc-members:
ThreeBodyReaction
^^^^^^^^^^^^^^^^^
.. autoclass:: ThreeBodyReaction(reactants='', products='')
:no-undoc-members:
FalloffReaction
^^^^^^^^^^^^^^^
.. autoclass:: FalloffReaction(reactants='', products='')
:no-undoc-members:
ChemicallyActivatedReaction
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: ChemicallyActivatedReaction(reactants='', products='')
:no-undoc-members:
PlogReaction
^^^^^^^^^^^^
.. autoclass:: PlogReaction(reactants='', products='')
:no-undoc-members:
ChebyshevReaction
^^^^^^^^^^^^^^^^^
.. autoclass:: ChebyshevReaction(reactants='', products='')
:no-undoc-members:
InterfaceReaction
^^^^^^^^^^^^^^^^^
.. autoclass:: InterfaceReaction(reactants='', products='')
:no-undoc-members:
Auxilliary Reaction Data
------------------------
Arrhenius
^^^^^^^^^
.. autoclass:: Arrhenius(A, b, E)
Falloff
^^^^^^^
.. autoclass:: Falloff(coeffs=(), init=True)
:no-undoc-members:
TroeFalloff
^^^^^^^^^^^
.. autoclass:: TroeFalloff(coeffs=(), init=True)
:no-undoc-members:
SriFalloff
^^^^^^^^^^
.. autoclass:: SriFalloff(coeffs=(), init=True)
:no-undoc-members:
Reaction Path Analysis
----------------------
ReactionPathDiagram
^^^^^^^^^^^^^^^^^^^
.. autoclass:: ReactionPathDiagram(Kinetics kin, str element)

21
doc/sphinx/cython/thermo.rst
View file

@ -1,15 +1,27 @@
.. py:currentmodule:: cantera
Thermodynamic Properties
========================
.. contents::
:local:
Phases
------
These classes are used to describe the thermodynamic state of a system.
ThermoPhase
^^^^^^^^^^^
.. autoclass:: ThermoPhase(infile='', phaseid='')
InterfacePhase
^^^^^^^^^^^^^^
.. autoclass:: InterfacePhase(infile='', phaseid='')
PureFluid
^^^^^^^^^
.. autoclass:: PureFluid(infile='', phaseid='')
Mixture
@ -28,12 +40,21 @@ Species Thermodynamic Properties
These classes are used to describe the reference-state thermodynamic properties
of a pure species.
SpeciesThermo
^^^^^^^^^^^^^
.. autoclass:: SpeciesThermo(T_low, T_high, P_ref, coeffs)
ConstantCp
^^^^^^^^^^
.. autoclass:: ConstantCp(T_low, T_high, P_ref, coeffs)
:no-undoc-members:
NasaPoly2
^^^^^^^^^
.. autoclass:: NasaPoly2(T_low, T_high, P_ref, coeffs)
:no-undoc-members:
ShomatePoly2
^^^^^^^^^^^^
.. autoclass:: ShomatePoly2(T_low, T_high, P_ref, coeffs)
:no-undoc-members: