[pyfr] 11/88: Document errest-norm in the user guide.

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch master
in repository pyfr.

commit 15de368ea09aec922e3ec31f8f937f29dd194ec5
Author: Freddie Witherden <freddie at witherden.org>
Date:   Tue Apr 19 12:05:14 2016 -0700

    Document errest-norm in the user guide.
---
 doc/src/user_guide.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/src/user_guide.rst b/doc/src/user_guide.rst
index 9478317..c2570b7 100644
--- a/doc/src/user_guide.rst
+++ b/doc/src/user_guide.rst
@@ -379,6 +379,10 @@ Parameterises the time-integration scheme used by the solver with
 
            *float*
 
+        - ``errest-norm`` --- norm to use for estimating the error
+
+           ``uniform`` | ``l2``
+
         - ``safety-fact`` --- safety factor for step size adjustment
           (suitable range 0.80-0.95)
 
@@ -404,6 +408,7 @@ Example::
     dt = 0.001
     atol = 0.00001
     rtol = 0.00001
+    errest-norm = l2
     safety-fact = 0.9
     min-fact = 0.3
     max-fact = 2.5

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pyfr.git