Skip to content

Commit b72d3d1

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

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
@@ -418,6 +418,10 @@ class Flow1D : public Domain1D
418418
*/
419419
void computeRadiation(double* x, size_t jmin, size_t jmax);
420420

421+
//! @name Governing Equations
422+
//! Methods are used to evaluate residuals for each of the governing equations.
423+
//! @{
424+
421425
/**
422426
* Evaluate the continuity equation residual.
423427
*
@@ -542,6 +546,8 @@ class Flow1D : public Domain1D
542546
virtual void evalElectricField(double* x, double* rsd, int* diag,
543547
double rdt, size_t jmin, size_t jmax);
544548

549+
//! @} End of Governing Equations
550+
545551
//! Alternate version of evalContinuity with legacy signature.
546552
//! Implemented by StFlow; included here to prevent compiler warnings about shadowed
547553
//! virtual functions.
@@ -649,7 +655,7 @@ class Flow1D : public Domain1D
649655
}
650656
//! @}
651657

652-
//! @name convective spatial derivatives.
658+
//! @name Convective spatial derivatives
653659
//!
654660
//! These use upwind differencing, assuming u(z) is negative
655661
//! @{
@@ -701,12 +707,12 @@ class Flow1D : public Domain1D
701707
vector<double> m_dz;
702708

703709
// mixture thermo properties
704-
vector<double> m_rho;
705-
vector<double> m_wtm;
710+
vector<double> m_rho; //!< Vector of size #m_nsp to cache densities
711+
vector<double> m_wtm; //!< Vector of size #m_nsp to cache mean molecular weights
706712

707713
// species thermo properties
708714
vector<double> m_wt;
709-
vector<double> m_cp;
715+
vector<double> m_cp; //!< Vector of size #m_nsp to cache specific heat capacities
710716

711717
// transport properties
712718
vector<double> m_visc;
@@ -724,7 +730,7 @@ class Flow1D : public Domain1D
724730
//! Array of size #m_nsp by #m_points-1 for saving enthalpy fluxes
725731
Array2D m_dhk_dz;
726732

727-
// production rates
733+
//! Array of size #m_nsp by #m_points for saving species production rates
728734
Array2D m_wdot;
729735

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

0 commit comments

Comments
 (0)