]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix documentation. 7905/head
authorLuca Heltai <luca.heltai@sissa.it>
Thu, 2 May 2019 07:58:30 +0000 (09:58 +0200)
committerLuca Heltai <luca.heltai@sissa.it>
Thu, 2 May 2019 07:58:30 +0000 (09:58 +0200)
include/deal.II/base/parsed_convergence_table.h
source/base/parsed_convergence_table.cc

index 32b14fe04a4dd73bb59ae287dca06740313027a7..8fd6d75c805d8a5d46e61d381f7ce0a5ede9ed41 100644 (file)
@@ -228,10 +228,10 @@ public:
    * # The exponent to use when computing p-norms.
    * set Exponent for p-norms             = 2
    *
-   * # Each component is separated by a semicolon, and each norm by a comma.
-   * # Implemented norms are Linfty, L2, W1infty, H1, and custom. If you want to
-   * # skip a component, use none.
-   * set List of error norms to compute   = Linfty, L2, H1
+   * # Each component is separated by a semicolon and each norm by a comma. See
+   * # the documentation of VectorTools::NormType for a list of implemented
+   * # norms. If you want to skip a component, leave its entry empty.
+   * set List of error norms to compute   = Linfty_norm, L2_norm, H1_norm
    *
    * # Key to use when computing convergence rates. If this is set to a
    * # column that is not present, or to none, then no error rates are computed.
index 72761b30655f1a0b00c494f01cf6c19b54e841ab..cb00e76f1c8a2b01a8a7d4c96dd1500b1ee0299b 100644 (file)
@@ -125,8 +125,9 @@ ParsedConvergenceTable::add_parameters(ParameterHandler &prm)
     "List of error norms to compute",
     norms_per_unique_component,
     "Each component is separated by a semicolon "
-    "and each norm by a comma. Implemented norms are Linfty, L2, "
-    "W1infty, H1, and custom. If you want to skip a component, use none.");
+    "and each norm by a comma. See the documentation of VectorTools::NormType "
+    "for a list of implemented norms. If you want to skip a component, leave "
+    "its entry empty.");
 
 
   prm.add_parameter("Exponent for p-norms",

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.