Correct heat transfer coefficient unit in docstring#1969
Merged
ischoegl merged 1 commit intoCantera:mainfrom Sep 8, 2025
Merged
Correct heat transfer coefficient unit in docstring#1969ischoegl merged 1 commit intoCantera:mainfrom
ischoegl merged 1 commit intoCantera:mainfrom
Conversation
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.
ischoegl
approved these changes
Sep 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The C++ documentation specifies that param U is actually of unit [W/m^2/K].
The current Python documentation 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
canteraorcantera-websiterepositories, so I'm assuming the documentation is generated from the python docstrings. If that's the case, this edit should fix the issues.Changes proposed in this pull request
ct.Wallclass.If applicable, fill in the issue number this pull request is fixing
Didn't create an issue for this. Would you prefer if I create issues for minor fixes like these in the future?
If applicable, provide an example illustrating new features this pull request is introducing
See the current docs and
cantera/interfaces/cython/cantera/reactor.pyx
Lines 980 to 982 in 57b1584
Checklist
scons build&scons test) and unit tests address code coverage