search

oemof / tespy

Thermal Engineering Systems in Python (TESPy). This package provides a powerful simulation toolkit for thermal engineering plants such as power plants, district heating systems or heat pumps.
https://tespy.readthedocs.io
MIT License
272 stars 85 forks source link

Undocumented ttd_u/ttd_l parameters #259

Closed jelic1marko closed 3 years ago

jelic1marko commented 3 years ago

During the process of recreating systems from example scripts, as well as developing my own networks, I have noticed that there are a few parameters available to be set, but not listed in the documentation of the corresponding classes.

Namely, upper and lower terminal temperature difference values (ttd_u and ttd_l) are available to be set as attributes for instances of classes Condenser and Heat Exchanger as is demonstrated in one of the air heat pump examples and is given by cd = Condenser('condenser') ev = HeatExchanger('evaporator') [...] cd.set_attr(pr1=0.99, pr2=0.99, ttd_u=5, design=['pr2', 'ttd_u'], offdesign=['zeta2', 'kA_char']) ev.set_attr(pr1=0.999, pr2=0.99, ttd_l=5, kA_char1=kA_char1, kA_char2=kA_char2, design=['pr1', 'ttd_l'], offdesign=['zeta1', 'kA_char']) while the documentation for the Condenser class and the documentation for the Heat Exchanger class don't show ttd_u and ttd_l as available parameters, but only lists the corresponding equation.

Was this done intentionally for some reason or was it overlooked by mistake?

fwitte commented 3 years ago

That was indeed overlooked... Thank you for reporting!

jelic1marko commented 3 years ago

That was indeed overlooked... Thank you for reporting!

That was my assumption, kind of confused me at first, but since I saw that it works just fine, I continued using it normally...

fwitte commented 3 years ago

Resolved by #260, available on dev branch https://tespy.readthedocs.io/en/dev/api/tespy.components.html