From 22eac2abcd1c63727ddf83d11dd5dfe4dae68c6c Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Sat, 11 Jan 2014 00:20:33 +0000 Subject: [PATCH] [Sphinx/Cython] Add call signatures to constructors --- doc/sphinx/cython/importing.rst | 6 +++--- doc/sphinx/cython/kinetics.rst | 4 ++-- doc/sphinx/cython/onedim.rst | 30 +++++++++++++++--------------- doc/sphinx/cython/thermo.rst | 6 +++--- doc/sphinx/cython/transport.rst | 4 ++-- doc/sphinx/cython/zerodim.rst | 26 +++++++++++++------------- 6 files changed, 38 insertions(+), 38 deletions(-) diff --git a/doc/sphinx/cython/importing.rst b/doc/sphinx/cython/importing.rst index e1957a882..0fcf7ca3d 100644 --- a/doc/sphinx/cython/importing.rst +++ b/doc/sphinx/cython/importing.rst @@ -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 ----------------- diff --git a/doc/sphinx/cython/kinetics.rst b/doc/sphinx/cython/kinetics.rst index 487267478..806f9f575 100644 --- a/doc/sphinx/cython/kinetics.rst +++ b/doc/sphinx/cython/kinetics.rst @@ -3,6 +3,6 @@ Chemical Kinetics ================= -.. autoclass:: Kinetics +.. autoclass:: Kinetics(infile='', phaseid='', phases=()) -.. autoclass:: ReactionPathDiagram +.. autoclass:: ReactionPathDiagram(Kinetics kin, str element) diff --git a/doc/sphinx/cython/onedim.rst b/doc/sphinx/cython/onedim.rst index 008011530..4f8314d5b 100644 --- a/doc/sphinx/cython/onedim.rst +++ b/doc/sphinx/cython/onedim.rst @@ -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) diff --git a/doc/sphinx/cython/thermo.rst b/doc/sphinx/cython/thermo.rst index d2d6f7030..ac8c74ba1 100644 --- a/doc/sphinx/cython/thermo.rst +++ b/doc/sphinx/cython/thermo.rst @@ -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='') diff --git a/doc/sphinx/cython/transport.rst b/doc/sphinx/cython/transport.rst index 2c2242f8d..c8e8233de 100644 --- a/doc/sphinx/cython/transport.rst +++ b/doc/sphinx/cython/transport.rst @@ -3,5 +3,5 @@ Transport Properties ==================== -.. autoclass:: Transport -.. autoclass:: DustyGasTransport +.. autoclass:: Transport(infile='', phaseid='') +.. autoclass:: DustyGasTransport(infile='', phaseid='') diff --git a/doc/sphinx/cython/zerodim.rst b/doc/sphinx/cython/zerodim.rst index 1272d7ff7..cb0a196d6 100644 --- a/doc/sphinx/cython/zerodim.rst +++ b/doc/sphinx/cython/zerodim.rst @@ -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)