]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add placeholder for documentation on symbolic differentiation 7984/head
authorJean-Paul Pelteret <jppelteret@gmail.com>
Wed, 1 May 2019 09:51:41 +0000 (11:51 +0200)
committerJean-Paul Pelteret <jppelteret@gmail.com>
Wed, 1 May 2019 09:51:41 +0000 (11:51 +0200)
doc/doxygen/headers/automatic_and_symbolic_differentiation.h

index 2a15a2ae0b098f00cf98642f57fbc4773f44b1fe..98b908300e046c5f7bdd12d7e518fb5ca91182eb 100644 (file)
 // ---------------------------------------------------------------------
 
 /**
- * @defgroup auto_symb_diff Automatic differentiation
+ * @defgroup auto_symb_diff Automatic and symbolic differentiation
  *
  * @brief A module dedicated to the implementation of functions and classes that relate
- * to automatic differentiation.
+ * to automatic and symbolic differentiation.
  *
- * Below we provide a very brief introduction as to what automatic differentiation is,
- * what variations of this computational / numerical scheme exist, and how it is integrated
+ * Below we provide a very brief introduction as to what automatic and symbolic differentiation are,
+ * what variations of these computational / numerical schemes exist, and how they are integrated
  * within deal.II's framework.
  *
  * @section auto_diff_1 Automatic differentiation
  * - a <a href="https://github.com/dealii/code-gallery/tree/master/Quasi_static_Finite_strain_Compressible_Elasticity">code-gallery example</a>, and
  * - our <a href="https://github.com/dealii/dealii/tree/master/tests/sacado">test-suite</a>.
  *
+ *
+ * @section symb_diff_1 Symbolic differentiation
+ *
+ * TODO. As a temporary placeholder, here is a link to the Wikipedia article on
+ * <a href="https://en.wikipedia.org/wiki/Symbolic_differentiation">symbolic differentiation</a> and the
+ * <a href="https://www.sympy.org/en/index.html">SymPy</a> library.
  */

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.