Remove PinnedMemoryParticleContainer

ax3l · ax3l · commit 706a11f9c896 · 2025-11-10T20:47:23.000-08:00
Would be cleaner if `WarpXParticleContainer` had no purely
virtual member functions.
diff --git a/Source/Diagnostics/BTDiagnostics.cpp b/Source/Diagnostics/BTDiagnostics.cpp
@@ -1469,7 +1469,7 @@ BTDiagnostics::InitializeParticleBuffer (const MultiParticleContainer& mpc)
         for (int isp = 0; isp < m_particles_buffer[i].size(); ++isp) {
             m_totalParticles_in_buffer[i][isp] = 0;
             const int idx = mpc.getSpeciesID(m_output_species_names[isp]);
-            m_particles_buffer[i][isp] = std::make_unique<PinnedMemoryParticleContainer>(mpc.GetParticleContainer(idx).make_alike<amrex::PolymorphicArenaAllocator>());
+            m_particles_buffer[i][isp] = std::make_unique<WarpXParticleContainer::Base>(mpc.GetParticleContainer(idx).make_alike<amrex::PolymorphicArenaAllocator>());
             m_particles_buffer[i][isp]->SetArena(amrex::The_Pinned_Arena());
 
             // SoA component names
diff --git a/Source/Diagnostics/BoundaryScrapingDiagnostics.cpp b/Source/Diagnostics/BoundaryScrapingDiagnostics.cpp
@@ -100,7 +100,7 @@ BoundaryScrapingDiagnostics::InitializeParticleBuffer (const MultiParticleContai
     for (int i_buffer = 0; i_buffer < m_num_buffers; ++i_buffer) {
         for (auto const& species_name : m_output_species_names){
             WarpXParticleContainer* pc = &mpc.GetParticleContainerFromName(species_name);
-            PinnedMemoryParticleContainer* bnd_buffer = particle_buffer.getParticleBufferPointer(species_name, i_buffer);
+            WarpXParticleContainer::Base* bnd_buffer = particle_buffer.getParticleBufferPointer(species_name, i_buffer);
             m_output_species[i_buffer].push_back(ParticleDiag(m_diag_name, species_name, pc, bnd_buffer));
         }
     }
diff --git a/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H b/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.H
@@ -208,7 +208,7 @@ class BackTransformParticleFunctor final : public ComputeParticleDiagFunctor
 public:
     BackTransformParticleFunctor(WarpXParticleContainer *pc_src, std::string species_name, int num_buffers);
     /** Computes the Lorentz transform of source particles to obtain lab-frame data in pc_dst*/
-    void operator () (PinnedMemoryParticleContainer& pc_dst, int &TotalParticleCounter, int i_buffer) const override;
+    void operator () (WarpXParticleContainer::Base& pc_dst, int &TotalParticleCounter, int i_buffer) const override;
     void InitData() override;
     /** \brief Prepare data required to back-transform particle attributes for lab-frame snapshot, i_buffer
      *
diff --git a/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.cpp b/Source/Diagnostics/ComputeDiagFunctors/BackTransformParticleFunctor.cpp
@@ -80,7 +80,7 @@ BackTransformParticleFunctor::BackTransformParticleFunctor (
 
 
 void
-BackTransformParticleFunctor::operator () (PinnedMemoryParticleContainer& pc_dst, int &totalParticleCounter, int i_buffer) const
+BackTransformParticleFunctor::operator () (WarpXParticleContainer::Base& pc_dst, int &totalParticleCounter, int i_buffer) const
 {
     if (m_perform_backtransform[i_buffer] == 0) { return; }
     auto &warpx = WarpX::GetInstance();
diff --git a/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H b/Source/Diagnostics/ComputeDiagFunctors/ComputeParticleDiagFunctor.H
@@ -8,7 +8,6 @@
 #define WARPX_COMPUTEPARTICLEDIAGFUNCTOR_H_
 
 #include "Particles/WarpXParticleContainer.H"
-#include "Particles/PinnedMemoryParticleContainer.H"
 #include <AMReX.H>
 #include <AMReX_AmrParticles.H>
 
@@ -59,7 +58,7 @@ public:
      *  \param[out] totalParticlesInBuffer total number of particles in the container
      *  \param[in] i_buffer snapshot index for which the particle buffer is processed
      */
-    virtual void operator () (PinnedMemoryParticleContainer& pc_dst, int &totalParticlesInBuffer, int i_buffer = 0) const = 0;
+    virtual void operator () (WarpXParticleContainer::Base& pc_dst, int &totalParticlesInBuffer, int i_buffer = 0) const = 0;
     virtual void InitData () {}
 };
 
diff --git a/Source/Diagnostics/Diagnostics.H b/Source/Diagnostics/Diagnostics.H
@@ -7,7 +7,6 @@
 #include "ComputeDiagFunctors/ComputeParticleDiagFunctor.H"
 #include "FlushFormats/FlushFormat_fwd.H"
 #include "Particles/WarpXParticleContainer.H"
-#include "Particles/PinnedMemoryParticleContainer.H"
 
 #include <AMReX_IntVect.H>
 #include <AMReX_REAL.H>
@@ -327,7 +326,7 @@ protected:
     /** Array of species indices that dump temperature per species */
     amrex::Vector<int> m_T_per_species_index;
     /** Vector of particle buffer vectors for each snapshot */
-    amrex::Vector< amrex::Vector<std::unique_ptr<PinnedMemoryParticleContainer> > > m_particles_buffer;
+    amrex::Vector< amrex::Vector<std::unique_ptr<WarpXParticleContainer::Base> > > m_particles_buffer;
     /** Vector of pointers to functors to compute particle output per species*/
     amrex::Vector< std::unique_ptr<ComputeParticleDiagFunctor> > m_all_particle_functors;
 
diff --git a/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.cpp b/Source/Diagnostics/FlushFormats/FlushFormatPlotfile.cpp
@@ -6,7 +6,7 @@
 #include "Particles/Filter/FilterFunctors.H"
 #include "Particles/WarpXParticleContainer.H"
 #include "Particles/ParticleIO.H"
-#include "Particles/PinnedMemoryParticleContainer.H"
+#include "Particles/WarpXParticleContainer.H"
 #include "Utils/Interpolate.H"
 #include "Utils/Parser/ParserUtils.H"
 #include "Utils/TextMsg.H"
@@ -359,7 +359,7 @@ FlushFormatPlotfile::WriteParticles(const std::string& dir,
 {
     for (const auto& part_diag : particle_diags) {
         WarpXParticleContainer* pc = part_diag.getParticleContainer();
-        PinnedMemoryParticleContainer* pinned_pc = part_diag.getPinnedParticleContainer();
+        WarpXParticleContainer::Base* pinned_pc = part_diag.getPinnedParticleContainer();
         auto tmp = isBTD ?
             pinned_pc->make_alike<amrex::PolymorphicArenaAllocator>() :
             pc->make_alike<amrex::PolymorphicArenaAllocator>();
diff --git a/Source/Diagnostics/ParticleDiag/ParticleDiag.H b/Source/Diagnostics/ParticleDiag/ParticleDiag.H
@@ -4,7 +4,7 @@
 #include "ParticleDiag_fwd.H"
 
 #include "Particles/WarpXParticleContainer_fwd.H"
-#include "Particles/PinnedMemoryParticleContainer.H"
+#include "Particles/WarpXParticleContainer.H"
 
 #include <AMReX_Parser.H>
 #include <AMReX_REAL.H>
@@ -18,9 +18,9 @@ class ParticleDiag
 {
 public:
     ParticleDiag(const std::string& diag_name, const std::string& name,
-        WarpXParticleContainer* pc, PinnedMemoryParticleContainer *pinned_pc = nullptr);
+        WarpXParticleContainer* pc, WarpXParticleContainer::Base *pinned_pc = nullptr);
     [[nodiscard]] WarpXParticleContainer* getParticleContainer() const { return m_pc; }
-    [[nodiscard]] PinnedMemoryParticleContainer* getPinnedParticleContainer() const { return m_pinned_pc; }
+    [[nodiscard]] WarpXParticleContainer::Base* getPinnedParticleContainer() const { return m_pinned_pc; }
     [[nodiscard]] std::string getSpeciesName() const { return m_name; }
     amrex::Vector<int> m_plot_flags;
     bool m_plot_phi = false; // Whether to output the potential phi on the particles
@@ -39,7 +39,7 @@ private:
     std::string m_diag_name;
     std::string m_name;
     WarpXParticleContainer* m_pc;
-    PinnedMemoryParticleContainer* m_pinned_pc;
+    WarpXParticleContainer::Base* m_pinned_pc;
 };
 
 #endif // WARPX_PARTICLEDIAG_H_
diff --git a/Source/Diagnostics/ParticleDiag/ParticleDiag.cpp b/Source/Diagnostics/ParticleDiag/ParticleDiag.cpp
@@ -16,7 +16,7 @@ using namespace amrex;
 
 ParticleDiag::ParticleDiag (
     const std::string& diag_name, const std::string& name,
-    WarpXParticleContainer* pc, PinnedMemoryParticleContainer* pinned_pc):
+    WarpXParticleContainer* pc, WarpXParticleContainer::Base* pinned_pc):
     m_diag_name(diag_name), m_name(name), m_pc(pc), m_pinned_pc(pinned_pc)
 {
     //variable to set m_plot_flags size
diff --git a/Source/Diagnostics/ParticleIO.cpp b/Source/Diagnostics/ParticleIO.cpp
@@ -250,10 +250,10 @@ MultiParticleContainer::WriteHeader (std::ostream& os) const
 }
 
 void
-storePhiOnParticles ( PinnedMemoryParticleContainer& tmp,
+storePhiOnParticles ( WarpXParticleContainer::Base& tmp,
     ElectrostaticSolverAlgo electrostatic_solver_id, bool is_full_diagnostic ) {
 
-    using PinnedParIter = typename PinnedMemoryParticleContainer::ParIterType;
+    using PinnedParIter = typename WarpXParticleContainer::ParIterType;
 
     WARPX_ALWAYS_ASSERT_WITH_MESSAGE(
         (electrostatic_solver_id == ElectrostaticSolverAlgo::LabFrame) ||
diff --git a/Source/Diagnostics/WarpXOpenPMD.cpp b/Source/Diagnostics/WarpXOpenPMD.cpp
@@ -551,14 +551,14 @@ WARPX_PROFILE("WarpXOpenPMDPlot::WriteOpenPMDParticles()");
 
 for (const auto & particle_diag : particle_diags) {
     WarpXParticleContainer* pc = particle_diag.getParticleContainer();
-    PinnedMemoryParticleContainer* pinned_pc = particle_diag.getPinnedParticleContainer();
+    WarpXParticleContainer::Base* pinned_pc = particle_diag.getPinnedParticleContainer();
     if (isBTD || use_pinned_pc) {
         if (!pinned_pc->isDefined()) {
             continue;  // Skip to the next particle container
         }
     }
 
-    PinnedMemoryParticleContainer tmp = (isBTD || use_pinned_pc) ?
+    WarpXParticleContainer::Base tmp = (isBTD || use_pinned_pc) ?
         pinned_pc->make_alike<amrex::PolymorphicArenaAllocator>() :
         pc->make_alike<amrex::PolymorphicArenaAllocator>();
     tmp.SetArena(amrex::The_Pinned_Arena());
diff --git a/Source/Particles/ParticleBoundaryBuffer.H b/Source/Particles/ParticleBoundaryBuffer.H
@@ -9,7 +9,6 @@
 
 #include "Particles/MultiParticleContainer_fwd.H"
 #include "Particles/WarpXParticleContainer.H"
-#include "Particles/PinnedMemoryParticleContainer.H"
 #include "Utils/export.H"
 
 #include <ablastr/fields/MultiFabRegister.H>
@@ -54,9 +53,9 @@ public:
 
     int getNumParticlesInContainer(const std::string& species_name, int boundary, bool local);
 
-    PinnedMemoryParticleContainer& getParticleBuffer(const std::string& species_name, int boundary);
+    WarpXParticleContainer::Base& getParticleBuffer(const std::string& species_name, int boundary);
 
-    PinnedMemoryParticleContainer* getParticleBufferPointer(const std::string& species_name, int boundary);
+    WarpXParticleContainer::Base* getParticleBufferPointer(const std::string& species_name, int boundary);
 
     static constexpr int numBoundaries () {
         return AMREX_SPACEDIM*2
@@ -72,7 +71,7 @@ public:
 
 private:
     // over boundary, then number of species
-    std::vector<std::vector<PinnedMemoryParticleContainer> > m_particle_containers;
+    std::vector<std::vector<WarpXParticleContainer::Base> > m_particle_containers;
 
     // over boundary, then number of species
     std::vector<std::vector<int> > m_do_boundary_buffer;
diff --git a/Source/Particles/ParticleBoundaryBuffer.cpp b/Source/Particles/ParticleBoundaryBuffer.cpp
@@ -473,9 +473,9 @@ void ParticleBoundaryBuffer::gatherParticlesFromDomainBoundaries (MultiParticleC
                           auto& warpx = WarpX::GetInstance();
                           const auto dt = warpx.getdt(pti.GetLevel());
                           auto & buf = buffer[i];
-                          const int step_scraped_index = buf.GetIntCompIndex("stepScraped") - PinnedMemoryParticleContainer::NArrayInt;
-                          const int delta_index = buf.GetRealCompIndex("deltaTimeScraped") - PinnedMemoryParticleContainer::NArrayReal;
-                          const int normal_index = buf.GetRealCompIndex("nx") - PinnedMemoryParticleContainer::NArrayReal;
+                          const int step_scraped_index = buf.GetIntCompIndex("stepScraped") - WarpXParticleContainer::NArrayInt;
+                          const int delta_index = buf.GetRealCompIndex("deltaTimeScraped") - WarpXParticleContainer::NArrayReal;
+                          const int normal_index = buf.GetRealCompIndex("nx") - WarpXParticleContainer::NArrayReal;
                           const int step = warpx_instance.getistep(0);
                           amrex::filterAndTransformParticles(ptile_buffer, ptile,
                                                              predicate,
@@ -582,9 +582,9 @@ void ParticleBoundaryBuffer::gatherParticlesFromEmbeddedBoundaries (
                     auto &warpx = WarpX::GetInstance();
                     const auto dt = warpx.getdt(pti.GetLevel());
                     auto & buf = buffer[i];
-                    const int step_scraped_index = buf.GetIntCompIndex("stepScraped") - PinnedMemoryParticleContainer::NArrayInt;
-                    const int delta_index = buf.GetRealCompIndex("deltaTimeScraped") - PinnedMemoryParticleContainer::NArrayReal;
-                    const int normal_index = buf.GetRealCompIndex("nx") - PinnedMemoryParticleContainer::NArrayReal;
+                    const int step_scraped_index = buf.GetIntCompIndex("stepScraped") - WarpXParticleContainer::NArrayInt;
+                    const int delta_index = buf.GetRealCompIndex("deltaTimeScraped") - WarpXParticleContainer::NArrayReal;
+                    const int normal_index = buf.GetRealCompIndex("nx") - WarpXParticleContainer::NArrayReal;
                     const int step = warpx_instance.getistep(0);
 
                     {
@@ -617,7 +617,7 @@ int ParticleBoundaryBuffer::getNumParticlesInContainer(
     }
 }
 
-PinnedMemoryParticleContainer &
+WarpXParticleContainer::Base &
 ParticleBoundaryBuffer::getParticleBuffer(const std::string& species_name, int boundary) {
 
     auto& buffer = m_particle_containers[boundary];
@@ -632,7 +632,7 @@ ParticleBoundaryBuffer::getParticleBuffer(const std::string& species_name, int b
     return buffer[index];
 }
 
-PinnedMemoryParticleContainer *
+WarpXParticleContainer::Base *
 ParticleBoundaryBuffer::getParticleBufferPointer(const std::string& species_name, int boundary) {
 
     auto& buffer = m_particle_containers[boundary];
diff --git a/Source/Particles/ParticleIO.H b/Source/Particles/ParticleIO.H
@@ -9,7 +9,6 @@
 
 #include "Particles/WarpXParticleContainer.H"
 #include "Particles/Pusher/GetAndSetPosition.H"
-#include "Particles/PinnedMemoryParticleContainer.H"
 
 #include <ablastr/particles/NodalFieldGather.H>
 
@@ -63,7 +62,7 @@ particlesConvertUnits (ConvertDirection convert_direction, T_ParticleContainer*
             // - momenta are stored as a struct of array, in `attribs`
             // The GetStructOfArrays is called directly since the convenience routine GetAttribs
             // is only available in WarpXParIter. ParIter is used here since the pc passed in
-            // will sometimes be a PinnedMemoryParticleContainer (not derived from a WarpXParticleContainer).
+            // will sometimes be a WarpXParticleContainer (not derived from a WarpXParticleContainer).
             auto& attribs = pti.GetStructOfArrays().GetRealData();
             ParticleReal* AMREX_RESTRICT ux = attribs[PIdx::ux].dataPtr();
             ParticleReal* AMREX_RESTRICT uy = attribs[PIdx::uy].dataPtr();
@@ -89,7 +88,7 @@ particlesConvertUnits (ConvertDirection convert_direction, T_ParticleContainer*
  * @param is_full_diagnostic whether this diagnostic is a full diagnostic
  */
 void
-storePhiOnParticles ( PinnedMemoryParticleContainer& tmp,
+storePhiOnParticles ( WarpXParticleContainer::Base& tmp,
     ElectrostaticSolverAlgo electrostatic_solver_id, bool is_full_diagnostic );
 
 #endif /* WARPX_PARTICLEIO_H_ */
diff --git a/Source/Particles/PinnedMemoryParticleContainer.H b/Source/Particles/PinnedMemoryParticleContainer.H
diff --git a/Source/Particles/WarpXParticleContainer.H b/Source/Particles/WarpXParticleContainer.H
@@ -196,6 +196,8 @@ class WarpXParticleContainer
 public:
     friend MultiParticleContainer;
 
+    using Base = amrex::ParticleContainerPureSoA<PIdx::nattribs, 0, amrex::PolymorphicArenaAllocator>;
+
     // amrex::StructOfArrays with DiagIdx::nattribs amrex::ParticleReal components
     // and 0 int components for the particle data.
     using DiagnosticParticleData = amrex::StructOfArrays<DiagIdx::nattribs, 0>;

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ BoundaryScrapingDiagnostics::InitializeParticleBuffer (const MultiParticleContai`
`100`	`100`	`for (int i_buffer = 0; i_buffer < m_num_buffers; ++i_buffer) {`
`101`	`101`	`for (auto const& species_name : m_output_species_names){`
`102`	`102`	`WarpXParticleContainer* pc = &mpc.GetParticleContainerFromName(species_name);`
`103`		`- PinnedMemoryParticleContainer* bnd_buffer = particle_buffer.getParticleBufferPointer(species_name, i_buffer);`
	`103`	`+ WarpXParticleContainer::Base* bnd_buffer = particle_buffer.getParticleBufferPointer(species_name, i_buffer);`
`104`	`104`	`m_output_species[i_buffer].push_back(ParticleDiag(m_diag_name, species_name, pc, bnd_buffer));`
`105`	`105`	`}`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -208,7 +208,7 @@ class BackTransformParticleFunctor final : public ComputeParticleDiagFunctor`
`208`	`208`	`public:`
`209`	`209`	`BackTransformParticleFunctor(WarpXParticleContainer *pc_src, std::string species_name, int num_buffers);`
`210`	`210`	`/** Computes the Lorentz transform of source particles to obtain lab-frame data in pc_dst*/`
`211`		`- void operator () (PinnedMemoryParticleContainer& pc_dst, int &TotalParticleCounter, int i_buffer) const override;`
	`211`	`+ void operator () (WarpXParticleContainer::Base& pc_dst, int &TotalParticleCounter, int i_buffer) const override;`
`212`	`212`	`void InitData() override;`
`213`	`213`	`/** \brief Prepare data required to back-transform particle attributes for lab-frame snapshot, i_buffer`
`214`	`214`	`*`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ BackTransformParticleFunctor::BackTransformParticleFunctor (`
`80`	`80`
`81`	`81`
`82`	`82`	`void`
`83`		`-BackTransformParticleFunctor::operator () (PinnedMemoryParticleContainer& pc_dst, int &totalParticleCounter, int i_buffer) const`
	`83`	`+BackTransformParticleFunctor::operator () (WarpXParticleContainer::Base& pc_dst, int &totalParticleCounter, int i_buffer) const`
`84`	`84`	`{`
`85`	`85`	`if (m_perform_backtransform[i_buffer] == 0) { return; }`
`86`	`86`	`auto &warpx = WarpX::GetInstance();`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ using namespace amrex;`
`16`	`16`
`17`	`17`	`ParticleDiag::ParticleDiag (`
`18`	`18`	`const std::string& diag_name, const std::string& name,`
`19`		`- WarpXParticleContainer* pc, PinnedMemoryParticleContainer* pinned_pc):`
	`19`	`+ WarpXParticleContainer* pc, WarpXParticleContainer::Base* pinned_pc):`
`20`	`20`	`m_diag_name(diag_name), m_name(name), m_pc(pc), m_pinned_pc(pinned_pc)`
`21`	`21`	`{`
`22`	`22`	`//variable to set m_plot_flags size`