]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 28 Feb 1999 19:28:28 +0000 (19:28 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 28 Feb 1999 19:28:28 +0000 (19:28 +0000)
git-svn-id: https://svn.dealii.org/trunk@926 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/parameter_handler.h

index 126414a5e481aaead233f8aff0e6bf2b2682e34a..f94dcd541c12a61041c120c4ef9314393bfb6fbc 100644 (file)
@@ -338,7 +338,21 @@ struct Patterns {
  *   a function named #get_parameters#. This should be declared #virtual#. #get_parameters#
  *   functions in derived classes should call the #BaseClass::get_parameters# function.
  *
- *   
+ *
+ *   \subsection{Experience with large parameter lists}
+ *  
+ *   Experience has shown that in programs defining larger numbers of parameters (more than,
+ *   say, fifty) it is advantageous to define an additional class holding these parameters.
+ *   This class is more like a C-style structure, having a large number of variables,
+ *   usually public. It then has at least two functions, which declare and parse the
+ *   parameters. In the main program, the main class has an object of this parameter class
+ *   and delegates declaration and parsing of parameters to this object.
+ *
+ *   The advantage of this approach is that you can keep out the technical details
+ *   (declaration and parsing) out of the main class and additionally don't clutter
+ *   up your main class with dozens or more variables denoting the parameters.
+ *
+ *
  *   \subsection{Possible future extensions}
  *   
  *   \begin{itemize}

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.