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

add docstrings to public cdef attributes

Browse Source
This commit is contained in:
Niclas Garan 2023-11-22 02:02:31 +01:00 committed by Ray Speth
parent a1763c8e9c
commit 04b06712ec
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
interfaces/cython/cantera/reactor.pxd
View File

@ -225,11 +225,19 @@ cdef class ReactorBase:
cdef list _surfaces cdef list _surfaces
cdef object _weakref_proxy cdef object _weakref_proxy
cdef public dict node_attr cdef public dict node_attr
"""
A dictionary containing draw attributes for the representation of the reactor as a graphviz
node. See https://graphviz.org/docs/nodes/ for a list of all usable attributes.
"""
cdef class Reactor(ReactorBase): cdef class Reactor(ReactorBase):
cdef CxxReactor* reactor cdef CxxReactor* reactor
cdef object _kinetics cdef object _kinetics
cdef public str groupname cdef public str groupname
"""
Optional name of a grouping of reactors that will be drawn as a cluster in the graphical
representation using graphviz. See https://graphviz.org/Gallery/directed/cluster.html.
"""
cdef class MoleReactor(Reactor): cdef class MoleReactor(Reactor):
pass pass
@ -261,6 +269,10 @@ cdef class ReactorSurface:
cdef Kinetics _kinetics cdef Kinetics _kinetics
cdef ReactorBase _reactor cdef ReactorBase _reactor
cdef public dict node_attr cdef public dict node_attr
"""
A dictionary containing draw attributes for the representation of the reactor surface as a
graphviz node. See https://graphviz.org/docs/nodes/ for a list of all usable attributes.
"""
cdef class WallBase: cdef class WallBase:
cdef shared_ptr[CxxWallBase] _wall cdef shared_ptr[CxxWallBase] _wall
@ -271,6 +283,10 @@ cdef class WallBase:
cdef ReactorBase _right_reactor cdef ReactorBase _right_reactor
cdef str name cdef str name
cdef public dict edge_attr cdef public dict edge_attr
"""
A dictionary containing draw attributes for the representation of the `WallBase` as a
graphviz edge.See https://graphviz.org/docs/edges/ for a list of all usable attributes.
"""
cdef class Wall(WallBase): cdef class Wall(WallBase):
pass pass
@ -284,6 +300,10 @@ cdef class FlowDevice:
cdef ReactorBase _upstream cdef ReactorBase _upstream
cdef ReactorBase _downstream cdef ReactorBase _downstream
cdef public dict edge_attr cdef public dict edge_attr
"""
A dictionary containing draw attributes for the representation of the `FlowDevice` as a
graphviz edge.See https://graphviz.org/docs/edges/ for a list of all usable attributes.
"""
cdef class MassFlowController(FlowDevice): cdef class MassFlowController(FlowDevice):
pass pass