From 11bea7fc7d0ac0b4ec7331339d3d17204661f1e0 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 21 Apr 1998 14:18:36 +0000 Subject: [PATCH] Doc update. git-svn-id: https://svn.dealii.org/trunk@182 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/function.h | 2 +- deal.II/base/include/base/parameter_handler.h | 15 ++++++++++++--- deal.II/deal.II/include/numerics/data_io.h | 2 +- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/deal.II/base/include/base/function.h b/deal.II/base/include/base/function.h index 37f9c941a8..fbdcd31891 100644 --- a/deal.II/base/include/base/function.h +++ b/deal.II/base/include/base/function.h @@ -6,7 +6,7 @@ #include -#include +#include #include diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index 086e5a5760..20ff371172 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -10,8 +10,8 @@ class ParameterHandler; class MultipleParameterLoop; -#include -#include +#include +#include #include @@ -214,7 +214,7 @@ enum OutputStyle { It is guaranteed that only entries matching the given regular expression are returned, i.e. an input entry value which does not match the regular expression is not stored. - You can use #get# to retreive the parameter in text form, #get_integer# to get an integer + You can use #get# to retrieve the parameter in text form, #get_integer# to get an integer or #get_double# to get a double. It will cause an internal error if the string could not be converted to an integer or a double. This should, though, not happen if you correctly specified the regular expression for this entry; you should not @@ -222,6 +222,15 @@ enum OutputStyle { expression was set. The internal error is raised through the #Assert()# macro family which only works in debug mode. + If you want to print out all user selectable features, use the + #print_parameters# function. It is generally a good idea to print all parameters + at the beginning of a log file, since this way input and output are together in + one file which makes matching at a later time easier. Additionally, the function + also print those entries which have not been modified in the input file und are + thus set to default values; since default values may change in the process of + program development, you cannot know the values of parameters not specified in the + input file. + {\bf Style guide for data retrieval} diff --git a/deal.II/deal.II/include/numerics/data_io.h b/deal.II/deal.II/include/numerics/data_io.h index 1a31d95efc..4cb4f8ed84 100644 --- a/deal.II/deal.II/include/numerics/data_io.h +++ b/deal.II/deal.II/include/numerics/data_io.h @@ -5,7 +5,7 @@ /*---------------------------- io.h ---------------------------*/ #include -#include +#include #include template class Triangulation; -- 2.39.5