Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'piecewise-Gibbs' missing from Science section #249

Closed
ischoegl opened this issue Jul 18, 2023 · 0 comments · Fixed by Cantera/cantera#1647
Closed

'piecewise-Gibbs' missing from Science section #249

ischoegl opened this issue Jul 18, 2023 · 0 comments · Fixed by Cantera/cantera#1647
Labels
discussion documentation-update An update is needed to the documentation

Comments

@ischoegl
Copy link
Member

ischoegl commented Jul 18, 2023

Reviewing species thermo models, it appears that piecewise-Gibbs is missing from the Science section, although it is documented in the C++ Mu0Poly docstring as well as the YAML Input File Reference.

"Science" documentation for other species thermo models is redundant, as corresponding equations also appear in docstrings, see NasaPoly1, Nasa9Poly1, Shomate and constant-cp (together with 2 temperature versions). I'd also like to note that variations in naming make it quite hard to locate C++ classes that handle these models; there is no link from science docs to the actual implementation.

Separate from this, there is also some doxygen documentation.

I opened this issue mainly to document a case in the context of Cantera/enhancements#178. The situation illustrates the conundrum of where to stick the documentation quite well. I do not think that it makes sense to fix it without considering the greater context.

@ischoegl ischoegl added documentation-update An update is needed to the documentation discussion labels Jul 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion documentation-update An update is needed to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant