From ac8612f36b7e317fb01e25a33d1edf4ecbfdc604 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Fri, 10 Aug 2018 10:46:11 -0400 Subject: [PATCH] [Doc] Add IonFlow and related classes to Sphinx docs --- doc/sphinx/cython/onedim.rst | 25 +++++++++++++++++++++++++ interfaces/cython/cantera/onedim.py | 1 + 2 files changed, 26 insertions(+) diff --git a/doc/sphinx/cython/onedim.rst b/doc/sphinx/cython/onedim.rst index 49ed23b4c..9fe6599d9 100644 --- a/doc/sphinx/cython/onedim.rst +++ b/doc/sphinx/cython/onedim.rst @@ -31,9 +31,34 @@ ImpingingJet ^^^^^^^^^^^^ .. autoclass:: ImpingingJet(gas, grid=None, width=None) +IonFreeFlame +^^^^^^^^^^^^ +.. autoclass:: IonFreeFlame(gas, grid=None, width=None) + + .. autoattribute:: E + .. autoattribute:: electric_field_enabled + .. automethod:: solve + +IonBurnerFlame +^^^^^^^^^^^^^^ +.. autoclass:: IonBurnerFlame(gas, grid=None, width=None) + + .. autoattribute:: E + .. autoattribute:: electric_field_enabled + .. automethod:: solve + Flow Domains ------------ +IdealGasFlow +^^^^^^^^^^^^ +.. autoclass:: IdealGasFlow(thermo) + :inherited-members: + +IonFlow +^^^^^^^ +.. autoclass:: IonFlow(thermo) + FreeFlow ^^^^^^^^ .. autoclass:: FreeFlow(thermo) diff --git a/interfaces/cython/cantera/onedim.py b/interfaces/cython/cantera/onedim.py index dccefd4ac..2c9af341d 100644 --- a/interfaces/cython/cantera/onedim.py +++ b/interfaces/cython/cantera/onedim.py @@ -618,6 +618,7 @@ class IonFlameBase(FlameBase): class IonFreeFlame(IonFlameBase, FreeFlame): + """A freely-propagating flame with ionized gas.""" __slots__ = ('inlet', 'outlet', 'flame') def __init__(self, gas, grid=None, width=None):