From c7db81f33cefc204b6d704fcf79fa3d314018b62 Mon Sep 17 00:00:00 2001 From: "Bryan W. Weber" Date: Wed, 7 Dec 2016 19:13:18 -0500 Subject: [PATCH] [Doc] Document the ReactorSurface class in Python Fixes #407 --- doc/sphinx/cython/zerodim.rst | 8 +++++++- interfaces/cython/cantera/reactor.pyx | 2 ++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/sphinx/cython/zerodim.rst b/doc/sphinx/cython/zerodim.rst index 4b5ae96c8..c846cd9d5 100644 --- a/doc/sphinx/cython/zerodim.rst +++ b/doc/sphinx/cython/zerodim.rst @@ -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 ---------------- diff --git a/interfaces/cython/cantera/reactor.pyx b/interfaces/cython/cantera/reactor.pyx index 9ff207253..a745abc5c 100644 --- a/interfaces/cython/cantera/reactor.pyx +++ b/interfaces/cython/cantera/reactor.pyx @@ -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] """