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

[Sphinx/Cython] Add call signatures to constructors

Browse source
This commit is contained in:
Ray Speth 2014-01-11 00:20:33 +00:00
parent a3d8684d94
commit 22eac2abcd
6 changed files with 38 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/sphinx/cython/importing.rst
View file

@ -6,11 +6,11 @@ Importing Phase Objects
These classes are composite representations of a substance which has
thermodynamic, chemical kinetic, and (optionally) transport properties.
.. autoclass:: Solution
.. autoclass:: Solution(infile, phaseid='')
.. autoclass:: Interface
.. autoclass:: Interface(infile, phaseid='', phases=())
.. autoclass:: DustyGas
.. autoclass:: DustyGas(infile, phaseid='')
Utility Functions
-----------------

4
doc/sphinx/cython/kinetics.rst
View file

@ -3,6 +3,6 @@
Chemical Kinetics
=================
.. autoclass:: Kinetics
.. autoclass:: Kinetics(infile='', phaseid='', phases=())
.. autoclass:: ReactionPathDiagram
.. autoclass:: ReactionPathDiagram(Kinetics kin, str element)

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

@ -5,29 +5,29 @@ One-dimensional Reacting Flows
Composite Domains
-----------------
.. autoclass:: FreeFlame
.. autoclass:: BurnerFlame
.. autoclass:: CounterflowDiffusionFlame
.. autoclass:: FreeFlame(gas, grid=None)
.. autoclass:: BurnerFlame(gas, grid=None)
.. autoclass:: CounterflowDiffusionFlame(gas, grid=None)
Flow Domains
------------
.. autoclass:: FreeFlow
.. autoclass:: FreeFlow(thermo)
:inherited-members:
.. autoclass:: AxisymmetricStagnationFlow
.. autoclass:: AxisymmetricStagnationFlow(thermo)
:inherited-members:
Boundaries
----------
.. autoclass:: Inlet1D
.. autoclass:: Outlet1D
.. autoclass:: OutletReservoir1D
.. autoclass:: SymmetryPlane1D
.. autoclass:: Surface1D
.. autoclass:: ReactingSurface1D
.. autoclass:: Inlet1D(phase, name=None)
.. autoclass:: Outlet1D(phase, name=None)
.. autoclass:: OutletReservoir1D(phase, name=None)
.. autoclass:: SymmetryPlane1D(phase, name=None)
.. autoclass:: Surface1D(phase, name=None)
.. autoclass:: ReactingSurface1D(phase, name=None)
Base Classes
------------
.. autoclass:: Domain1D
.. autoclass:: Boundary1D
.. autoclass:: Sim1D
.. autoclass:: FlameBase
.. autoclass:: Domain1D(name=None)
.. autoclass:: Boundary1D(phase, name=None)
.. autoclass:: Sim1D(domains)
.. autoclass:: FlameBase(domains, gas, grid=None)

6
doc/sphinx/cython/thermo.rst
View file

@ -5,6 +5,6 @@ Thermodynamic Properties
These classes are used to describe the thermodynamic state of a system.
.. autoclass:: ThermoPhase
.. autoclass:: InterfacePhase
.. autoclass:: PureFluid
.. autoclass:: ThermoPhase(infile='', phaseid='')
.. autoclass:: InterfacePhase(infile='', phaseid='')
.. autoclass:: PureFluid(infile='', phaseid='')

4
doc/sphinx/cython/transport.rst
View file

@ -3,5 +3,5 @@
Transport Properties
====================
.. autoclass:: Transport
.. autoclass:: DustyGasTransport
.. autoclass:: Transport(infile='', phaseid='')
.. autoclass:: DustyGasTransport(infile='', phaseid='')

26
doc/sphinx/cython/zerodim.rst
View file

@ -11,28 +11,28 @@ Defining Functions
Base Classes
------------
.. autoclass:: ReactorBase
.. autoclass:: FlowDevice
.. autoclass:: ReactorBase(contents=None, name=None)
.. autoclass:: FlowDevice(upstream, downstream, *, name=None)
Reactor Networks
----------------
.. autoclass:: ReactorNet
.. autoclass:: ReactorNet(reactors=())
Reactors
--------
.. autoclass:: Reservoir
.. autoclass:: Reactor
.. autoclass:: IdealGasReactor
.. autoclass:: ConstPressureReactor
.. autoclass:: IdealGasConstPressureReactor
.. autoclass:: FlowReactor
.. autoclass:: Reservoir(contents=None, name=None)
.. autoclass:: Reactor(contents=None, *, name=None, energy='on')
.. autoclass:: IdealGasReactor(contents=None, *, name=None, energy='on')
.. autoclass:: ConstPressureReactor(contents=None, *, name=None, energy='on')
.. autoclass:: IdealGasConstPressureReactor(contents=None, *, name=None, energy='on')
.. autoclass:: FlowReactor(contents=None, *, name=None, energy='on')
Flow Controllers
----------------
.. autoclass:: Wall
.. autoclass:: MassFlowController
.. autoclass:: Valve
.. autoclass:: PressureController
.. autoclass:: Wall(left, right, *, name=None, A=None, K=None, U=None, Q=None, velocity=None, kinetics=(None,None))
.. autoclass:: MassFlowController(upstream, downstream, *, name=None, mdot=None)
.. autoclass:: Valve(upstream, downstream, *, name=None, K=None)
.. autoclass:: PressureController(upstream, downstream, *, name=None, master=None, K=None)