Documentation of set_user_pf_options

[jkisse]

Discussed in #424

^{Originally posted by amayboudellal October 27, 2022}
Hi,

I'm trying to run a pipeflow on a district heating grid and specified pp.pipeflow(net, mode='heat') as it seemed to make the most sense. I then specified pp.set_user_pf_options(net, reset=False) but I get the error that I need to define hyd_flag. However, I cannot find any documentation or hint about what is meant by that and what are the expected arguments.

Could someone help me with that? Thanks.

---

remark: The list of options needs to be included in the documentation. Similar to the list here (and it should be checked whether that list is up-to-date).

[jkisse]

Hi amayboudellal, if you choose mode='heat', no hydraulic simulation will be conducted (only heat transfer). For hydraulic & heat transfer calculation, please choose mode='all'.
The hyd_flag indicates whether hydraulic results are available or not.