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 version tag to methods, functions and properties

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

4
interfaces/cython/cantera/drawnetwork.py
View File

@ -68,6 +68,7 @@ def draw_reactor(r, dot=None, graph_attr=None, node_attr=None, print_state=False
:return:
``graphviz.graphs.BaseGraph`` object with reactor
.. versionadded:: 3.1
"""
if not dot:
@ -161,6 +162,7 @@ def draw_reactor_net(n, graph_attr=None, node_attr=None, edge_attr=None, heat_fl
:return:
``graphviz.graphs.BaseGraph`` object with reactor net.
.. versionadded:: 3.1
"""
dot = _graphviz.Digraph(graph_attr=graph_attr)
@ -278,6 +280,7 @@ def draw_surface(surface, dot=None, graph_attr=None, node_attr=None, surface_edg
A ``graphviz.graphs.BaseGraph`` object depicting the surface and its
reactor.
.. versionadded:: 3.1
"""
r = surface.reactor
@ -337,6 +340,7 @@ def draw_connections(connections, dot=None, graph_attr=None, node_attr=None, edg
:return:
A ``graphviz.graphs.BaseGraph`` object depicting the connections.
.. versionadded:: 3.1
"""
if not dot:

23
interfaces/cython/cantera/reactor.pyx
View File

@ -195,6 +195,7 @@ cdef class ReactorBase:
:return:
``graphviz.graphs.BaseGraph`` object with reactor
.. versionadded:: 3.1
"""
return draw_reactor(self, dot, graph_attr, node_attr, print_state, species,
species_units)
@ -888,7 +889,10 @@ cdef class ReactorSurface:
@property
def reactor(self):
"""Return the `Reactor` object the surface is connected to."""
"""
Return the `Reactor` object the surface is connected to.
.. versionadded:: 3.1
"""
return self._reactor
def draw(self, dot=None, *, graph_attr=None, node_attr=None, surface_edge_attr=None,
@ -927,6 +931,7 @@ cdef class ReactorSurface:
``graphviz.graphs.BaseGraph`` object with surface and connected
reactor.
.. versionadded:: 3.1
"""
return draw_surface(self, dot, graph_attr, node_attr, surface_edge_attr, print_state,
**kwargs)
@ -1028,12 +1033,18 @@ cdef class WallBase:
@property
def left_reactor(self):
"""Return the `Reactor` or `Reservoir` object left of the wall."""
"""
Return the `Reactor` or `Reservoir` object left of the wall.
.. versionadded:: 3.1
"""
return self._left_reactor
@property
def right_reactor(self):
"""Return the `Reactor` or `Reservoir` object right of the wall."""
"""
Return the `Reactor` or `Reservoir` object right of the wall.
.. versionadded:: 3.1
"""
return self._right_reactor
@property
@ -1094,6 +1105,7 @@ cdef class WallBase:
:return:
A ``graphviz.graphs.BaseGraph`` object depicting the connection.
.. versionadded:: 3.1
"""
return draw_connections([self], dot, graph_attr, node_attr, edge_attr, wall_edge_attr,
show_wall_velocity)
@ -1250,6 +1262,7 @@ cdef class FlowDevice:
def upstream(self):
"""
Return the `Reactor` or `Reservoir` object upstream of the flow device.
.. versionadded:: 3.1
"""
return self._upstream
@ -1257,6 +1270,7 @@ cdef class FlowDevice:
def downstream(self):
"""
Return the `Reactor` or `Reservoir` object downstream of the flow device.
.. versionadded:: 3.1
"""
return self._downstream
@ -1352,6 +1366,7 @@ cdef class FlowDevice:
:return:
A ``graphviz.graphs.BaseGraph`` object depicting the connection.
.. versionadded:: 3.1
"""
return draw_connections([self], dot, graph_attr, node_attr, edge_attr)
@ -1601,6 +1616,7 @@ cdef class ReactorNet:
def reactors(self):
"""
List of all reactors that are part of the reactor network.
.. versionadded:: 3.1
"""
return self._reactors
@ -2057,6 +2073,7 @@ cdef class ReactorNet:
:return:
``graphviz.graphs.BaseGraph`` object with reactor net.
.. versionadded:: 3.1
"""
return draw_reactor_net(self, graph_attr, node_attr, edge_attr, heat_flow_attr,
mass_flow_attr, print_state, **kwargs)