From: Timo Heister <timo.heister@gmail.com>
Date: Tue, 6 Jun 2017 14:08:06 +0000 (+0200)
Subject: document function parser functions
X-Git-Tag: v9.0.0-rc1~1527^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8cabc1ea82d4f68955bdb7367bb3a15bba6ab356;p=dealii.git

document function parser functions
---

diff --git a/include/deal.II/base/function_parser.h b/include/deal.II/base/function_parser.h
index 0a29c3c7b5..9e2e057078 100644
--- a/include/deal.II/base/function_parser.h
+++ b/include/deal.II/base/function_parser.h
@@ -47,6 +47,20 @@ template <typename> class Vector;
  * used in the step-33 and step-36 tutorial programs (the latter being much
  * simpler to understand).
  *
+ * In addition to the built-in functions of muparser, namely
+ * @code
+ * sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, asinh, acosh, atanh,
+ * atan2, log2, log10, log, ln, exp, sqrt, sign, rint, abs, min, max, sum, avg
+ * @endcode
+ * this class also supports:
+ * - <tt>if(condition, then-value, else-value)</tt>
+ * - <tt>|</tt> and <tt>&</tt> (logic or and and)
+ * - <tt>int(x)</tt>, <tt>ceil(x)</tt>, <tt>floor(x)</tt> (rounding)
+ * - <tt>cot(x)</tt>, <tt>csc(x)</tt>, <tt>sec(x)</tt>
+ * - <tt>pow(x,n)</tt>, <tt>log(x)</tt>
+ * - <tt>erfc(x)</tt>
+ * - <tt>rand()</tt>, <tt>rand_seed(seed)</tt>
+ *
  * The following examples shows how to use this class:
  * @code
  * // set up problem: