GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
379ae509aa08d91165aa710fe90f0a135ded2742
cantera/doc/sphinx/python/onedim.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

99 lines
1.5 KiB
ReStructuredText
Raw Normal View History

[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
.. py:currentmodule:: cantera
[Doc] Use 'python' instead of 'cython' for filenames and refs Partially addresses Cantera/cantera-website#229
2023-09-29 20:33:31 -04:00
.. _sec-python-onedim:
[Python/Doc] Add section on kinetics to the tutorial
2015-05-30 18:32:34 -04:00
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
One-dimensional Reacting Flows
==============================
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
.. contents::
:local:
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
Composite Domains
-----------------
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
FreeFlame
^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: FreeFlame
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
BurnerFlame
^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: BurnerFlame
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
CounterflowDiffusionFlame
^^^^^^^^^^^^^^^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: CounterflowDiffusionFlame
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
[Python] Include docs for all classes in Sphinx docs
2015-05-25 00:22:03 -04:00
CounterflowPremixedFlame
^^^^^^^^^^^^^^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: CounterflowPremixedFlame
[Python] Include docs for all classes in Sphinx docs
2015-05-25 00:22:03 -04:00
[Doc] Include all Python classes/functions in Sphinx
2022-05-29 22:24:43 -04:00
CounterflowTwinPremixedFlame
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: CounterflowTwinPremixedFlame
[Python] Include docs for all classes in Sphinx docs
2015-05-25 00:22:03 -04:00
ImpingingJet
^^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: ImpingingJet
[Python] Include docs for all classes in Sphinx docs
2015-05-25 00:22:03 -04:00
[Doc] Add IonFlow and related classes to Sphinx docs
2018-08-10 10:46:11 -04:00
[Doc] Rework Python API landing page
2024-05-10 20:54:56 -04:00
.. _sec-python-flow-domains:
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
Flow Domains
------------
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
FreeFlow
^^^^^^^^
[Sphinx/Cython] Add call signatures to constructors
2014-01-11 00:20:33 +00:00
.. autoclass:: FreeFlow(thermo)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
[sphinx] Add FreeFlow and AxisymmetricFlow
2023-03-12 19:05:53 -05:00
AxisymmetricFlow
^^^^^^^^^^^^^^^^
.. autoclass:: AxisymmetricFlow(thermo)
[Doc] Rework Python API landing page
2024-05-10 20:54:56 -04:00
.. _sec-python-boundary-domains:
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
Boundaries
----------
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Inlet1D
^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: Inlet1D(phase, *, name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Outlet1D
^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: Outlet1D(phase, *, name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
OutletReservoir1D
^^^^^^^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: OutletReservoir1D(phase, *, name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
SymmetryPlane1D
^^^^^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: SymmetryPlane1D(phase, *, name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Surface1D
^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: Surface1D(phase, * name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
ReactingSurface1D
^^^^^^^^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: ReactingSurface1D(phase, *, name=None)
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
[Cython] Added 1D simulation docs to Sphinx
2012-12-26 23:56:18 +00:00
Base Classes
------------
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Domain1D
^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: Domain1D(phase, *, name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Boundary1D
^^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: Boundary1D(phase, *, name=None)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Sim1D
^^^^^
[Sphinx/Cython] Add call signatures to constructors
2014-01-11 00:20:33 +00:00
.. autoclass:: Sim1D(domains)
[Doc] Add local tables of contents to Reactor and 1D documentation This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
FlameBase
^^^^^^^^^
[Python] Fix constructor signatures in Sphinx docs Classes that define an __init__ method don't need to have their constructor signature defined in .rst file. Add relevant arguments determined by by _SolutionBase.__cinit__ to derived classes.
2022-02-09 22:47:53 -05:00
.. autoclass:: FlameBase
Reference in New Issue Copy Permalink