]> https://gitweb.dealii.org/ - dealii.git/commitdiff
ParameterHandler: add example for json 14563/head
authorPeter Munch <peterrmuench@gmail.com>
Sun, 11 Dec 2022 15:47:26 +0000 (16:47 +0100)
committerPeter Munch <peterrmuench@gmail.com>
Sun, 11 Dec 2022 15:47:26 +0000 (16:47 +0100)
include/deal.II/base/parameter_handler.h

index ac91eaeadccee60eae0cf9892f8e7bd1b8504d09..2ca043f2976b00084c9105aa1a6e04d3ad4b3466 100644 (file)
@@ -198,6 +198,21 @@ class MultipleParameterLoop;
  * word with a capital letter and use lowercase letters further on. The same
  * applies to the possible entry values to the right of the <tt>=</tt> sign.
  *
+ * The class can also handle json-files and XML-files. The json input file might
+ * look like the following for the previous example:
+ *   @code
+ *     {
+ *       "Nonlinear solver" : {
+ *         "Nonlinear method" : "Gradient",
+ *         "Linear solver" : {
+ *           "Solver" : "CG",
+ *           "Maximum number of iterations" : 30
+ *         }
+ *       }
+ *     }
+ *   @endcode
+ * The advantage of using json-files is that this format is natively supported
+ * by Python, simplifying the running of paramter studies tremendously.
  *
  * <h3>Including other input files</h3>
  *

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.