[docs] Move 1D radiation comments to Doxygen

Cantera · Aug 2, 2023 · 9c026e7 · 9c026e7
1 parent 122b791
commit 9c026e7
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 19 deletions.
diff --git a/doc/doxygen/cantera.bib b/doc/doxygen/cantera.bib
@@ -229,3 +229,19 @@ @article{kim2019
     url = {https://dx.doi.org/10.1093/nar/gky1033},
     volume = {47},
     year = {2019}}
+@conference{liu1991,
+    author = {Y.~Liu and B.~Rogg},
+    journal = {EUROTHERM Seminars},
+    pages = {114--127},
+    title = {Modelling of thermally radiating diffusion flames with detailed
+        chemistry and transport},
+    volume = {17},
+    year = {1991}}
+@techreport{RADCAL,
+    author = {W.~L.~Grosshandler},
+    institution = {National Institute of Standards and Technology},
+    number = {1402},
+    title = {{RADCAL}: A Narrow-Band Model for Radiation Calculations in a Combustion
+        Environment},
+    url = {https://nvlpubs.nist.gov/nistpubs/Legacy/TN/nbstechnicalnote1402.pdf},
+    year = {1993}}
diff --git a/include/cantera/oneD/StFlow.h b/include/cantera/oneD/StFlow.h
@@ -233,10 +233,16 @@ class StFlow : public Domain1D
 
     //! Turn radiation on / off.
     /*!
-     *  The simple radiation model used was established by Y. Liu and B. Rogg
-     *  [Y. Liu and B. Rogg, Modelling of thermally radiating diffusion flames
-     *  with detailed chemistry and transport, EUROTHERM Seminars, 17:114-127,
-     *  1991]. This model considers the radiation of CO2 and H2O.
+     * The simple radiation model used was established by Liu and Rogg
+     * @cite liu1991. This model considers the radiation of CO2 and H2O.
+     *
+     * This model uses the optically thin limit and the gray-gas approximation to
+     * simply calculate a volume specified heat flux out of the Planck absorption
+     * coefficients, the boundary emissivities and the temperature. Polynomial lines
+     * calculate the species Planck coefficients for H2O and CO2. The data for the
+     * lines are taken from the RADCAL program @cite RADCAL.
+     * The coefficients for the polynomials are taken from
+     * [TNF Workshop](https://tnfworkshop.org/radiation/) material.
      */
     void enableRadiation(bool doRadiation) {
         m_do_radiation = doRadiation;

diff --git a/src/oneD/StFlow.cpp b/src/oneD/StFlow.cpp
@@ -408,21 +408,7 @@ void StFlow::evalResidual(double* x, double* rsd, int* diag,
     // grid points
     //----------------------------------------------------
 
-    // calculation of qdotRadiation
-
-    // The simple radiation model used was established by Y. Liu and B. Rogg [Y.
-    // Liu and B. Rogg, Modelling of thermally radiating diffusion flames with
-    // detailed chemistry and transport, EUROTHERM Seminars, 17:114-127, 1991].
-    // This model uses the optically thin limit and the gray-gas approximation
-    // to simply calculate a volume specified heat flux out of the Planck
-    // absorption coefficients, the boundary emissivities and the temperature.
-    // The model considers only CO2 and H2O as radiating species. Polynomial
-    // lines calculate the species Planck coefficients for H2O and CO2. The data
-    // for the lines is taken from the RADCAL program [Grosshandler, W. L.,
-    // RADCAL: A Narrow-Band Model for Radiation Calculations in a Combustion
-    // Environment, NIST technical note 1402, 1993]. The coefficients for the
-    // polynomials are taken from [http://www.sandia.gov/TNF/radiation.html].
-
+    // calculation of qdotRadiation (see docstring of enableRadiation)
     if (m_do_radiation) {
         // variable definitions for the Planck absorption coefficient and the
         // radiation calculation: