From: Wolfgang Bangerth Date: Thu, 9 Sep 2010 15:14:49 +0000 (+0000) Subject: Add some to documentation. X-Git-Tag: v8.0.0~5548 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e46fed4316f36313a36282b71946720e8c90692c;p=dealii.git Add some to documentation. git-svn-id: https://svn.dealii.org/trunk@21910 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index df90b49bce..e6c5f8981b 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -1241,16 +1241,16 @@ namespace Patterns * "up on a matrix."); * prm.enter_subsection ("Preconditioner"); * { - * prm.declare_parameter ("Kind", - * "SSOR", - * Patterns::Selection ("SSOR|Jacobi"), - * "A string that describes the kind of preconditioner " - * "to use."); - * prm.declare_parameter ("Relaxation factor", - * "1.0", - * Patterns::Double (0, 1), - * "The numerical value (between zero and one) for the " - * "relaxation factor to use in the preconditioner."); + * prm.declare_entry ("Kind", + * "SSOR", + * Patterns::Selection ("SSOR|Jacobi"), + * "A string that describes the kind of preconditioner " + * "to use."); + * prm.declare_entry ("Relaxation factor", + * "1.0", + * Patterns::Double (0, 1), + * "The numerical value (between zero and one) for the " + * "relaxation factor to use in the preconditioner."); * } * prm.leave_subsection (); * @endcode @@ -1293,6 +1293,37 @@ namespace Patterns * ParameterHandler::XML as second argument, we can get a complete * representation of this data structure in XML. It will look like * this: + * @code + * + * + * 10 + * 10 + * A parameter that describes the maximal number of iterations the CG method is to take before giving up on a matrix. + * 0 + * [Integer range 1...1000 (inclusive)] + * + * + * SSOR + * SSOR + * A string that describes the kind of preconditioner to use. + * 1 + * SSOR|Jacobi + * + * + * 1.0 + * 1.0 + * The numerical value (between zero and one) for the relaxation factor to use in the preconditioner. + * 2 + * [Floating point range 0...1 (inclusive)] + * + * + * @endcode + * This representation closely resembles the directory/file structure + * discussed above. The only difference is that directory and file + * names are mangled: since they should only contain letters and + * numbers, every character in their names that's not one is replaced + * by an underscore followed by its two-digit hexadecimal representation. + * * * @ingroup input * @author Wolfgang Bangerth, October 1997, revised February 1998, 2010