[Doc] Document the ReactorSurface class in Python

Fixes #407
This commit is contained in:
Bryan W. Weber 2016-12-07 19:13:18 -05:00 committed by Ray Speth
parent 84e6775ee3
commit c7db81f33c
2 changed files with 9 additions and 1 deletions

View file

@ -56,7 +56,6 @@ FlowReactor
^^^^^^^^^^^
.. autoclass:: FlowReactor(contents=None, *, name=None, energy='on')
Walls
-----
@ -68,6 +67,13 @@ WallSurface
^^^^^^^^^^^
.. autoclass:: WallSurface(wall, side)
Surfaces
--------
ReactorSurface
^^^^^^^^^^^^^^
.. autoclass:: ReactorSurface(kin=None, r=None, *, A=None)
Flow Controllers
----------------

View file

@ -430,6 +430,8 @@ cdef class ReactorSurface:
:param kin:
The `Kinetics` or `Interface` object representing reactions on this
surface.
:param r:
The `Reactor` into which this surface should be installed.
:param A:
The area of the reacting surface [m^2]
"""