Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fwitte committed Feb 13, 2020
1 parent 04773d6 commit 9582cae
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions tespy/components/components.py
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,18 @@ def zeta_func(self, zeta='', conn=0):
r"""
Calculate residual value of :math:`\zeta`-function.
Parameters
----------
zeta : str
Component parameter to evaluate the zeta_func on, e. g.
:code:`zeta1`.
conn : int
Connection number of inlet and corresponding outlet.
In order to use the zeta function, the index of the inlet and
the corresponding outlet within the components :code:`ìnl` and
:code:`outl` respectively must be identical!
Returns
-------
val : float
Expand Down
2 changes: 1 addition & 1 deletion tespy/components/reactors.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ class water_electrolyzer(component):
pressure is 25 bars. The electrolysis efficiency is at 80 % and the
compressor isentropic efficiency at 85 %. After designing the plant the
offdesign electrolysis efficiency is predicted by the characteristic line.
TODO: LINKTODEFAULTCHAR?
The default characteristic line can be found here: :py:mod:`tespy.data`.
>>> fw_el = connection(fw, 'out1', el, 'in2')
>>> el_o = connection(el, 'out2', oxy, 'in1')
Expand Down

0 comments on commit 9582cae

Please sign in to comment.