]> https://gitweb.dealii.org/ - dealii.git/commitdiff
document function parser functions 4489/head
authorTimo Heister <timo.heister@gmail.com>
Tue, 6 Jun 2017 14:08:06 +0000 (16:08 +0200)
committerTimo Heister <timo.heister@gmail.com>
Tue, 6 Jun 2017 14:09:51 +0000 (16:09 +0200)
include/deal.II/base/function_parser.h

index 0a29c3c7b5f924490b7573a3c6fcfd795f98731c..9e2e057078b59df40b75c386706cc11104189e50 100644 (file)
@@ -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:

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.