]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix some documentation of SD convenience functions
authorJean-Paul Pelteret <jppelteret@gmail.com>
Sat, 27 Apr 2019 16:26:57 +0000 (18:26 +0200)
committerJean-Paul Pelteret <jppelteret@gmail.com>
Sun, 28 Apr 2019 15:22:06 +0000 (17:22 +0200)
include/deal.II/differentiation/sd/symengine_scalar_operations.h

index 777ee737df7ec056ce2f97cb060f48fed8806a99..586e87714744314a02feebb1ffcbe07c64ab97f5 100644 (file)
@@ -217,9 +217,6 @@ namespace Differentiation
      *         this scenario, for convenience, one could set
      *         @p ignore_invalid_symbols to <tt>true</tt> and these zero-valued
      *         entries would be skipped over and ignored.
-     *
-     * @note In this function, the @p ValueType is somewhat arbitrary as
-     * it is only used to create dummy values.
      */
     template <bool ignore_invalid_symbols = false>
     void
@@ -328,9 +325,9 @@ namespace Differentiation
      * data to the map in the following way:
      *
      * @code
-     *   types::substitution_map symbol_value_map = ...;
+     *   types::substitution_map substitution_map = ...;
      *   add_to_substitution_map(
-     *     symbol_value_map,
+     *     substitution_map,
      *     std::make_pair(Tensor<1,dim,Expression>(...),
      *                    Tensor<1,dim,double>(...))
      *   );
@@ -366,12 +363,12 @@ namespace Differentiation
      * data to the map in the following way:
      *
      * @code
-     *   types::substitution_map symbol_value_map = ...;
+     *   types::substitution_map substitution_map = ...;
      *   using vector_entry_t = std::vector<std::pair<
      *     Tensor<1,dim,Expression>, Tensor<1,dim,double>
      *   >>;
      *   add_to_substitution_map(
-     *     symbol_value_map,
+     *     substitution_map,
      *     vector_entry_t{
      *       {Tensor<1,dim,Expression>(...), Tensor<1,dim,double>(...)},
      *       {Tensor<1,dim,Expression>(...), Tensor<1,dim,double>(...)}
@@ -410,9 +407,9 @@ namespace Differentiation
      * the pair types. An example may be as follows:
      *
      * @code
-     *   types::substitution_map symbol_value_map = ...;
+     *   types::substitution_map substitution_map = ...;
      *   add_to_substitution_map(
-     *     symbol_value_map,
+     *     substitution_map,
      *     std::make_pair(Expression(...), 3),
      *     std::make_pair(Tensor<1,dim,Expression>(...),
      *                    Tensor<1,dim,float>(...)),
@@ -422,7 +419,7 @@ namespace Differentiation
      *
      * It is possible to map symbolic types to other symbolic types
      * using this function. For more details on this, see the other
-     * \ref make_symbol_value_map(const Expression &,const ValueType &)
+     * \ref make_substitution_map(const Expression &,const ValueType &)
      * function.
      */
     template <bool ignore_invalid_symbols = false,

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.