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

[Doc] Add IonFlow and related classes to Sphinx docs

Browse source
This commit is contained in:
Ray Speth 2018-08-10 10:46:11 -04:00
parent ee633f3e16
commit ac8612f36b
2 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/sphinx/cython/onedim.rst
View file

@ -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)

1
interfaces/cython/cantera/onedim.py
View file

@ -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):