]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Let doxygen resolve a citation in step-77. 15171/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 3 May 2023 21:17:30 +0000 (15:17 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 3 May 2023 22:27:06 +0000 (16:27 -0600)
doc/doxygen/references.bib
include/deal.II/sundials/kinsol.h

index cd63e23f43a68193d2663f7f2e0daf15e92ebfb8..2650dad9461d0186fa6b48d0f2b273e7d68f3136 100644 (file)
   URL = {https://doi.org/10.1137/0917003}
 }
 
+@book{DennisSchnabel96,
+  author = {J. E. Dennis and R. B. Schnabel},
+  title = {Numerical Methods for Unconstrained Optimization and Nonlinear Equations},
+  publisher = {Society for Industrial and Applied Mathematics},
+  year = {1996},
+  doi = {10.1137/1.9781611971200},
+  URL = {https://epubs.siam.org/doi/abs/10.1137/1.9781611971200}
+}
+
 
 %-------------------------------------------------------------------------------
 % Step 78
index 2bbc4465fb5fa4854bac836428b2746d3d2bb743..22ec87d4ff32dd857ffb36111eaa0daf8e40c188 100644 (file)
@@ -123,9 +123,8 @@ namespace SUNDIALS
    * way for furthering convergence of the nonlinear problem. This technique is
    * implemented in the second strategy, called Linesearch. This option employs
    * both the $\alpha$ and $\beta$ conditions of the Goldstein-Armijo
-   * linesearch algorithm given in *J. E. Dennis and R. B. Schnabel. "Numerical
-   * Methods for Unconstrained Optimization and Nonlinear Equations." SIAM,
-   * Philadelphia, 1996.*, where $\lambda$ is chosen to guarantee a sufficient
+   * linesearch algorithm given in @cite DennisSchnabel96 ,
+   * where $\lambda$ is chosen to guarantee a sufficient
    * decrease in $F$ relative to the step length as well as a minimum step
    * length relative to the initial rate of decrease of $F$. One property of the
    * algorithm is that the full Newton step tends to be taken close to the
@@ -150,9 +149,10 @@ namespace SUNDIALS
    * produce the new iterate. Next, the nonlinear residual function is
    * evaluated at the new iterate, and convergence is checked. The Picard and
    * fixed point methods can be significantly accelerated using Anderson's
-   * method.
+   * acceleration method.
    *
-   * The user has to provide the implementation of the following std::functions:
+   * The user has to provide the implementation of the following
+   * `std::function`s:
    *  - reinit_vector;
    * and only one of
    *  - residual;
@@ -177,7 +177,7 @@ namespace SUNDIALS
    * scaling factors for both the solution and the residual evaluation during
    * convergence checks:
    *  - get_solution_scaling;
-   *  - get_function_scaling;
+   *  - get_function_scaling.
    */
   template <typename VectorType = Vector<double>>
   class KINSOL

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.