From: Martin Kronbichler <martin.kronbichler@rub.de>
Date: Fri, 5 Jul 2024 06:30:47 +0000 (+0200)
Subject: Merge pull request #17194 from bangerth/petsc-ts-rename-2
X-Git-Tag: v9.6.0-rc1~137
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=94532f1e38c47a21adddaeb00d09a12dab284fe2;p=dealii.git

Merge pull request #17194 from bangerth/petsc-ts-rename-2

Rename a second callback in PETScWrappers::TimeStepper.
---

94532f1e38c47a21adddaeb00d09a12dab284fe2
diff --cc include/deal.II/lac/petsc_ts.h
index b4fa23918c,ebefa3d4f8..538fd7e596
--- a/include/deal.II/lac/petsc_ts.h
+++ b/include/deal.II/lac/petsc_ts.h
@@@ -610,14 -603,31 +610,32 @@@ namespace PETScWrapper
       * See there for a description of how to deal with errors and other
       * requirements and conventions.
       */
 -    std::function<void(const real_type t, VectorType &y)> distribute;
 +    std::function<void(const real_type t, VectorType &y)>
 +      update_constrained_components;
  
      /**
-      * Callback to set up mesh adaption.
+      * This callback is equivalent to `decide_and_prepare_for_remeshing`
+      * except that it returns the decision whether or not to stop
+      * operations via the last reference argument of the function
+      * object instead of a plain return value. This callback is
+      * deprecated. Use `decide_and_prepare_for_remeshing` instead.
+      */
+     std::function<void(const real_type    t,
+                        const unsigned int step,
+                        const VectorType  &y,
+                        bool              &resize)>
+       decide_for_coarsening_and_refinement;
+ 
+     /**
+      * A callback that returns whether or not to stop time stepping at the
+      * current moment for mesh adaptation. If the callback returns `true`,
+      * then the time stepper stops time integration for now, saves some state,
+      * calls the `interpolate` callback, and then resumes time integration.
+      * Either in the current callback or the `interpolate` callback, the
+      * user code needs to perform the mesh refinement.
       *
-      * Implementation of this function is optional.
-      * @p resize must be set to true if mesh adaption is to be performed, false
+      * Implementation of this function is optional. The callback
+      * must return `true` if mesh adaption is to be performed, `false`
       * otherwise.
       * The @p y vector contains the current solution, @p t the current time,
       * @ step the step number.