Skip to content

Commit 3dd065b

Browse files
committed
Run docstring updater
1 parent 6f66da5 commit 3dd065b

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

src/tespy/components/heat_exchangers/ntu.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,9 +386,10 @@ class NTUHeatExchanger(HeatExchanger):
386386
eps : float, dict
387387
Heat exchanger effectiveness, heat transfer over maximum transferable
388388
heat flow at constant capacity rates. Quantity: :code:`efficiency`.
389+
Equation: :py:meth:`eps_func <tespy.components.heat_exchangers.ntu.NTUHeatExchanger.eps_func>`.
389390
390391
flow_arrangement : str
391-
Flow arrangement for the effectiveness-NTU relation, one of
392+
Flow arrangement for the effectiveness-NTU relation, mandatory, one of
392393
:code:`'counterflow'`, :code:`'parallelflow'`,
393394
:code:`'crossflow_both_unmixed'`, :code:`'crossflow_hot_mixed'`,
394395
:code:`'crossflow_cold_mixed'`, :code:`'crossflow_both_mixed'`,
@@ -428,6 +429,7 @@ class NTUHeatExchanger(HeatExchanger):
428429
429430
NTU : float, dict
430431
Number of transfer units :code:`UA` over minimum capacity rate.
432+
Equation: :py:meth:`NTU_func <tespy.components.heat_exchangers.ntu.NTUHeatExchanger.NTU_func>`.
431433
432434
num_shell_passes : int
433435
Number of shell passes for the shell and tube flow arrangement (with 2,

src/tespy/components/heat_exchangers/parallel.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,12 @@ class ParallelFlowHeatExchanger(HeatExchanger):
142142
:code:`temperature_difference`.
143143
144144
ttd_l : float, dict
145-
Terminal temperature difference at hot side outlet to cold side inlet.
145+
Terminal temperature difference at hot side inlet to cold side inlet.
146146
Quantity: :code:`temperature_difference`.
147147
Equation: :py:meth:`ttd_l_func <tespy.components.heat_exchangers.parallel.ParallelFlowHeatExchanger.ttd_l_func>`.
148148
149149
ttd_u : float, dict
150-
Terminal temperature difference at hot side inlet to cold side outlet.
150+
Terminal temperature difference at hot side outlet to cold side outlet.
151151
Quantity: :code:`temperature_difference`.
152152
Equation: :py:meth:`ttd_u_func <tespy.components.heat_exchangers.parallel.ParallelFlowHeatExchanger.ttd_u_func>`.
153153

0 commit comments

Comments
 (0)