Skip to content

Commit 75dd1ee

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

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
@@ -338,6 +338,10 @@ class Flow1D : public Domain1D
338338
*/
339339
void computeRadiation(double* x, size_t jmin, size_t jmax);
340340

341+
//! @name Governing Equations
342+
//! Methods are used to evaluate residuals for each of the governing equations.
343+
//! @{
344+
341345
/**
342346
* Evaluate the continuity equation residual.
343347
*
@@ -462,6 +466,8 @@ class Flow1D : public Domain1D
462466
virtual void evalElectricField(double* x, double* rsd, int* diag,
463467
double rdt, size_t jmin, size_t jmax);
464468

469+
//! @} End of Governing Equations
470+
465471
//! Alternate version of evalContinuity with legacy signature.
466472
//! Implemented by StFlow; included here to prevent compiler warnings about shadowed
467473
//! virtual functions.
@@ -546,7 +552,7 @@ class Flow1D : public Domain1D
546552
}
547553
//! @}
548554

549-
//! @name convective spatial derivatives.
555+
//! @name Convective spatial derivatives
550556
//!
551557
//! These use upwind differencing, assuming u(z) is negative
552558
//! @{
@@ -598,12 +604,12 @@ class Flow1D : public Domain1D
598604
vector<double> m_dz;
599605

600606
// mixture thermo properties
601-
vector<double> m_rho;
602-
vector<double> m_wtm;
607+
vector<double> m_rho; //!< Vector of size #m_nsp to cache densities
608+
vector<double> m_wtm; //!< Vector of size #m_nsp to cache mean molecular weights
603609

604610
// species thermo properties
605611
vector<double> m_wt;
606-
vector<double> m_cp;
612+
vector<double> m_cp; //!< Vector of size #m_nsp to cache specific heat capacities
607613

608614
// transport properties
609615
vector<double> m_visc;
@@ -619,7 +625,7 @@ class Flow1D : public Domain1D
619625
//! Array of size #m_nsp by #m_points-1 for saving enthalpy fluxes
620626
Array2D m_dhk_dz;
621627

622-
// production rates
628+
//! Array of size #m_nsp by #m_points for saving species production rates
623629
Array2D m_wdot;
624630

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

0 commit comments

Comments
 (0)