From 9043cc76b79aa83f57f97170affc390a533ce792 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 12 Dec 2014 21:50:47 -0600 Subject: [PATCH] Clean up documentation a bit. --- include/deal.II/base/function_parser.h | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/include/deal.II/base/function_parser.h b/include/deal.II/base/function_parser.h index 9296dbb68c..2a7417a1ed 100644 --- a/include/deal.II/base/function_parser.h +++ b/include/deal.II/base/function_parser.h @@ -364,29 +364,39 @@ public: private: #ifdef DEAL_II_WITH_MUPARSER /** - * place for the variables for each thread + * Place for the variables for each thread */ mutable Threads::ThreadLocalStorage > vars; + /** - * the muParser objects for each thread (and one for each component) + * The muParser objects for each thread (and one for each component) */ mutable Threads::ThreadLocalStorage > fp; /** - * keep track of all the constants, required to initialize fp in each - * thread + * An array to keep track of all the constants, required to + * initialize fp in each thread. */ std::map constants; + /** - * variable names, required to initialize fp in each thread + * An array for the variable names, required to initialize fp in + * each thread. */ std::vector var_names; + /** - * the expressions, required to initialize fp in each thread + * An array of function expressions (one per component), required to + * initialize fp in each thread. */ std::vector expressions; + /** - * this function will initialize fp on the current thread + * Initialize fp and vars on the current thread. This function may + * only be called once per thread. A thread can test whether the + * function has already been called by testing whether + * 'fp.get().size()==0' (not initialized) or >0 (already + * initialized). */ void init_muparser() const; #endif -- 2.39.5