ambiguous dash in name or formula for z0h
Issue #9
resolved
Currently, the documentation of computing z0h is a note that refers to kb-1
.
This is ambiguous, because it can be interpreted as an identifier, or as a minus sign. It is also out of sync with the code, where the output of aerodynamic.conductance
is called kB_h
.
The docu should be adapted to use kB_h
and, if applicable, move the -1 to the other side of the equation.
I suggest providing a simple function compute_z0h
with the package and move the documentation from the note to the documentation of the new function.
Comments (2)
-
repo owner -
repo owner - changed status to resolved
- Log in to comment
Thanks for this good suggestion.
I have added a function roughness.length.heat(), which calculates z0h. This function is also included into the aerodynamic.conductance() main function. The corresponding section in ‘note’ was moved to the documentation of the new function, as suggested.
kB-1 was changed to kB_h in the documentation but the original name kB^(-1) was also maintained as this parameter is mostly known under this name (The -1 is an exponent).