From 71da2131a7b17c0f98a129bc61c8f6a06e2991eb Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 27 Dec 2010 23:11:11 +0000 Subject: [PATCH] Add documentation of the GUI. git-svn-id: https://svn.dealii.org/trunk@23079 0785d39b-7218-0410-832d-ea1e28bc413d --- .../include/deal.II/base/parameter_handler.h | 34 +++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/deal.II/include/deal.II/base/parameter_handler.h b/deal.II/include/deal.II/base/parameter_handler.h index c761e6dc8b..248d2d6fe6 100644 --- a/deal.II/include/deal.II/base/parameter_handler.h +++ b/deal.II/include/deal.II/base/parameter_handler.h @@ -1227,7 +1227,34 @@ namespace Patterns * deal.II and had previously been written for a different project. * * - *

Getting entry values out of a ParameterHandler object

+ *

Using the %ParameterHandler Graphical User Interface

+ * + * An alternative to using the hand-written input files shown above is to + * use the graphical user interface (GUI) that accompanies this class. For + * this, you first need to write a description of all the parameters, their + * default values, patterns and documentation strings into a file in a + * format that the GUI can understand; this is done using the + * ParameterHandler::print_parameters() function with ParameterHandler::XML + * as second argument, as discussed in more detail below in the + * Representation of Parameters section. This file can then be loaded + * using the executable for the GUI, which should be located in + * lib/bin/dealii_parameter_gui of your deal.II installation, + * assuming that you have a sufficiently recent version of the Qt toolkit installed. + * + * Once loaded, the GUI displays subsections and individual parameters in + * tree form (see also the discussion in the Representation of + * Parameters section below). Here is a screen shot with some + * sub-sections expanded and one parameter selected for editing: + * + * @image html parameter_gui.png "Parameter GUI" + * + * Using the GUI, you can edit the values of individual parameters and + * save the result in the same format as before. It can then be read in + * using the ParameterHandler::read_input_from_xml() function. + * + * + *

Getting entry values out of a %ParameterHandler object

* * Each class gets its data out of a ParameterHandler object by * calling the get() member functions like this: @@ -1297,7 +1324,7 @@ namespace Patterns * #include * #include "../include/parameter_handler.h" * - DEAL_II_NAMESPACE_OPEN + * using namespace dealii; * * class LinEq { * public: @@ -1611,6 +1638,9 @@ namespace Patterns * ParameterHandler to satisfy the XML requirement that there * be only a single top-level construct in each file. * + * The tree structure is what the graphical user interface (see above) uses to + * represent all parameters. + * * * @ingroup input * @author Wolfgang Bangerth, October 1997, revised February 1998, 2010 -- 2.39.5