From 1e056e12741d91928ccea4f429db34d6d78f82c7 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Sun, 31 May 2009 16:24:35 +0000 Subject: [PATCH] Added doxygen comments. --- Cantera/src/oneD/Domain1D.h | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/Cantera/src/oneD/Domain1D.h b/Cantera/src/oneD/Domain1D.h index 0b470aad2..4e309aaa8 100644 --- a/Cantera/src/oneD/Domain1D.h +++ b/Cantera/src/oneD/Domain1D.h @@ -277,10 +277,13 @@ namespace Cantera { eval(-1,x,r,mask,0.0); } - /** - * Evaluate the residual function at point j. If j < 0, - * evaluate the residual function at all points. - */ + //! Evaluate the residual function at point j. If j < 0, + //! evaluate the residual function at all points. + /*! + * @param j Grid point j + * @param x Soln vector. This is the input. + * @param r residual this is the output. + */ virtual void eval(int j, doublereal* x, doublereal* r, integer* mask, doublereal rdt=0.0); @@ -492,8 +495,17 @@ namespace Cantera { OneDim* m_container; int m_index; int m_type; + + //! Starting location within the solution vector for unknowns + //! that correspond to this domain + /*! + * Remember there may be multiple domains associated with + * this problem + */ int m_iloc; + int m_jstart; + Domain1D *m_left, *m_right; std::string m_id, m_desc; Refiner* m_refiner;