Cantera / cantera-website

Official Cantera Website
https://cantera.org
Other
14 stars 26 forks source link

Mole-based reactors are undocumented #244

Closed speth closed 1 year ago

speth commented 1 year ago

The governing equations for the mole-based reactor types (MoleReactor, ConstPressureMoleReactor, IdealGasMoleReactor, and IdealGasConstPressureMoleReactor) need to be documented here: https://cantera.org/science/reactors/reactors.html#reactor-types-and-governing-equations.

@anthony-walker, can you help with this?

anthony-walker commented 1 year ago

@speth sure thing!

ischoegl commented 1 year ago

@anthony-walker ... while this is on the main repository, could you also add a little to docstrings handled by Doxygen?

anthony-walker commented 1 year ago

@ischoegl I will have a look.

ischoegl commented 1 year ago

@ischoegl I will have a look.

Thank you! One thing we just added is the Doxygen @cite feature to support BibTeX citations. See https://cantera.org/documentation/dev/doxygen/html/d0/de3/citelist.html