GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2026-08-05 10:47:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

Correct heat transfer coefficient unit in docstring

Browse Source 
The [C++ documentation](https://cantera.org/dev/cxx/db/d1e/classCantera_1_1Wall.html) specifies that param U is actually of unit [W/m^2/K].

The [current Python documentation](https://cantera.org/dev/python/zerodim.html#walls) of the calculation of the heat transfer q [W/m^2] involves U * deltaT, with deltaT of unit [K], also implying U is of unit [W/m^2/K].

From some practical experience, it seems that the current Python documentation is inaccurate with respect to U. I could not find any other references to U in the `cantera` or `cantera-website` repositories, so I'm assuming the documentation is generated from the python docstrings. If that's the case, this edit should fix the issues.
This commit is contained in:
Martijn Ruijzendaal
2025-09-08 07:13:09 -05:00
committed by Ingmar Schoegl
parent 603cb60115
commit ba8d45c14b
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
interfaces/cython/cantera/reactor.pyx
+1 -1
View File
@@ -978,7 +978,7 @@ cdef class WallBase(ConnectorNode):
:param K:
Wall expansion rate parameter [m/s/Pa]. Defaults to 0.0.
:param U:
Overall heat transfer coefficient [W/m^2]. Defaults to 0.0
Overall heat transfer coefficient [W/m^2/K]. Defaults to 0.0
(adiabatic wall).
:param Q:
Heat flux function :math:`q_0(t)` [W/m^2]. Optional. Default: