Clang-tidy: enforce clang-tidy_readability_make_member_function_const check (#4510)

* enforce clang-tidy_readability_make_member_function_const check

* fix bug

* address additional issues found with clang-tidy

* Fix more issues.

---------

Co-authored-by: Weiqun Zhang <weiqunzhang@lbl.gov>

Author: lucafedeli88

.clang-tidy

@@ -41,7 +41,6 @@ Checks: '
         -readability-implicit-bool-conversion,
         -readability-isolate-declaration,
         -readability-magic-numbers,
-        -readability-make-member-function-const,
         -readability-named-parameter,
         -readability-uppercase-literal-suffix
     '

Source/AcceleratorLattice/AcceleratorLattice.cpp

@@ -88,8 +88,9 @@ AcceleratorLattice::InitElementFinder (int const lev, amrex::BoxArray const & ba
 }
 
 void
-AcceleratorLattice::UpdateElementFinder (int const lev)
-{
+AcceleratorLattice::UpdateElementFinder (int const lev) // NOLINT(readability-make-member-function-const)
+{                                                       // Techniquely clang-tidy is correct because
+                                                        // m_element_finder is unique_ptr, not const*.
     if (m_lattice_defined) {
         for (amrex::MFIter mfi(*m_element_finder); mfi.isValid(); ++mfi)
         {

Source/AcceleratorLattice/LatticeElementFinder.H

@@ -72,8 +72,8 @@ struct LatticeElementFinder
      * @param[in] a_offset particle index offset needed to access particle info
      * @param[in] accelerator_lattice a reference to the accelerator lattice at the refinement level
      */
-    LatticeElementFinderDevice GetFinderDeviceInstance (WarpXParIter const& a_pti, int a_offset,
-                                                        AcceleratorLattice const& accelerator_lattice);
+    [[nodiscard]] LatticeElementFinderDevice GetFinderDeviceInstance (
+        WarpXParIter const& a_pti, int a_offset, AcceleratorLattice const& accelerator_lattice) const;
 
     /* The index lookup tables for each lattice element type */
     amrex::Gpu::DeviceVector<int> d_quad_indices;
@@ -89,7 +89,7 @@ struct LatticeElementFinder
      */
     void setup_lattice_indices (amrex::Gpu::DeviceVector<amrex::ParticleReal> const & zs,
                                 amrex::Gpu::DeviceVector<amrex::ParticleReal> const & ze,
-                                amrex::Gpu::DeviceVector<int> & indices);
+                                amrex::Gpu::DeviceVector<int> & indices) const;
 };
 
 /**

Source/AcceleratorLattice/LatticeElementFinder.cpp

@@ -78,7 +78,7 @@ LatticeElementFinder::UpdateIndices (int const lev, amrex::MFIter const& a_mfi,
 
 LatticeElementFinderDevice
 LatticeElementFinder::GetFinderDeviceInstance (WarpXParIter const& a_pti, int const a_offset,
-                                              AcceleratorLattice const& accelerator_lattice)
+                                              AcceleratorLattice const& accelerator_lattice) const
 {
     LatticeElementFinderDevice result;
     result.InitLatticeElementFinderDevice(a_pti, a_offset, accelerator_lattice, *this);
@@ -124,7 +124,7 @@ LatticeElementFinderDevice::InitLatticeElementFinderDevice (WarpXParIter const&
 void
 LatticeElementFinder::setup_lattice_indices (amrex::Gpu::DeviceVector<amrex::ParticleReal> const & zs,
                        amrex::Gpu::DeviceVector<amrex::ParticleReal> const & ze,
-                       amrex::Gpu::DeviceVector<int> & indices)
+                       amrex::Gpu::DeviceVector<int> & indices) const
 {
 
     using namespace amrex::literals;

Source/BoundaryConditions/WarpXFieldBoundaries.cpp

@@ -119,7 +119,7 @@ void WarpX::ApplyJfieldBoundary (const int lev, amrex::MultiFab* Jx,
 #ifdef WARPX_DIM_RZ
 // Applies the boundary conditions that are specific to the axis when in RZ.
 void
-WarpX::ApplyFieldBoundaryOnAxis (amrex::MultiFab* Er, amrex::MultiFab* Et, amrex::MultiFab* Ez, int lev)
+WarpX::ApplyFieldBoundaryOnAxis (amrex::MultiFab* Er, amrex::MultiFab* Et, amrex::MultiFab* Ez, int lev) const
 {
     const amrex::IntVect ngE = get_ng_fieldgather();
 

Source/Diagnostics/BTD_Plotfile_Header_Impl.H

@@ -171,11 +171,11 @@ class BTDMultiFabHeaderImpl
     void WriteMultiFabHeader ();
 
     /** Returns size, m_ba_size, of the Box Array, m_ba.*/
-    int ba_size () {return m_ba_size;}
+    [[nodiscard]] int ba_size () const {return m_ba_size;}
     /** Returns box corresponding to the ith box in the BoxArray, m_ba.
      *  \param[in] ibox index of the box in the BoxArray.
      */
-    amrex::Box ba_box (int ibox) {return m_ba[ibox]; }
+    [[nodiscard]] amrex::Box ba_box (int ibox) const {return m_ba[ibox]; }
     /** Returns prefix of the ith-fab on disk, i.e., ith fab of the MultiFab data.
      *  \param[in] ifab index of the ith fab in the MultiFab data.
      */
@@ -316,17 +316,17 @@ public:
     /** Reads the particle header file at m_Header_path and stores its data*/
     void ReadHeader ();
     /** Writes the meta-data of particle box array in header file, with path, m_Header_path*/
-    void WriteHeader ();
+    void WriteHeader () const;
     /** Returns the size of the box array, m_ba_size */
-    int ba_size () {return m_ba_size; }
+    [[nodiscard]] int ba_size () const {return m_ba_size; }
     /** Increases Box array size, m_ba_size, by add_size
      *  \param[in] add_size
      */
     void IncreaseBoxArraySize ( const int add_size) { m_ba_size += add_size;}
     /** Returns box corresponding to the ith box in the BoxArray, m_ba.
      *  \param[in] ibox index of the box in the BoxArray.
      */
-    amrex::Box ba_box (int ibox) {return m_ba[ibox]; }
+    [[nodiscard]] amrex::Box ba_box (int ibox) const {return m_ba[ibox]; }
     /** Resize boxArray, m_ba, to size, m_ba_size. */
     void ResizeBoxArray () { m_ba.resize(m_ba_size); }
     /** Set Box indices of the ith-box in Box Array, m_ba, to the new Box, ba_box.

Source/Diagnostics/BTD_Plotfile_Header_Impl.cpp

@@ -516,7 +516,7 @@ BTDParticleDataHeaderImpl::ReadHeader ()
 }
 
 void
-BTDParticleDataHeaderImpl::WriteHeader ()
+BTDParticleDataHeaderImpl::WriteHeader () const
 {
     if (amrex::FileExists(m_Header_path)) {
         amrex::FileSystem::Remove(m_Header_path);

Source/Diagnostics/BTDiagnostics.H

@@ -275,7 +275,7 @@ private:
       * \param[in] t_lab   lab-frame time of the snapshot
       * \param[in] t_boost boosted-frame time at level, lev
       */
-    amrex::Real UpdateCurrentZBoostCoordinate(amrex::Real t_lab, amrex::Real t_boost)
+    [[nodiscard]] amrex::Real UpdateCurrentZBoostCoordinate(amrex::Real t_lab, amrex::Real t_boost) const
     {
         const amrex::Real current_z_boost = (t_lab / m_gamma_boost - t_boost) * PhysConst::c / m_beta_boost;
         return current_z_boost;
@@ -284,7 +284,7 @@ private:
       * \param[in] t_lab   lab-frame time of the snapshot
       * \param[in] t_boost boosted-frame time at level, lev
       */
-    amrex::Real UpdateCurrentZLabCoordinate(amrex::Real t_lab, amrex::Real t_boost)
+    [[nodiscard]] amrex::Real UpdateCurrentZLabCoordinate(amrex::Real t_lab, amrex::Real t_boost) const
     {
         const amrex::Real current_z_lab = (t_lab - t_boost / m_gamma_boost ) * PhysConst::c / m_beta_boost;
         return current_z_lab;
@@ -294,13 +294,13 @@ private:
      *  \param[in] ref_ratio  refinement ratio in the z-direction at level, lev-1.
      *             The ref-ratio in the z-direction for single-level diagnostics is 1.
      */
-    amrex::Real dz_lab (amrex::Real dt, amrex::Real ref_ratio);
+    [[nodiscard]] amrex::Real dz_lab (amrex::Real dt, amrex::Real ref_ratio) const;
     /** Compute k-index corresponding to current lab-frame z co-ordinate (m_current_z_lab)
      *  for the ith buffer i_buffer, and at level, lev.
      * \param[in] i_buffer snapshot index
      * \param[in] lev      mesh-refinement level at which the lab-frame z-index is computed
      */
-    int k_index_zlab (int i_buffer, int lev);
+    [[nodiscard]] int k_index_zlab (int i_buffer, int lev) const;
     /** whether field buffer is full
      * \param[in] i_buffer buffer id for which the buffer size is checked.
      * returns bool = true is buffer is full, that is,

Source/Diagnostics/BTDiagnostics.cpp

@@ -863,13 +863,14 @@ BTDiagnostics::PrepareFieldDataForOutput ()
 
 
 amrex::Real
-BTDiagnostics::dz_lab (amrex::Real dt, amrex::Real ref_ratio){
+BTDiagnostics::dz_lab (amrex::Real dt, amrex::Real ref_ratio) const
+{
     return PhysConst::c * dt * 1._rt/m_beta_boost * 1._rt/m_gamma_boost * 1._rt/ref_ratio;
 }
 
 
 int
-BTDiagnostics::k_index_zlab (int i_buffer, int lev)
+BTDiagnostics::k_index_zlab (int i_buffer, int lev) const
 {
     auto & warpx = WarpX::GetInstance();
     const amrex::Real prob_domain_zmin_lab = m_snapshot_domain_lab[i_buffer].lo( m_moving_window_dir );

Source/Diagnostics/Diagnostics.H

@@ -114,7 +114,7 @@ public:
     /** Whether the last timestep is always dumped */
     [[nodiscard]] bool DoDumpLastTimestep () const {return  m_dump_last_timestep;}
     /** Returns the number of snapshots used in BTD. For Full-Diagnostics, the value is 1*/
-    int getnumbuffers() {return m_num_buffers;}
+    [[nodiscard]] int getnumbuffers() const {return m_num_buffers;}
     /** Time in lab-frame associated with the ith snapshot
      * \param[in] i_buffer index of the buffer
      */

Source/Diagnostics/MultiDiagnostics.H

@@ -38,7 +38,7 @@ public:
     /** Start a new iteration, i.e., dump has not been done yet. */
     void NewIteration ();
     Diagnostics& GetDiag(int idiag) {return *alldiags[idiag]; }
-    int GetTotalDiags() {return ndiags;}
+    [[nodiscard]] int GetTotalDiags() const {return ndiags;}
     DiagTypes diagstypes(int idiag) {return diags_types[idiag];}
 private:
     /** Vector of pointers to all diagnostics */

Source/Diagnostics/ReducedDiags/ReducedDiags.H

@@ -94,7 +94,7 @@ public:
      * This function queries deprecated input parameters and aborts
      * the run if one of them is specified.
      */
-    void BackwardCompatibility ();
+    void BackwardCompatibility () const;
 
 };
 

Source/Diagnostics/ReducedDiags/ReducedDiags.cpp

@@ -86,7 +86,7 @@ void ReducedDiags::LoadBalance ()
     // load balancing operations
 }
 
-void ReducedDiags::BackwardCompatibility ()
+void ReducedDiags::BackwardCompatibility () const
 {
     const amrex::ParmParse pp_rd_name(m_rd_name);
     std::vector<std::string> backward_strings;

Source/Diagnostics/WarpXOpenPMD.H

@@ -44,7 +44,7 @@ public:
   using ParticleIter = typename amrex::ParIter<0, 0, PIdx::nattribs, 0, amrex::PinnedArenaAllocator>;
 
   WarpXParticleCounter (ParticleContainer* pc);
-  unsigned long GetTotalNumParticles () {return m_Total;}
+  [[nodiscard]] unsigned long GetTotalNumParticles () const {return m_Total;}
 
   std::vector<unsigned long long> m_ParticleOffsetAtRank;
   std::vector<unsigned long long> m_ParticleSizeAtRank;

Source/FieldSolver/FiniteDifferenceSolver/HybridPICModel/HybridPICModel.H

@@ -126,7 +126,7 @@ public:
      */
     void FillElectronPressureMF (
         std::unique_ptr<amrex::MultiFab> const& Pe_field,
-        amrex::MultiFab* const& rho_field );
+        amrex::MultiFab* const& rho_field ) const;
 
     // Declare variables to hold hybrid-PIC model parameters
     /** Number of substeps to take when evolving B */

Source/FieldSolver/FiniteDifferenceSolver/HybridPICModel/HybridPICModel.cpp

@@ -508,7 +508,7 @@ void HybridPICModel::CalculateElectronPressure(const int lev, DtType a_dt_type)
 
 void HybridPICModel::FillElectronPressureMF (
     std::unique_ptr<amrex::MultiFab> const& Pe_field,
-    amrex::MultiFab* const& rho_field )
+    amrex::MultiFab* const& rho_field ) const
 {
     const auto n0_ref = m_n0_ref;
     const auto elec_temp = m_elec_temp;

Source/Initialization/InjectorMomentum.cpp

@@ -9,7 +9,7 @@
 
 using namespace amrex;
 
-void InjectorMomentum::clear ()
+void InjectorMomentum::clear () // NOLINT(readability-make-member-function-const)
 {
     switch (type)
     {

Source/Particles/Collision/BackgroundMCC/BackgroundMCCCollision.H

@@ -32,7 +32,7 @@ public:
     BackgroundMCCCollision ( BackgroundMCCCollision&& )                  = delete;
     BackgroundMCCCollision& operator= ( BackgroundMCCCollision&& )       = delete;
 
-    amrex::ParticleReal get_nu_max (amrex::Vector<ScatteringProcess> const& mcc_processes);
+    [[nodiscard]] amrex::ParticleReal get_nu_max (amrex::Vector<ScatteringProcess> const& mcc_processes) const;
 
     /** Perform the collisions
      *

Source/Particles/Collision/BackgroundMCC/BackgroundMCCCollision.cpp

@@ -162,7 +162,7 @@ BackgroundMCCCollision::BackgroundMCCCollision (std::string const collision_name
  *  ranges from 1e-4 to 5000 eV in 0.2 eV increments
  */
 amrex::ParticleReal
-BackgroundMCCCollision::get_nu_max(amrex::Vector<ScatteringProcess> const& mcc_processes)
+BackgroundMCCCollision::get_nu_max(amrex::Vector<ScatteringProcess> const& mcc_processes) const
 {
     using namespace amrex::literals;
     amrex::ParticleReal nu, nu_max = 0.0;

Source/Particles/Collision/CollisionBase.H

@@ -29,7 +29,7 @@ public:
 
     virtual ~CollisionBase() = default;
 
-    int get_ndt() {return m_ndt;}
+    [[nodiscard]] int get_ndt() const {return m_ndt;}
 
 protected:
 

Source/Particles/ParticleBoundaries.H

@@ -27,7 +27,7 @@ struct ParticleBoundaries
     void SetBoundsY (ParticleBoundaryType bc_lo, ParticleBoundaryType bc_hi);
     void SetBoundsZ (ParticleBoundaryType bc_lo, ParticleBoundaryType bc_hi);
 
-    bool CheckAll (ParticleBoundaryType bc);
+    [[nodiscard]] bool CheckAll (ParticleBoundaryType bc) const;
 
     void BuildReflectionModelParsers ();
 

Source/Particles/ParticleBoundaries.cpp

@@ -54,7 +54,7 @@ ParticleBoundaries::SetBoundsZ (ParticleBoundaryType bc_lo, ParticleBoundaryType
 }
 
 bool
-ParticleBoundaries::CheckAll (ParticleBoundaryType bc)
+ParticleBoundaries::CheckAll (ParticleBoundaryType bc) const
 {
     return (data.xmin_bc == bc && data.xmax_bc == bc
 #ifdef WARPX_DIM_3D

Source/Particles/PhysicalParticleContainer.H

@@ -224,7 +224,7 @@ public:
 
     void MapParticletoBoostedFrame (amrex::ParticleReal& x, amrex::ParticleReal& y, amrex::ParticleReal& z,
                                     amrex::ParticleReal& ux, amrex::ParticleReal& uy, amrex::ParticleReal& uz,
-                                    amrex::Real t_lab = 0.);
+                                    amrex::Real t_lab = 0.) const;
 
     void AddGaussianBeam (
         PlasmaInjector const& plasma_injector,
@@ -253,7 +253,7 @@ public:
         amrex::Gpu::HostVector<amrex::ParticleReal>& particle_uy,
         amrex::Gpu::HostVector<amrex::ParticleReal>& particle_uz,
         amrex::Gpu::HostVector<amrex::ParticleReal>& particle_w,
-        amrex::Real t_lab= 0.);
+        amrex::Real t_lab= 0.) const;
 
     /**
      * \brief Default initialize runtime attributes in a tile. This routine does not initialize the

Source/Particles/PhysicalParticleContainer.cpp

@@ -471,7 +471,7 @@ void PhysicalParticleContainer::InitData ()
 }
 
 void PhysicalParticleContainer::MapParticletoBoostedFrame (
-    ParticleReal& x, ParticleReal& y, ParticleReal& z, ParticleReal& ux, ParticleReal& uy, ParticleReal& uz, Real t_lab)
+    ParticleReal& x, ParticleReal& y, ParticleReal& z, ParticleReal& ux, ParticleReal& uy, ParticleReal& uz, Real t_lab) const
 {
     // Map the particles from the lab frame to the boosted frame.
     // This boosts the particle to the lab frame and calculates
@@ -810,7 +810,7 @@ PhysicalParticleContainer::CheckAndAddParticle (
     Gpu::HostVector<ParticleReal>& particle_uy,
     Gpu::HostVector<ParticleReal>& particle_uz,
     Gpu::HostVector<ParticleReal>& particle_w,
-    Real t_lab)
+    Real t_lab) const
 {
     if (WarpX::gamma_boost > 1.) {
         MapParticletoBoostedFrame(x, y, z, ux, uy, uz, t_lab);

Source/WarpX.H

@@ -727,7 +727,7 @@ public:
 
 #ifdef WARPX_DIM_RZ
     // Applies the boundary conditions that are specific to the axis when in RZ.
-    void ApplyFieldBoundaryOnAxis (amrex::MultiFab* Er, amrex::MultiFab* Et, amrex::MultiFab* Ez, int lev);
+    void ApplyFieldBoundaryOnAxis (amrex::MultiFab* Er, amrex::MultiFab* Et, amrex::MultiFab* Ez, int lev) const;
 #endif
 
     /**

Source/ablastr/utils/timer/Timer.H

@@ -44,7 +44,7 @@ namespace ablastr::utils::timer
         *
         * @return the duration
         */
-        double get_duration () noexcept;
+        [[nodiscard]] double get_duration () const noexcept;
 
 
         /**
@@ -53,7 +53,7 @@ namespace ablastr::utils::timer
         *
         * @return the maximum duration across all the MPI ranks
         */
-        double get_global_duration ();
+        [[nodiscard]] double get_global_duration () const;
 
         private:
 

Source/ablastr/utils/timer/Timer.cpp

@@ -24,13 +24,13 @@ Timer::record_stop_time() noexcept
 }
 
 double
-Timer::get_duration () noexcept
+Timer::get_duration () const noexcept
 {
     return m_stop_time - m_start_time;
 }
 
 double
-Timer::get_global_duration ()
+Timer::get_global_duration () const
 {
     auto duration = this->get_duration();
     amrex::ParallelDescriptor::ReduceRealMax(