]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document what function we are setting up.
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 9 May 2023 16:16:07 +0000 (10:16 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 9 May 2023 18:31:36 +0000 (12:31 -0600)
include/deal.II/trilinos/nox.templates.h

index 69d3bdbb4e35593289f5cb9739b0fbacc3122f4d..8df46cedaec5994d6a1b7660f794dd9759629c91 100644 (file)
@@ -967,7 +967,10 @@ namespace TrilinosWrappers
     // create group
     const auto group = Teuchos::rcp(new internal::NOXWrappers::Group<
                                     VectorType>(
+      /* Starting vector */
       solution,
+
+      /* Residual function */
       [&](const VectorType &x, VectorType &f) -> int {
         Assert(
           residual,
@@ -980,6 +983,8 @@ namespace TrilinosWrappers
         return internal::NOXWrappers::call_and_possibly_capture_exception(
           residual, pending_exception, x, f);
       },
+
+      /* setup_jacobian function */
       [&](const VectorType &x) -> int {
         Assert(
           setup_jacobian,
@@ -1015,6 +1020,8 @@ namespace TrilinosWrappers
 
         return flag;
       },
+
+      /* apply_jacobian function */
       [&](const VectorType &x, VectorType &v) -> int {
         Assert(
           apply_jacobian,
@@ -1027,6 +1034,8 @@ namespace TrilinosWrappers
         return internal::NOXWrappers::call_and_possibly_capture_exception(
           apply_jacobian, pending_exception, x, v);
       },
+
+      /* solve_with_jacobian function */
       [&](const VectorType &f, VectorType &x, const double tolerance) -> int {
         n_nonlinear_iterations++;
 

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.