Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Miscellaneous Python documentation fixes #1196

Merged
merged 14 commits into from
Feb 16, 2022
Merged

Miscellaneous Python documentation fixes #1196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e379810
[Doc] Fix confusing "property" label in Sphinx
speth Feb 9, 2022
cce32c9
[Python/Doc] Update docstring for Interface class
speth Feb 9, 2022
a88fda7
[Python] Fix typos in reaction docstrings
speth Feb 10, 2022
8856c9c
[Python] Make constructor signatures consistent for all Reaction types
speth Feb 10, 2022
1c9b181
[Python] Make extended arguments to Solution keyword-only
speth Feb 10, 2022
2943a74
[Python] Fix constructor signatures in Sphinx docs
speth Feb 10, 2022
4873544
[Python] Remove outdated notes about sources of Sphinx warnings
speth Feb 10, 2022
55119ca
[Python] Remove leftover of old WallSurface implementation
speth Feb 10, 2022
db5fb41
[Python/Doc] Fix equation formatting
speth Feb 12, 2022
6c12bcb
[Python/Doc] Fix some Sphinx-Doxygen links
speth Feb 14, 2022
6dc91aa
[Python/Doc] Fix argument formatting
speth Feb 14, 2022
97eb052
Clean up Python documentation
speth Feb 15, 2022
a7c2f32
Wordsmith docstring for Sim1D.collect_data
speth Feb 15, 2022
fcaccbd
[Doc] Consistently format Python module names using italics
speth Feb 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/sphinx/cython/importing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Composite Phase Objects
These classes are composite representations of a substance which has
thermodynamic, chemical kinetic, and (optionally) transport properties.

.. autoclass:: Solution(infile='', phaseid='', source=None, thermo=None, species=(), kinetics=None, reactions=(), **kwargs)
.. autoclass:: Solution(infile='', name='', *, origin=None, source=None, yaml=None, thermo=None, species=(), kinetics=None, reactions=())

.. autoclass:: Interface(infile='', phaseid='', phases=(), thermo=None, species=(), kinetics=None, reactions=())
.. autoclass:: Interface(infile='', name='', adjacent=(), *, origin=None, source=None, yaml=None, thermo=None, species=(), kinetics=None, reactions=())

.. autoclass:: DustyGas(infile, phaseid='')
.. autoclass:: DustyGas(infile, name='')

Pure Fluid Phases
-----------------
Expand Down
24 changes: 12 additions & 12 deletions doc/sphinx/cython/kinetics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Kinetics Managers

Kinetics
^^^^^^^^
.. autoclass:: Kinetics(infile='', phaseid='', phases=())
.. autoclass:: Kinetics

InterfaceKinetics
^^^^^^^^^^^^^^^^^
Expand All @@ -27,47 +27,47 @@ evaluation is handled by dedicated `ReactionRate` objects.

Reaction
^^^^^^^^
.. autoclass:: Reaction(reactants='', products='')
.. autoclass:: Reaction
:no-undoc-members:

ElementaryReaction
^^^^^^^^^^^^^^^^^^
.. autoclass:: ElementaryReaction(reactants='', products='')
.. autoclass:: ElementaryReaction
:no-undoc-members:

ThreeBodyReaction
^^^^^^^^^^^^^^^^^
.. autoclass:: ThreeBodyReaction(reactants='', products='')
.. autoclass:: ThreeBodyReaction
:no-undoc-members:

FalloffReaction
^^^^^^^^^^^^^^^
.. autoclass:: FalloffReaction(reactants='', products='')
.. autoclass:: FalloffReaction
:no-undoc-members:

ChemicallyActivatedReaction
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: ChemicallyActivatedReaction(reactants='', products='')
.. autoclass:: ChemicallyActivatedReaction
:no-undoc-members:

PlogReaction
^^^^^^^^^^^^
.. autoclass:: PlogReaction(reactants='', products='')
.. autoclass:: PlogReaction
:no-undoc-members:

ChebyshevReaction
^^^^^^^^^^^^^^^^^
.. autoclass:: ChebyshevReaction(reactants='', products='')
.. autoclass:: ChebyshevReaction
:no-undoc-members:

InterfaceReaction
^^^^^^^^^^^^^^^^^
.. autoclass:: InterfaceReaction(reactants='', products='')
.. autoclass:: InterfaceReaction
:no-undoc-members:

BlowersMaselInterfaceReaction
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: BlowersMaselInterfaceReaction(reactants='', products='')
.. autoclass:: BlowersMaselInterfaceReaction
:no-undoc-members:

Reaction Rates
Expand Down Expand Up @@ -137,8 +137,8 @@ CustomRate
.. autoclass:: CustomRate(k)
:no-undoc-members:

Auxilliary Reaction Data (legacy only)
--------------------------------------
Auxiliary Reaction Data (legacy only)
-------------------------------------

Arrhenius
^^^^^^^^^
Expand Down
32 changes: 16 additions & 16 deletions doc/sphinx/cython/onedim.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,35 +13,35 @@ Composite Domains

FreeFlame
^^^^^^^^^
.. autoclass:: FreeFlame(gas, grid=None, width=None)
.. autoclass:: FreeFlame

BurnerFlame
^^^^^^^^^^^
.. autoclass:: BurnerFlame(gas, grid=None, width=None)
.. autoclass:: BurnerFlame

CounterflowDiffusionFlame
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: CounterflowDiffusionFlame(gas, grid=None, width=None)
.. autoclass:: CounterflowDiffusionFlame

CounterflowPremixedFlame
^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: CounterflowPremixedFlame(gas, grid=None, width=None)
.. autoclass:: CounterflowPremixedFlame

ImpingingJet
^^^^^^^^^^^^
.. autoclass:: ImpingingJet(gas, grid=None, width=None)
.. autoclass:: ImpingingJet

IonFreeFlame
^^^^^^^^^^^^
.. autoclass:: IonFreeFlame(gas, grid=None, width=None)
.. autoclass:: IonFreeFlame

.. autoattribute:: E
.. autoattribute:: electric_field_enabled
.. automethod:: solve

IonBurnerFlame
^^^^^^^^^^^^^^
.. autoclass:: IonBurnerFlame(gas, grid=None, width=None)
.. autoclass:: IonBurnerFlame

.. autoattribute:: E
.. autoattribute:: electric_field_enabled
Expand Down Expand Up @@ -72,43 +72,43 @@ Boundaries

Inlet1D
^^^^^^^
.. autoclass:: Inlet1D(phase, name=None)
.. autoclass:: Inlet1D(phase, *, name=None)

Outlet1D
^^^^^^^^
.. autoclass:: Outlet1D(phase, name=None)
.. autoclass:: Outlet1D(phase, *, name=None)

OutletReservoir1D
^^^^^^^^^^^^^^^^^
.. autoclass:: OutletReservoir1D(phase, name=None)
.. autoclass:: OutletReservoir1D(phase, *, name=None)

SymmetryPlane1D
^^^^^^^^^^^^^^^
.. autoclass:: SymmetryPlane1D(phase, name=None)
.. autoclass:: SymmetryPlane1D(phase, *, name=None)

Surface1D
^^^^^^^^^
.. autoclass:: Surface1D(phase, name=None)
.. autoclass:: Surface1D(phase, * name=None)

ReactingSurface1D
^^^^^^^^^^^^^^^^^
.. autoclass:: ReactingSurface1D(phase, name=None)
.. autoclass:: ReactingSurface1D(phase, *, name=None)


Base Classes
------------
Domain1D
^^^^^^^^
.. autoclass:: Domain1D(name=None)
.. autoclass:: Domain1D(phase, *, name=None)

Boundary1D
^^^^^^^^^^
.. autoclass:: Boundary1D(phase, name=None)
.. autoclass:: Boundary1D(phase, *, name=None)

Sim1D
^^^^^
.. autoclass:: Sim1D(domains)

FlameBase
^^^^^^^^^
.. autoclass:: FlameBase(domains, gas, grid=None)
.. autoclass:: FlameBase
8 changes: 4 additions & 4 deletions doc/sphinx/cython/thermo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ These classes are used to describe the thermodynamic state of a system.

ThermoPhase
^^^^^^^^^^^
.. autoclass:: ThermoPhase(infile='', phaseid='')
.. autoclass:: ThermoPhase(infile='', name='', *, origin=None, source=None, yaml=None, thermo=None, species=(), **kwargs)

InterfacePhase
^^^^^^^^^^^^^^
.. autoclass:: InterfacePhase(infile='', phaseid='')
.. autoclass:: InterfacePhase(infile='', name='', adjacent=(), *, origin=None, source=None, yaml=None, thermo=None, species=(), **kwargs)

PureFluid
^^^^^^^^^
.. autoclass:: PureFluid(infile='', phaseid='')
.. autoclass:: PureFluid(infile='', name='')

Mixture
-------

.. autoclass:: Mixture
.. autoclass:: Mixture(phases)

Species
-------
Expand Down
6 changes: 3 additions & 3 deletions doc/sphinx/cython/transport.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Transport Properties
====================

.. autoclass:: Transport(infile='', phaseid='')
.. autoclass:: DustyGasTransport(infile='', phaseid='')
.. autoclass:: Transport()
.. autoclass:: DustyGasTransport()

Species Transport Properties
----------------------------

.. autoclass:: GasTransportData(geometry='', diameter=-1, well_depth=-1, dipole=0.0, polarizability=0.0, rotational_relaxation=0.0, acentric_factor=0.0)
.. autoclass:: GasTransportData(geometry='', diameter=-1, well_depth=-1, dipole=0.0, polarizability=0.0, rotational_relaxation=0.0, acentric_factor=0.0, dispersion_coefficient=0.0, quadrupole_polarizability=0.0)
22 changes: 9 additions & 13 deletions doc/sphinx/cython/zerodim.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ Base Classes

ReactorBase
^^^^^^^^^^^
.. autoclass:: ReactorBase(contents=None, name=None)
.. autoclass:: ReactorBase

FlowDevice
^^^^^^^^^^
.. autoclass:: FlowDevice(upstream, downstream, *, name=None)
.. autoclass:: FlowDevice

Reactor Networks
----------------

.. autoclass:: ReactorNet(reactors=())
.. autoclass:: ReactorNet

Reactors
--------
Expand All @@ -38,7 +38,7 @@ Reservoir

Reactor
^^^^^^^
.. autoclass:: Reactor(contents=None, *, name=None, energy='on')
.. autoclass:: Reactor

IdealGasReactor
^^^^^^^^^^^^^^^
Expand All @@ -58,7 +58,7 @@ FlowReactor

ExtensibleReactor
^^^^^^^^^^^^^^^^^
.. autoclass:: ExtensibleReactor
.. autoclass:: ExtensibleReactor(contents=None, *, name=None, energy='on')

ExtensibleIdealGasReactor
^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -77,11 +77,7 @@ Walls

Wall
^^^^
.. autoclass:: Wall(left, right, *, name=None, A=None, K=None, U=None, Q=None, velocity=None, kinetics=(None,None))

WallSurface
^^^^^^^^^^^
.. autoclass:: WallSurface(wall, side)
.. autoclass:: Wall(left, right, *, name=None, A=None, K=None, U=None, Q=None, velocity=None)

Surfaces
--------
Expand All @@ -95,15 +91,15 @@ Flow Controllers

MassFlowController
^^^^^^^^^^^^^^^^^^
.. autoclass:: MassFlowController(upstream, downstream, *, name=None, mdot=None)
.. autoclass:: MassFlowController
:inherited-members:

Valve
^^^^^
.. autoclass:: Valve(upstream, downstream, *, name=None, K=None)
.. autoclass:: Valve
:inherited-members:

PressureController
^^^^^^^^^^^^^^^^^^
.. autoclass:: PressureController(upstream, downstream, *, name=None, master=None, K=None)
.. autoclass:: PressureController
:inherited-members:
8 changes: 0 additions & 8 deletions interfaces/cython/cantera/_cantera.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1487,16 +1487,8 @@ cdef class ReactorSurface:
cdef CxxReactorSurface* surface
cdef Kinetics _kinetics

cdef class WallSurface:
cdef CxxWallBase* cxxwall
cdef object wall
cdef int side
cdef Kinetics _kinetics

cdef class WallBase:
cdef CxxWallBase* wall
cdef WallSurface left_surface
cdef WallSurface right_surface
cdef object _velocity_func
cdef object _heat_flux_func
cdef ReactorBase _left_reactor
Expand Down
2 changes: 1 addition & 1 deletion interfaces/cython/cantera/base.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ cdef object _wrap_Solution(shared_ptr[CxxSolution] cxx_soln):


cdef class _SolutionBase:
def __cinit__(self, infile='', name='', adjacent=(), origin=None,
def __cinit__(self, infile='', name='', adjacent=(), *, origin=None,
source=None, yaml=None, thermo=None, species=(),
kinetics=None, reactions=(), init=True, **kwargs):

Expand Down
Loading