From c7e79e64b4ad8ee899a7f5e17ad587769e20f95b Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Fri, 29 May 2015 17:32:23 -0400 Subject: [PATCH] [Doc] Add local tables of contents for thermo and kinetics --- doc/sphinx/cython/kinetics.rst | 36 ++++++++++++++++++++++++++++++++++ doc/sphinx/cython/thermo.rst | 21 ++++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/doc/sphinx/cython/kinetics.rst b/doc/sphinx/cython/kinetics.rst index d38895848..fea8f723d 100644 --- a/doc/sphinx/cython/kinetics.rst +++ b/doc/sphinx/cython/kinetics.rst @@ -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) diff --git a/doc/sphinx/cython/thermo.rst b/doc/sphinx/cython/thermo.rst index bffbe7abb..aa75e1528 100644 --- a/doc/sphinx/cython/thermo.rst +++ b/doc/sphinx/cython/thermo.rst @@ -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: