Skip to content

Commit 049ae1c

Browse files
committed
[oneD] Add named doxygen section for governing equations
Also, add missing member variable documentation.
1 parent c5bbf80 commit 049ae1c

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

include/cantera/oneD/Flow1D.h

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,10 @@ class Flow1D : public Domain1D
356356
*/
357357
void computeRadiation(double* x, size_t jmin, size_t jmax);
358358

359+
//! @name Governing Equations
360+
//! Methods are used to evaluate residuals for each of the governing equations.
361+
//! @{
362+
359363
/**
360364
* Evaluate the continuity equation residual.
361365
*
@@ -480,6 +484,8 @@ class Flow1D : public Domain1D
480484
virtual void evalElectricField(double* x, double* rsd, int* diag,
481485
double rdt, size_t jmin, size_t jmax);
482486

487+
//! @} End of Governing Equations
488+
483489
//! Alternate version of evalContinuity with legacy signature.
484490
//! Implemented by StFlow; included here to prevent compiler warnings about shadowed
485491
//! virtual functions.
@@ -564,7 +570,7 @@ class Flow1D : public Domain1D
564570
}
565571
//! @}
566572

567-
//! @name convective spatial derivatives.
573+
//! @name Convective spatial derivatives
568574
//!
569575
//! These use upwind differencing, assuming u(z) is negative
570576
//! @{
@@ -616,12 +622,12 @@ class Flow1D : public Domain1D
616622
vector<double> m_dz;
617623

618624
// mixture thermo properties
619-
vector<double> m_rho;
620-
vector<double> m_wtm;
625+
vector<double> m_rho; //!< Vector of size #m_nsp to cache densities
626+
vector<double> m_wtm; //!< Vector of size #m_nsp to cache mean molecular weights
621627

622628
// species thermo properties
623629
vector<double> m_wt;
624-
vector<double> m_cp;
630+
vector<double> m_cp; //!< Vector of size #m_nsp to cache specific heat capacities
625631

626632
// transport properties
627633
vector<double> m_visc;
@@ -639,7 +645,7 @@ class Flow1D : public Domain1D
639645
//! Array of size #m_nsp by #m_points-1 for saving enthalpy fluxes
640646
Array2D m_dhk_dz;
641647

642-
// production rates
648+
//! Array of size #m_nsp by #m_points for saving species production rates
643649
Array2D m_wdot;
644650

645651
size_t m_nsp; //!< Number of species in the mechanism

0 commit comments

Comments
 (0)