From: Peter Munch <peterrmuench@gmail.com>
Date: Sun, 11 Dec 2022 15:47:26 +0000 (+0100)
Subject: ParameterHandler: add example for json
X-Git-Tag: v9.5.0-rc1~738^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=26948a100ae137653277bf182dc0b8d7657f3f92;p=dealii.git

ParameterHandler: add example for json
---

diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h
index ac91eaeadc..2ca043f297 100644
--- a/include/deal.II/base/parameter_handler.h
+++ b/include/deal.II/base/parameter_handler.h
@@ -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>
  *