NodeABecLaplacian: Reuse (#3579)

WeiqunZhang · web-flow · commit 87556458d867 · 2023-10-03T17:13:36.000-07:00
Add reuse capability to NodeABecLaplacian. More specifically, we need to
average down coefficients again.
diff --git a/.codespell-ignore-words b/.codespell-ignore-words
@@ -27,6 +27,7 @@ parms
 pres
 ptd
 recuse
+shft
 siz
 structed
 te
diff --git a/Src/AmrCore/AMReX_AmrMesh.H b/Src/AmrCore/AMReX_AmrMesh.H
@@ -170,7 +170,7 @@ public:
     void SetGridEff (Real eff) noexcept { grid_eff = eff; }
     void SetNProper (int n) noexcept { n_proper = n; }
 
-    //! Set ref_ratio would require rebuiling Geometry objects.
+    //! Set ref_ratio would require rebuilding Geometry objects.
 
     void SetFinestLevel (int new_finest_level) noexcept { finest_level = new_finest_level; }
     void SetDistributionMap (int lev, const DistributionMapping& dmap_in) noexcept;
diff --git a/Src/Base/AMReX_CoordSys.H b/Src/Base/AMReX_CoordSys.H
@@ -54,7 +54,7 @@ public:
         BL_ASSERT(c_sys != undef); return (c_sys == RZ);
     }
 
-    //! Is CoordType == cartesion?
+    //! Is CoordType == cartesian?
     [[nodiscard]] bool IsCartesian () const noexcept {
         BL_ASSERT(c_sys != undef); return (c_sys == cartesian);
     }
diff --git a/Src/Base/AMReX_FACopyDescriptor.H b/Src/Base/AMReX_FACopyDescriptor.H
@@ -698,7 +698,7 @@ FabArrayCopyDescriptor<FAB>::CollectData ()
         amrex::The_Arena()->free(md_recv_data);
     }
 
-    // Wait and upack data
+    // Wait and unpack data
     if (N_rcvs > 0)
     {
         Vector<MPI_Status> stats(N_rcvs);
diff --git a/Src/Base/AMReX_FArrayBox.H b/Src/Base/AMReX_FArrayBox.H
@@ -23,7 +23,7 @@ class FArrayBox;
 * only want to write out 32 bit FABs.
 *
 * With the exception of the enumeration constants, this class is
-* primarily for FArrayBox implementors; i.e. user's shouldn't
+* primarily for FArrayBox implementers; i.e. user's shouldn't
 * call any of the member functions in this class directly.
 */
 
@@ -241,7 +241,7 @@ public:
 
     /**
     * \brief Construct an initial FAB with the data space allocated but
-    * not inititialized. ncomp is the number of components
+    * not initialized. ncomp is the number of components
     * (variables) at each data point in the Box.
     */
     explicit FArrayBox (const Box& b,
@@ -409,7 +409,7 @@ public:
     /**
     * \brief Set the FABio::Format in the program.
     * This is the preferred way to set the output format
-    * in "new" FABs.  When desiging new programs, this should
+    * in "new" FABs.  When designing new programs, this should
     * be the only function that needs to be called in order
     * to set the format.
     */
diff --git a/Src/Base/AMReX_IArrayBox.H b/Src/Base/AMReX_IArrayBox.H
@@ -58,7 +58,7 @@ public:
 
     /**
     * \brief Construct an initial FAB with the data space allocated but
-    * not inititialized. ncomp is the number of components
+    * not initialized. ncomp is the number of components
     * (variables) at each data point in the Box.
     */
     explicit IArrayBox (const Box& b,
diff --git a/Src/Base/AMReX_NonLocalBC.H b/Src/Base/AMReX_NonLocalBC.H
@@ -264,7 +264,7 @@ struct MultiBlockCommMetaData : FabArrayBase::CommMetaData {
 //                                                           [concept.FabProjection]
 //
 
-//! \brief This type trait tests if a type P is a projetion for FAB.
+//! \brief This type trait tests if a type P is a projection for FAB.
 template <typename P, typename FAB>
 struct IsFabProjection
     : IsCallableR<typename FAB::value_type, P, Array4<const typename FAB::value_type>, Dim3, int>
diff --git a/Src/EB/AMReX_EB_StateRedistribute.cpp b/Src/EB/AMReX_EB_StateRedistribute.cpp
@@ -176,7 +176,7 @@ MLStateRedistribute ( Box const& bx, int ncomp,
 
                 if (domain_per_grown.contains(IntVect(AMREX_D_DECL(r,s,t))))
                 {
-                    // Initialize so that the slope stencil goes from -1:1 in each diretion
+                    // Initialize so that the slope stencil goes from -1:1 in each direction
                     int nx = 1; int ny = 1; int nz = 1;
 
                     // Do we have enough extent in each coordinate direction to use the 3x3x3 stencil
@@ -511,7 +511,7 @@ StateRedistribute ( Box const& bx, int ncomp,
                     bool extdir_khi = (d_bcrec_ptr[n].hi(2) == amrex::BCType::ext_dir ||
                                        d_bcrec_ptr[n].hi(2) == amrex::BCType::hoextrap);
 #endif
-                    // Initialize so that the slope stencil goes from -1:1 in each diretion
+                    // Initialize so that the slope stencil goes from -1:1 in each direction
                     int nx = 1; int ny = 1; int nz = 1;
 
                     // Do we have enough extent in each coordinate direction to use the 3x3x3 stencil
diff --git a/Src/Extern/HYPRE/AMReX_HypreNodeLap.cpp b/Src/Extern/HYPRE/AMReX_HypreNodeLap.cpp
@@ -47,7 +47,7 @@ HypreNodeLap::HypreNodeLap (const BoxArray& grids_, const DistributionMapping& d
     Int nnodes_proc = fill_local_node_id();
 
     // At this point, local_node_id stores the ids local to each box.
-    // nnodes_grid stroes the number of nodes in each box.  nnodes_proc is
+    // nnodes_grid stores the number of nodes in each box.  nnodes_proc is
     // the number of nodes on this MPI process.  If a nodal is invalid, its
     // id is invalid (i.e., a very negative number).  Note that the data
     // type of local_node_id is int, not HYPRE_Int for performance on GPU.
diff --git a/Src/Extern/HYPRE/AMReX_HypreSolver.H b/Src/Extern/HYPRE/AMReX_HypreSolver.H
@@ -220,7 +220,7 @@ HypreSolver<MSS>::HypreSolver (Vector<IndexType>   const& a_index_type,
     fill_local_id(a_marker);
 
     // At this point, m_local_id stores the ids local to each box.
-    // m_nrows_grid stroes the number of unique points in each box.
+    // m_nrows_grid stores the number of unique points in each box.
     // m_nrows_proc is the number of rowss for all variables on this MPI
     // process.  If a point is invalid, its id is invalid (i.e., a very
     // negative number).  Note that the data type of local_node_id is int,
diff --git a/Src/LinearSolvers/MLMG/AMReX_MLNodeABecLaplacian.H b/Src/LinearSolvers/MLMG/AMReX_MLNodeABecLaplacian.H
@@ -65,12 +65,18 @@ public:
 
     void prepareForSolve () final;
 
+    [[nodiscard]] bool needsUpdate () const final { return m_needs_update; }
+
+    void update () final;
+
     void averageDownCoeffs ();
     void averageDownCoeffsToCoarseAmrLevel (int flev);
     void averageDownCoeffsSameAmrLevel (int amrlev);
 
 private:
 
+    bool m_needs_update = true;
+
     Real m_a_scalar = std::numeric_limits<Real>::quiet_NaN();
     Real m_b_scalar = std::numeric_limits<Real>::quiet_NaN();
     Vector<Vector<MultiFab> > m_a_coeffs;
diff --git a/Src/LinearSolvers/MLMG/AMReX_MLNodeABecLaplacian.cpp b/Src/LinearSolvers/MLMG/AMReX_MLNodeABecLaplacian.cpp
@@ -55,26 +55,30 @@ void
 MLNodeABecLaplacian::setACoeffs (int amrlev, Real a_acoef)
 {
     m_a_coeffs[amrlev][0].setVal(a_acoef);
+    m_needs_update = true;
 }
 
 void
 MLNodeABecLaplacian::setACoeffs (int amrlev, const MultiFab& a_acoef)
 {
     const int ncomp = getNComp();
     m_a_coeffs[amrlev][0].LocalCopy(a_acoef, 0, 0, ncomp, IntVect(0));
+    m_needs_update = true;
 }
 
 void
 MLNodeABecLaplacian::setBCoeffs (int amrlev, Real a_bcoef)
 {
     m_b_coeffs[amrlev][0].setVal(a_bcoef);
+    m_needs_update = true;
 }
 
 void
 MLNodeABecLaplacian::setBCoeffs (int amrlev, const MultiFab& a_bcoef)
 {
     const int ncomp = getNComp();
     m_b_coeffs[amrlev][0].LocalCopy(a_bcoef, 0, 0, ncomp, IntVect(0));
+    m_needs_update = true;
 }
 
 void
@@ -251,6 +255,16 @@ MLNodeABecLaplacian::prepareForSolve ()
     buildMasks();
 
     averageDownCoeffs();
+
+    m_needs_update = false;
+}
+
+void
+MLNodeABecLaplacian::update ()
+{
+    BL_PROFILE("MLNodeABecLaplacian::prepareForSolve()");
+    averageDownCoeffs();
+    m_needs_update = false;
 }
 
 void
diff --git a/Tests/HDF5Benchmark/sz.config b/Tests/HDF5Benchmark/sz.config
@@ -76,7 +76,7 @@ relBoundRatio = 1E-9
 pw_relBoundRatio = 1E-2
 
 #point-wise relative-error-bound segment size
-#The larger this value, the lower overhead of maitaining error bound information for each segment/block, while the stricter absolute bound used to control the point-wise relative-error-bound. The block size will be M^K, where K is the # dimensions of the data and M is an integer such that (M-1)^K < segment_size <= M^K. For instance, for a 2D data, segment_size=32 means the whole data set will be split into multiple small blocks each being 6x6. For a 3D data, segment_size=32 means the whole data set is split into a lot of 4x4x4 blocks, each of which has an individual compression precision/error.
+#The larger this value, the lower overhead of maintaining error bound information for each segment/block, while the stricter absolute bound used to control the point-wise relative-error-bound. The block size will be M^K, where K is the # dimensions of the data and M is an integer such that (M-1)^K < segment_size <= M^K. For instance, for a 2D data, segment_size=32 means the whole data set will be split into multiple small blocks each being 6x6. For a 3D data, segment_size=32 means the whole data set is split into a lot of 4x4x4 blocks, each of which has an individual compression precision/error.
 segment_size = 32
 
 #point-wise relative-error-bound type
diff --git a/Tools/CMake/AMReXBuildInfo.cmake b/Tools/CMake/AMReXBuildInfo.cmake
@@ -189,7 +189,7 @@ function (generate_buildinfo _target _git_dir)
    configure_file( ${AMREX_BUILDINFO_IFILE}
       ${PROJECT_BINARY_DIR}/${_target}/AMReX_buildInfo.cpp @ONLY)
 
-   # add a re-usable target
+   # add a reusable target
    add_library(buildInfo${_target} STATIC)
    add_library(buildInfo::${_target} ALIAS buildInfo${_target})
 
diff --git a/Tools/CMake/AMReXClangTidy.cmake b/Tools/CMake/AMReXClangTidy.cmake
@@ -9,7 +9,7 @@ macro(setup_clang_tidy)
       if (_tmp MATCHES "LLVM version ([0-9\.]+)")
          message(STATUS "Found clang-tidy ${CMAKE_MATCH_1}")
          if ("${CMAKE_MATCH_1}" VERSION_GREATER_EQUAL 12.0.0)
-            # Cofig file not supported in earlier versions
+            # Config file not supported in earlier versions
             set(AMReX_CLANG_TIDY_CONFIG_FILE_NAME ${PROJECT_SOURCE_DIR}/.clang-tidy)
          endif()
       endif()
diff --git a/Tools/C_scripts/mkdep b/Tools/C_scripts/mkdep
@@ -7,7 +7,7 @@
 # Notes:  *  -I<path> defines a search path for include files
 #         *  -DBG turn on debug flag
 #         +  -fortran: parse fortran style include directives
-#         *  -X<path> means disgard entries with this path (NOT IMPLEMENTED)
+#         *  -X<path> means discard entries with this path (NOT IMPLEMENTED)
 #         *   searches current directory only if -I. is in search
 #             path or #include directive uses double quotes rather
 #             than angle brackets.

-Original file line number
+Diff line change
 pres
 ptd
 recuse
 +shft
 siz
 structed
 te
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public:`
`54`	`54`	`BL_ASSERT(c_sys != undef); return (c_sys == RZ);`
`55`	`55`	`}`
`56`	`56`
`57`		`- //! Is CoordType == cartesion?`
	`57`	`+ //! Is CoordType == cartesian?`
`58`	`58`	`[[nodiscard]] bool IsCartesian () const noexcept {`
`59`	`59`	`BL_ASSERT(c_sys != undef); return (c_sys == cartesian);`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -698,7 +698,7 @@ FabArrayCopyDescriptor<FAB>::CollectData ()`
`698`	`698`	`amrex::The_Arena()->free(md_recv_data);`
`699`	`699`	`}`
`700`	`700`
`701`		`- // Wait and upack data`
	`701`	`+ // Wait and unpack data`
`702`	`702`	`if (N_rcvs > 0)`
`703`	`703`	`{`
`704`	`704`	`Vector<MPI_Status> stats(N_rcvs);`