Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
AMReX_ParticleContainer.H
Go to the documentation of this file.
1#ifndef AMREX_PARTICLE_CONTAINER_H_
2#define AMREX_PARTICLE_CONTAINER_H_
3#include <AMReX_Config.H>
4
6#include <AMReX_ParmParse.H>
7#include <AMReX_ParGDB.H>
8#include <AMReX_REAL.H>
9#include <AMReX_IntVect.H>
10#include <AMReX_Array.H>
11#include <AMReX_Vector.H>
12#include <AMReX_Utility.H>
13#include <AMReX_Geometry.H>
14#include <AMReX_VisMF.H>
15#include <AMReX_RealBox.H>
16#include <AMReX_Print.H>
17#include <AMReX_MultiFabUtil.H>
18#include <AMReX_NFiles.H>
19#include <AMReX_VectorIO.H>
20#include <AMReX_Particle_mod_K.H>
24#include <AMReX_Particle.H>
25#include <AMReX_ParticleTile.H>
27#include <AMReX_TypeTraits.H>
28#include <AMReX_GpuContainers.H>
29#include <AMReX_ParticleUtil.H>
34#include <AMReX_Scan.H>
35#include <AMReX_DenseBins.H>
36#include <AMReX_SparseBins.H>
38#include <AMReX_ParticleMesh.H>
39#include <AMReX_OpenMP.H>
40#include <AMReX_ParIter.H>
41
42#ifdef AMREX_LAZY
43#include <AMReX_Lazy.H>
44#endif
45
46#ifdef AMREX_USE_OMP
47#include <omp.h>
48#endif
49
50#ifdef AMREX_USE_HDF5
51#include <hdf5.h>
52#endif
53
54#include <algorithm>
55#include <array>
56#include <cstring>
57#include <fstream>
58#include <iostream>
59#include <limits>
60#include <map>
61#include <memory>
62#include <numeric>
63#include <random>
64#include <stdexcept>
65#include <string>
66#include <tuple>
67#include <type_traits>
68#include <utility>
69#include <vector>
70
71namespace amrex {
72
73#ifdef AMREX_USE_HDF5_ASYNC
74 extern hid_t es_par_g;
75#endif
81{
83 int m_lev;
84 int m_grid;
86 RealType m_data[1 + AMREX_SPACEDIM];
87};
88
102
117template<int NStructReal, int NStructInt, int NArrayReal, int NArrayInt>
119{
120 std::array<double, NStructReal> real_struct_data;
121 std::array<int, NStructInt > int_struct_data;
122 std::array<double, NArrayReal > real_array_data;
123 std::array<int, NArrayInt > int_array_data;
124};
125
126template <bool is_const, typename T_ParticleType, int NArrayReal, int NArrayInt,
127 template<class> class Allocator, class CellAssignor>
128class ParIterBase_impl;
129
149template <typename T_ParticleType, int T_NArrayReal, int T_NArrayInt,
150 template<class> class Allocator=DefaultAllocator,
151 class T_CellAssignor=DefaultAssignor>
152
154{
155public:
156 using ParticleType = T_ParticleType;
157 using ConstParticleType = typename ParticleType::ConstType;
158 using CellAssignor = T_CellAssignor;
159
161 static constexpr int NStructReal = ParticleType::NReal;
163 static constexpr int NStructInt = ParticleType::NInt;
165 static constexpr int NArrayReal = T_NArrayReal;
167 static constexpr int NArrayInt = T_NArrayInt;
169
170private:
171 friend class ParIterBase_impl<true,ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor>;
172 friend class ParIterBase_impl<false,ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor>;
173
174public:
176 template <typename T>
177 using AllocatorType = Allocator<T>;
182
183#ifdef AMREX_SINGLE_PRECISION_PARTICLES
185#else
187#endif
188
189 static constexpr bool is_rtsoa_pc = ParticleType::is_rtsoa_particle;
190
192 using ParticleTileType = std::conditional_t<
196 >;
198
201 using ParticleLevel = std::map<std::pair<int, int>, ParticleTileType>;
202 using PTDType = typename ParticleTileType::ParticleTileDataType;
203 using ConstPTDType = typename ParticleTileType::ConstParticleTileDataType;
204 using AoS = typename ParticleTileType::AoS;
205 using SoA = typename ParticleTileType::SoA;
206
207 using RealVector = typename SoA::RealVector;
208 using IntVector = typename SoA::IntVector;
209 using ParticleVector = typename AoS::ParticleVector;
213
214 static constexpr bool has_polymorphic_allocator =
216
217 static_assert(!ParticleType::is_soa_particle || T_NArrayReal >= AMREX_SPACEDIM || is_rtsoa_pc,
218 "Pure SoA particle containers require at least AMREX_SPACEDIM real components for positions");
219
223 :
225 {
226 Initialize ();
227 }
228
244
253 const DistributionMapping & dmap,
254 const BoxArray & ba)
255 :
256 ParticleContainerBase(geom, dmap, ba)
257 {
258 Initialize ();
261 }
262
273 const Vector<DistributionMapping> & dmap,
274 const Vector<BoxArray> & ba,
275 const Vector<int> & rr)
276 :
277 ParticleContainerBase(geom, dmap, ba, rr)
278 {
279 Initialize ();
282 }
283
293 const Vector<DistributionMapping> & dmap,
294 const Vector<BoxArray> & ba,
295 const Vector<IntVect> & rr)
296 :
297 ParticleContainerBase(geom, dmap, ba, rr)
298 {
299 Initialize ();
302 }
303
304 ~ParticleContainer_impl () override = default;
305
308
310 ParticleContainer_impl& operator= ( ParticleContainer_impl && ) noexcept = default;
311
312
320 void Define (ParGDBBase* gdb)
321 {
323 reserveData();
324 resizeData();
325 }
326
334 void Define (const Geometry & geom,
335 const DistributionMapping & dmap,
336 const BoxArray & ba)
337 {
338 this->ParticleContainerBase::Define(geom, dmap, ba);
339 reserveData();
340 resizeData();
341 }
342
352 void Define (const Vector<Geometry> & geom,
353 const Vector<DistributionMapping> & dmap,
354 const Vector<BoxArray> & ba,
355 const Vector<int> & rr)
356 {
357 this->ParticleContainerBase::Define(geom, dmap, ba, rr);
358 reserveData();
359 resizeData();
360 }
361
371 void Define (const Vector<Geometry> & geom,
372 const Vector<DistributionMapping> & dmap,
373 const Vector<BoxArray> & ba,
374 const Vector<IntVect> & rr)
375 {
376 this->ParticleContainerBase::Define(geom, dmap, ba, rr);
377 reserveData();
378 resizeData();
379 }
380
382 int numLocalTilesAtLevel (int lev) const {
383 return (lev < m_particles.size()) ? m_particles[lev].size() : 0;
384 }
385
390 void reserveData () override;
391
398 void resizeData () override;
399
400 void InitFromAsciiFile (const std::string& file, int extradata,
401 const IntVect* Nrep = nullptr);
402
403 void InitFromBinaryFile (const std::string& file, int extradata);
404
405 void InitFromBinaryMetaFile (const std::string& file, int extradata);
406
423 void InitRandom (Long icount, ULong iseed,
424 const ParticleInitData& pdata,
425 bool serialize = false, RealBox bx = RealBox());
426
427
443 void InitRandomPerBox (Long icount, ULong iseed, const ParticleInitData& pdata);
444
445
460 void InitOnePerCell (Real x_off, Real y_off, Real z_off,
461 const ParticleInitData& pdata);
462
463
475 void InitNRandomPerCell (int n_per_cell, const ParticleInitData& pdata);
476
477 void Increment (MultiFab& mf, int level);
478
479 Long IncrementWithTotal (MultiFab& mf, int level, bool local = false);
480
519 void Redistribute (int lev_min = 0, int lev_max = -1, int nGrow = 0,
520 int local = 0, bool remove_negative=true)
521 {
522 Redistribute(lev_min, lev_max, IntVect(nGrow),
523 local > 0, IntVect(local), remove_negative);
524 }
525
536 void Redistribute (int lev_min, int lev_max, IntVect nGrow,
537 bool local, IntVect max_cells_moved,
538 bool remove_negative=true);
539
540
552 template <class index_type>
553 void ReorderParticles (int lev, const MFIter& mfi, const index_type* permutations);
554
570
575
583
594 bool OK (int lev_min = 0, int lev_max = -1, int nGrow = 0) const;
595
596 std::array<Long, 3> ByteSpread () const;
597
598 std::array<Long, 3> PrintCapacity () const;
599
600 void ShrinkToFit ();
601
611
612 Long NumberOfParticlesAtLevel (int level, bool only_valid = true, bool only_local = false) const;
613
614 Vector<Long> NumberOfParticlesInGrid (int level, bool only_valid = true, bool only_local = false) const;
615
619 template <std::integral Int>
620 requires (sizeof(Int) >= sizeof(Long))
621 void CapacityOfParticlesInGrid (LayoutData<Int>& mem, int lev) const;
622
631 Long TotalNumberOfParticles (bool only_valid=true, bool only_local=false) const;
632
633
641 void RemoveParticlesAtLevel (int level);
642
644
652 void CreateVirtualParticles (int level, AoS& virts) const;
653
662 void CreateGhostParticles (int level, int ngrow, AoS& ghosts) const;
663
671 void AddParticlesAtLevel (AoS& particles, int level, int nGrow=0);
672
680 void CreateVirtualParticles (int level, ParticleTileType& virts) const;
681
690 void CreateGhostParticles (int level, int ngrow, ParticleTileType& ghosts) const;
691
699 void AddParticlesAtLevel (ParticleTileType& particles, int level, int nGrow=0);
700
701
706
707
716 template <class PCType>
718 void copyParticles (const PCType& other, bool local=false);
719
727 template <class PCType>
729 void addParticles (const PCType& other, bool local=false);
730
745 template <class F, class PCType>
746 requires ((IsParticleContainer<PCType>::value) && (!std::is_integral_v<F>))
747 void copyParticles (const PCType& other, F&&f, bool local=false);
748
762 template <class F, class PCType>
763 requires ((IsParticleContainer<PCType>::value) && (!std::is_integral_v<F>))
764 void addParticles (const PCType& other, F const& f, bool local=false);
765
773 void WriteParticleRealData (void* data, size_t size, std::ostream& os) const;
774
782 void ReadParticleRealData (void* data, size_t size, std::istream& is);
783
792 void Checkpoint (const std::string& dir, const std::string& name,
793 const Vector<std::string>& real_comp_names = Vector<std::string>(),
794 const Vector<std::string>& int_comp_names = Vector<std::string>()) const
795 {
796 Checkpoint(dir, name, true, real_comp_names, int_comp_names);
797 }
798
804 void Checkpoint (const std::string& dir, const std::string& name, bool is_checkpoint,
805 const Vector<std::string>& real_comp_names = Vector<std::string>(),
806 const Vector<std::string>& int_comp_names = Vector<std::string>()) const;
807
820 void Checkpoint (const std::string& dir, const std::string& name,
821 const Vector<int>& write_real_comp,
822 const Vector<int>& write_int_comp,
823 const Vector<std::string>& real_comp_names,
824 const Vector<std::string>& int_comp_names) const;
825
840 template <class F>
841 void WriteBinaryParticleData (const std::string& dir,
842 const std::string& name,
843 const Vector<int>& write_real_comp,
844 const Vector<int>& write_int_comp,
845 const Vector<std::string>& real_comp_names,
846 const Vector<std::string>& int_comp_names,
847 F const& f, bool is_checkpoint=false) const;
848
850
852
859 void Restart (const std::string& dir, const std::string& file);
860
868 void Restart (const std::string& dir, const std::string& file, bool is_checkpoint);
869
876 void WritePlotFile (const std::string& dir, const std::string& name) const;
877
889 template <class F>
890 void WritePlotFile (const std::string& dir, const std::string& name, F const& f) const;
891
900 void WritePlotFile (const std::string& dir, const std::string& name,
901 const Vector<std::string>& real_comp_names,
902 const Vector<std::string>& int_comp_names) const;
903
917 template <class F>
918 void WritePlotFile (const std::string& dir, const std::string& name,
919 const Vector<std::string>& real_comp_names,
920 const Vector<std::string>& int_comp_names, F const& f) const;
921
930 void WritePlotFile (const std::string& dir, const std::string& name,
931 const Vector<std::string>& real_comp_names) const;
932
946 template <class F>
947 void WritePlotFile (const std::string& dir, const std::string& name,
948 const Vector<std::string>& real_comp_names, F const& f) const;
949
959 void WritePlotFile (const std::string& dir,
960 const std::string& name,
961 const Vector<int>& write_real_comp,
962 const Vector<int>& write_int_comp) const;
963
978 template <class F>
979 void WritePlotFile (const std::string& dir,
980 const std::string& name,
981 const Vector<int>& write_real_comp,
982 const Vector<int>& write_int_comp, F const& f) const;
983
997 void WritePlotFile (const std::string& dir,
998 const std::string& name,
999 const Vector<int>& write_real_comp,
1000 const Vector<int>& write_int_comp,
1001 const Vector<std::string>& real_comp_names,
1002 const Vector<std::string>& int_comp_names) const;
1003
1022 template <class F>
1023 void WritePlotFile (const std::string& dir,
1024 const std::string& name,
1025 const Vector<int>& write_real_comp,
1026 const Vector<int>& write_int_comp,
1027 const Vector<std::string>& real_comp_names,
1028 const Vector<std::string>& int_comp_names,
1029 F const& f) const;
1030
1032
1034
1035 void WriteAsciiFile (const std::string& file);
1036
1041 const Vector<ParticleLevel>& GetParticles () const { return m_particles; }
1042
1047 Vector <ParticleLevel>& GetParticles () { return m_particles; }
1048
1062 const ParticleLevel& GetParticles (int lev) const { return m_particles[lev]; }
1063
1077 ParticleLevel & GetParticles (int lev) { return m_particles[lev]; }
1078
1101 const ParticleTileType& ParticlesAt (int lev, int grid, int tile) const
1102 { return m_particles[lev].at(std::make_pair(grid, tile)); }
1103
1126 ParticleTileType& ParticlesAt (int lev, int grid, int tile)
1127 { return m_particles[lev].at(std::make_pair(grid, tile)); }
1128
1150 template <class Iterator>
1151 const ParticleTileType& ParticlesAt (int lev, const Iterator& iter) const
1152 { return ParticlesAt(lev, iter.index(), iter.LocalTileIndex()); }
1153
1175 template <class Iterator>
1176 ParticleTileType& ParticlesAt (int lev, const Iterator& iter)
1177 { return ParticlesAt(lev, iter.index(), iter.LocalTileIndex()); }
1178
1201 ParticleTileType& DefineAndReturnParticleTile (int lev, int grid, int tile)
1202 {
1203 m_particles[lev][std::make_pair(grid, tile)].define(
1205 &m_soa_rdata_names, &m_soa_idata_names,
1206 arena()
1207 );
1208 return ParticlesAt(lev, grid, tile);
1209 }
1210
1232 template <class Iterator>
1233 ParticleTileType& DefineAndReturnParticleTile (int lev, const Iterator& iter)
1234 {
1235 auto index = std::make_pair(iter.index(), iter.LocalTileIndex());
1236 m_particles[lev][index].define(
1238 &m_soa_rdata_names, &m_soa_idata_names,
1239 arena()
1240 );
1241 return ParticlesAt(lev, iter);
1242 }
1243
1254 void AssignDensity (int rho_index,
1255 Vector<std::unique_ptr<MultiFab> >& mf_to_be_filled,
1256 int lev_min, int ncomp, int finest_level, int ngrow=2) const;
1257
1258 void AssignCellDensitySingleLevel (int rho_index, MultiFab& mf, int level,
1259 int ncomp=1, int particle_lvl_offset = 0) const;
1260
1261 template <typename P, typename Assignor=CellAssignor>
1262 IntVect Index (const P& p, int lev) const;
1263
1273 ParticleLocData Reset (ParticleType& prt, bool update, bool verbose=true,
1274 ParticleLocData pld = ParticleLocData()) const;
1275
1281 template <typename P>
1282 bool PeriodicShift (P& p) const;
1283
1290 template <typename P>
1291 bool OutsidePeriodic (const P& p) const;
1292
1294
1296
1297 void SetUsePrePost (bool tf) const {
1298 usePrePost = tf;
1299 }
1300 bool GetUsePrePost () const {
1301 return usePrePost;
1302 }
1303
1306
1307 void SetUseUnlink (bool tf) const {
1308 doUnlink = tf;
1309 }
1310
1311 bool GetUseUnlink () const {
1312 return doUnlink;
1313 }
1314
1315 void Redistribute_impl (int lev_min = 0, int lev_max = -1, int nGrow = 0,
1316 int local = 0, bool remove_negative=true)
1317 {
1318 Redistribute_impl(lev_min, lev_max, IntVect(nGrow),
1319 local > 0, IntVect(local), remove_negative);
1320 }
1321
1322 void Redistribute_impl (int lev_min, int lev_max, IntVect nGrow,
1323 bool local, IntVect max_cells_moved,
1324 bool remove_negative=true);
1325
1327
1328 Long superParticleSize() const { return superparticle_size; }
1329
1330 void AddRealComp (std::string const & name, int communicate=1)
1331 {
1332 // names must be unique
1333 auto const it = std::ranges::find(m_soa_rdata_names, name);
1334 if (it != m_soa_rdata_names.end()) {
1335 throw std::runtime_error("AddRealComp: name '" + name + "' is already present in the SoA.");
1336 }
1337 m_soa_rdata_names.push_back(name);
1338
1339 m_runtime_comps_defined = true;
1340 m_num_runtime_real++;
1341 h_redistribute_real_comp.push_back(communicate);
1343 this->resizeData();
1344
1345 // resize runtime SoA
1346 for (int lev = 0; lev < numLevels(); ++lev) {
1347 for (ParIterType pti(*this,lev); pti.isValid(); ++pti) {
1348 auto& tile = DefineAndReturnParticleTile(lev, pti);
1349 auto np = tile.numParticles();
1350 if (np > 0) {
1351 auto& soa = tile.GetStructOfArrays();
1352 soa.resize(np);
1353 }
1354 }
1355 }
1356 }
1357
1358 void AddRealComp (int communicate=1)
1359 {
1360 AddRealComp(getDefaultCompNameReal<ParticleType>(NArrayReal+m_num_runtime_real), communicate);
1361 }
1362
1363 void AddIntComp (std::string const & name, int communicate=1)
1364 {
1365 // names must be unique
1366 auto const it = std::ranges::find(m_soa_idata_names, name);
1367 if (it != m_soa_idata_names.end()) {
1368 throw std::runtime_error("AddIntComp: name '" + name + "' is already present in the SoA.");
1369 }
1370 m_soa_idata_names.push_back(name);
1371
1372 m_runtime_comps_defined = true;
1373 m_num_runtime_int++;
1374 h_redistribute_int_comp.push_back(communicate);
1376 this->resizeData();
1377
1378 // resize runtime SoA
1379 for (int lev = 0; lev < numLevels(); ++lev) {
1380 for (ParIterType pti(*this,lev); pti.isValid(); ++pti) {
1381 auto& tile = DefineAndReturnParticleTile(lev, pti);
1382 auto np = tile.numParticles();
1383 if (np > 0) {
1384 auto& soa = tile.GetStructOfArrays();
1385 soa.resize(np);
1386 }
1387 }
1388 }
1389 }
1390
1391 void AddIntComp (int communicate=1)
1392 {
1393 AddIntComp(getDefaultCompNameInt<ParticleType>(NArrayInt+m_num_runtime_int), communicate);
1394 }
1395
1396 int NumRuntimeRealComps () const { return m_num_runtime_real; }
1397 int NumRuntimeIntComps () const { return m_num_runtime_int; }
1398
1399 int NumRealComps () const { return NArrayReal + NumRuntimeRealComps(); }
1400 int NumIntComps () const { return NArrayInt + NumRuntimeIntComps() ; }
1401
1407 void ResizeRuntimeRealComp (int new_size, bool communicate);
1408
1414 void ResizeRuntimeIntComp (int new_size, bool communicate);
1415
1417 template <template<class> class NewAllocator=amrex::DefaultAllocator>
1419
1430 template <template<class> class NewAllocator=Allocator>
1432 make_alike () const
1433 {
1435
1436 std::vector<std::string> const real_names = this->GetRealSoANames();
1437 std::vector<std::string> real_ct_names(NArrayReal);
1438 for (int ic = 0; ic < NArrayReal; ++ic) { real_ct_names.at(ic) = real_names[ic]; }
1439
1440 std::vector<std::string> const int_names = this->GetIntSoANames();
1441 std::vector<std::string> int_ct_names(NArrayInt);
1442 for (int ic = 0; ic < NArrayInt; ++ic) { int_ct_names.at(ic) = int_names[ic]; }
1443
1444 tmp.SetSoACompileTimeNames(real_ct_names, int_ct_names);
1445
1446 // add runtime real comps to tmp
1447 for (int ic = 0; ic < this->NumRuntimeRealComps(); ++ic) {
1448 tmp.AddRealComp(real_names.at(ic + NArrayReal));
1449 }
1450
1451 // add runtime int comps to tmp
1452 for (int ic = 0; ic < this->NumRuntimeIntComps(); ++ic) {
1453 tmp.AddIntComp(int_names.at(ic + NArrayInt));
1454 }
1455
1458
1459 return tmp;
1460 }
1461
1464
1467 mutable bool usePrePost;
1468 mutable bool doUnlink;
1470 mutable int nOutFilesPrePost;
1476 mutable std::string HdrFileNamePrePost;
1478
1479protected:
1480
1494 template <typename P>
1495 bool Where (const P& prt, ParticleLocData& pld,
1496 int lev_min = 0, int lev_max = -1, IntVect nGrow=IntVect(0),
1497 int local_grid=-1) const;
1498
1499
1510 template <typename P>
1512 int lev_min = 0, int lev_max = -1, int local_grid=-1) const;
1513
1514public:
1516
1517 void
1518 WriteParticles (int level, std::ofstream& ofs, int fnum,
1519 Vector<int>& which, Vector<int>& count, Vector<Long>& where,
1520 const Vector<int>& write_real_comp, const Vector<int>& write_int_comp,
1521 const Vector<std::map<std::pair<int, int>,FlagsVector>>& particle_io_flags, bool is_checkpoint) const;
1522#ifdef AMREX_USE_HDF5
1523#include "AMReX_ParticlesHDF5.H"
1524#endif
1525
1526public: // NOLINT(readability-redundant-access-specifiers)
1528 void SetSoACompileTimeNames (std::vector<std::string> const & rdata_name, std::vector<std::string> const & idata_name);
1529
1531 std::vector<std::string> GetRealSoANames () const {return m_soa_rdata_names;}
1532
1534 std::vector<std::string> GetIntSoANames () const {return m_soa_idata_names;}
1535
1541 bool HasRealComp (std::string const & name);
1542
1548 bool HasIntComp (std::string const & name);
1549
1557 int GetRealCompIndex (std::string const & name);
1558
1566 int GetIntCompIndex (std::string const & name);
1567
1568protected:
1569
1570 template <class RTYPE>
1571 void ReadParticles (int cnt, int grd, int lev, std::ifstream& ifs, int finest_level_in_file, bool convert_ids);
1572
1574
1587 bool RedistributeInPlace (int lev_min, int lev_max, IntVect nGrow, bool remove_negative);
1588
1590
1591private:
1592 virtual void particlePostLocate (ParticleType& /*p*/, const ParticleLocData& /*pld*/,
1593 const int /*lev*/) {}
1594
1595 virtual void correctCellVectors (int /*old_index*/, int /*new_index*/,
1596 int /*grid*/, const ParticleType& /*p*/) {}
1597
1598 void RedistributeMPI (std::map<int, Vector<char> >& not_ours,
1599 int lev_min = 0, int lev_max = 0, int nGrow = 0, int local=0);
1600
1602 int hostPartitionTile (ParticleTileType& src_tile,
1603 int lev, int gid, int tid,
1604 int lev_min, int lev_max, IntVect nGrow, bool local,
1605 bool remove_negative, int myproc,
1607 Gpu::DeviceVector<int>& levels,
1609 Gpu::DeviceVector<int>& src_indices,
1610 Gpu::DeviceVector<IntVect>& periodic_shift);
1611
1613 int hostPartitionTile (ParticleTileType& src_tile,
1614 int lev, int gid, int tid,
1615 int lev_min, int lev_max, int nGrow, int local,
1616 bool remove_negative, int myproc,
1618 Gpu::DeviceVector<int>& levels,
1620 Gpu::DeviceVector<int>& src_indices,
1621 Gpu::DeviceVector<IntVect>& periodic_shift)
1622 {
1623 return hostPartitionTile(src_tile, lev, gid, tid,
1624 lev_min, lev_max, IntVect(nGrow), local > 0,
1625 remove_negative, myproc,
1626 boxes, levels, tiles, src_indices, periodic_shift);
1627 }
1628
1629 template <typename P>
1630 void locateParticle (P& p, ParticleLocData& pld,
1631 int lev_min, int lev_max, IntVect nGrow, int local_grid=-1) const;
1632
1633 void Initialize ();
1634
1635 bool m_runtime_comps_defined{false};
1636 int m_num_runtime_real{0};
1637 int m_num_runtime_int{0};
1638
1639 size_t particle_size, superparticle_size;
1640 int num_real_comm_comps, num_int_comm_comps;
1641 Vector<ParticleLevel> m_particles;
1642
1643 // names of both compile-time and runtime Real and Int SoA data
1644 std::vector<std::string> m_soa_rdata_names;
1645 std::vector<std::string> m_soa_idata_names;
1646};
1647
1649template <int T_NStructReal, int T_NStructInt, int T_NArrayReal, int T_NArrayInt, template<class> class Allocator, class CellAssignor>
1650using ParticleContainer = ParticleContainer_impl<Particle<T_NStructReal, T_NStructInt>, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor>;
1651
1652template <int T_NArrayReal, int T_NArrayInt, template<class> class Allocator=DefaultAllocator, class CellAssignor=DefaultAssignor>
1653using ParticleContainerPureSoA = ParticleContainer_impl<SoAParticle<T_NArrayReal, T_NArrayInt>, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor>;
1654
1655template <class RType=ParticleReal, class IType=int, class CellAssignor=DefaultAssignor>
1657
1658}
1659
1660#include "AMReX_ParticleInit.H"
1662#include "AMReX_ParticleIO.H"
1663
1664#ifdef AMREX_USE_HDF5
1665#include "AMReX_ParticleHDF5.H"
1666#endif
1667
1668#endif /*_PARTICLES_H_*/
Fixed-size array types for use on GPU and CPU.
#define AMREX_FORCE_INLINE
Definition AMReX_Extension.H:123
Problem-domain geometry: maps between index space and physical space.
while parser_exe_t p
Definition AMReX_Parser_Exe_Body.H:33
double pdata[AMREX_PARSER_STACK_SIZE]
Definition AMReX_Parser_Exe_Body.H:11
#define AMREX_D_DECL(a, b, c)
Definition AMReX_SPACE.H:171
Reference-counted collection of Boxes.
Definition AMReX_BoxArray.H:681
A container for storing items in a set of bins.
Definition AMReX_DenseBins.H:155
Calculates the distribution of FABs to MPI processes.
Definition AMReX_DistributionMapping.H:55
static const RealDescriptor & Native64RealDescriptor()
Definition AMReX_FPC.cpp:137
static const RealDescriptor & Native32RealDescriptor()
NativeRealDescriptor is equivalent to Native32RealDescriptor if BL_FLOAT is used. Otherwise,...
Definition AMReX_FPC.cpp:124
Rectangular problem domain geometry.
Definition AMReX_Geometry.H:87
a one-thingy-per-box distributed object
Definition AMReX_LayoutData.H:13
Iterator for looping ever tiles and boxes of amrex::FabArray based containers.
Definition AMReX_MFIter.H:88
A collection (stored as an array) of FArrayBox objects.
Definition AMReX_MultiFab.H:40
Dynamically allocated vector for trivially copyable data.
Definition AMReX_PODVector.H:308
Definition AMReX_ParIter.H:147
Definition AMReX_ParGDB.H:13
Definition AMReX_ParIter.H:35
Definition AMReX_ParIter.H:118
ParGDBBase * m_gdb
Definition AMReX_ParticleContainerBase.H:320
void Define(ParGDBBase *gdb)
Definition AMReX_ParticleContainerBase.H:90
int numLevels() const
the number of defined levels in the ParticleContainer
Definition AMReX_ParticleContainerBase.H:229
Arena * arena() const
Definition AMReX_ParticleContainerBase.H:268
A distributed container for Particles sorted onto the levels, grids, and tiles of a block-structured ...
Definition AMReX_ParticleContainer.H:154
ParticleTileType & DefineAndReturnParticleTile(int lev, const Iterator &iter)
Define and return the ParticleTile for level "lev", and Iterator "iter".
Definition AMReX_ParticleContainer.H:1233
void WritePlotFilePre()
Definition AMReX_ParticleIO.H:563
void AssignDensity(int rho_index, Vector< std::unique_ptr< MultiFab > > &mf_to_be_filled, int lev_min, int ncomp, int finest_level, int ngrow=2) const
Functions depending the layout of the data. Use with caution.
Definition AMReX_AmrParticles.H:36
typename ParticleTileType::ConstParticleTileDataType ConstPTDType
Definition AMReX_ParticleContainer.H:203
void SetUseUnlink(bool tf) const
Definition AMReX_ParticleContainer.H:1307
bool GetLevelDirectoriesCreated() const
Definition AMReX_ParticleContainer.H:1295
IntVect Index(const P &p, int lev) const
Definition AMReX_ParticleContainerI.H:190
void Checkpoint(const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names) const
Writes a particle checkpoint to file, suitable for restarting. This version allows some components to...
Definition AMReX_ParticleIO.H:100
void AddIntComp(std::string const &name, int communicate=1)
Definition AMReX_ParticleContainer.H:1363
void ReorderParticles(int lev, const MFIter &mfi, const index_type *permutations)
Reorder particles on the tile given by lev and mfi using a the permutations array.
Definition AMReX_ParticleContainerI.H:1282
bool EnforcePeriodicWhere(P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int local_grid=-1) const
Checks whether the particle has crossed a periodic boundary in such a way that it is on levels lev_mi...
Definition AMReX_ParticleContainerI.H:286
Particle< NStructReal+NArrayReal, NStructInt+NArrayInt > SuperParticleType
Definition AMReX_ParticleContainer.H:179
void ResizeRuntimeIntComp(int new_size, bool communicate)
Definition AMReX_ParticleContainerI.H:2165
void Redistribute_impl(int lev_min, int lev_max, IntVect nGrow, bool local, IntVect max_cells_moved, bool remove_negative=true)
Definition AMReX_ParticleContainerI.H:1585
Vector< Vector< int > > whichPrePost
Definition AMReX_ParticleContainer.H:1473
ParticleContainer_impl(const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
Same as the above, but accepts different refinement ratios in each direction.
Definition AMReX_ParticleContainer.H:292
Vector< Vector< Long > > wherePrePost
Definition AMReX_ParticleContainer.H:1475
bool OK(int lev_min=0, int lev_max=-1, int nGrow=0) const
OK checks that all particles are in the right places (for some value of right).
Definition AMReX_ParticleContainerI.H:1937
ParticleTileType & ParticlesAt(int lev, const Iterator &iter)
Return the ParticleTile for level "lev" and Iterator "iter". Non-const version.
Definition AMReX_ParticleContainer.H:1176
void AddParticlesAtLevel(ParticleTileType &particles, int level, int nGrow=0)
Add particles from a pbox to the grid at this level.
Definition AMReX_ParticleContainerI.H:1963
std::conditional_t< is_rtsoa_pc, ParticleTileRT< typename ParticleType::RealType, typename ParticleType::IntType >, ParticleTile< ParticleType, NArrayReal, NArrayInt, Allocator > > ParticleTileType
Definition AMReX_ParticleContainer.H:192
void ReadParticleRealData(void *data, size_t size, std::istream &is)
Read a contiguous chunk of real particle data from an istream.
Definition AMReX_ParticleIO.H:31
void InitRandomPerBox(Long icount, ULong iseed, const ParticleInitData &pdata)
This initializes the container with icount randomly distributed particles per box,...
Definition AMReX_ParticleInit.H:1380
ParticleContainer_impl(ParticleContainer_impl &&) noexcept=default
void Checkpoint(const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names=Vector< std::string >(), const Vector< std::string > &int_comp_names=Vector< std::string >()) const
Writes a particle checkpoint to file, suitable for restarting.
Definition AMReX_ParticleContainer.H:792
bool PeriodicShift(P &p) const
Returns true if the particle was shifted.
Definition AMReX_ParticleContainerI.H:381
std::map< std::pair< int, int >, ParticleTileType > ParticleLevel
Definition AMReX_ParticleContainer.H:201
void InitFromAsciiFile(const std::string &file, int extradata, const IntVect *Nrep=nullptr)
Definition AMReX_ParticleInit.H:42
const ParticleTileType & ParticlesAt(int lev, const Iterator &iter) const
Return the ParticleTile for level "lev" and Iterator "iter". Const version.
Definition AMReX_ParticleContainer.H:1151
void WritePlotFilePost()
Definition AMReX_ParticleIO.H:573
bool GetUsePrePost() const
Definition AMReX_ParticleContainer.H:1300
void SetSoACompileTimeNames(std::vector< std::string > const &rdata_name, std::vector< std::string > const &idata_name)
Definition AMReX_ParticleContainerI.H:98
void Redistribute(int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
Redistribute puts all the particles back in the right places (for some value of right).
Definition AMReX_ParticleContainer.H:519
typename ParticleTileType::AoS AoS
Definition AMReX_ParticleContainer.H:204
ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt > ParticleInitData
Definition AMReX_ParticleContainer.H:197
typename SoA::RealVector RealVector
Definition AMReX_ParticleContainer.H:207
typename ParticleType::ConstType ConstParticleType
Definition AMReX_ParticleContainer.H:157
ParticleContainer_impl(const ParticleContainer_impl &)=delete
void WriteAsciiFile(const std::string &file)
Definition AMReX_ParticleIO.H:1018
ParticleContainer_impl(const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
Construct a particle container using a given Geometry, DistributionMapping, and BoxArray....
Definition AMReX_ParticleContainer.H:252
void SetParticleSize()
Definition AMReX_ParticleContainerI.H:17
amrex::ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, NewAllocator > ContainerLike
Definition AMReX_ParticleContainer.H:1418
void CheckpointPost()
Definition AMReX_ParticleIO.H:507
void InitNRandomPerCell(int n_per_cell, const ParticleInitData &pdata)
This initializes the particle container with n_per_cell randomly distributed particles per cell,...
Definition AMReX_ParticleInit.H:1578
void SetLevelDirectoriesCreated(bool tf)
Definition AMReX_ParticleContainer.H:1293
void RemoveParticlesAtLevel(int level)
The Following methods are for managing Virtual and Ghost Particles.
Definition AMReX_ParticleContainerI.H:780
const ParticleTileType & ParticlesAt(int lev, int grid, int tile) const
Return the ParticleTile for level "lev", grid "grid" and tile "tile." Const version.
Definition AMReX_ParticleContainer.H:1101
typename AoS::ParticleVector ParticleVector
Definition AMReX_ParticleContainer.H:209
void Define(const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
Define a default-constructed ParticleContainer using a ParGDB object. Single-level version.
Definition AMReX_ParticleContainer.H:334
void SortParticlesForDeposition(IntVect idx_type)
Sort particles on each tile such that particles adjacent in memory are likely to map to adjacent cell...
Definition AMReX_ParticleContainerI.H:1349
ParticleContainer_impl()
Default constructor - construct an empty particle container that has no concept of a level hierarchy....
Definition AMReX_ParticleContainer.H:222
void SetUsePrePost(bool tf) const
Definition AMReX_ParticleContainer.H:1297
int NumRealComps() const
Definition AMReX_ParticleContainer.H:1399
Long GetMaxNextIDPrePost() const
Definition AMReX_ParticleContainer.H:1304
void clearParticles()
Clear all the particles in this container. This does not free memory.
Definition AMReX_ParticleContainerI.H:1151
void ReadParticles(int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)
Definition AMReX_ParticleIO.H:837
void Increment(MultiFab &mf, int level)
Definition AMReX_ParticleContainerI.H:743
typename ParticleTileType::SoA SoA
Definition AMReX_ParticleContainer.H:205
void AssignCellDensitySingleLevel(int rho_index, MultiFab &mf, int level, int ncomp=1, int particle_lvl_offset=0) const
Definition AMReX_ParticleContainerI.H:1998
int NumRuntimeIntComps() const
Definition AMReX_ParticleContainer.H:1397
void CreateGhostParticles(int level, int ngrow, AoS &ghosts) const
Create ghost particles for a given level that are copies of particles near coarse->fine boundaries in...
Definition AMReX_ParticleContainerI.H:1106
PODVector< int, Allocator< int > > FlagsVector
Definition AMReX_ParticleContainer.H:1515
Long GetNParticlesPrePost() const
Definition AMReX_ParticleContainer.H:1305
void SortParticlesByBin(IntVect bin_size)
Sort the particles on each tile by groups of cells, given an IntVect bin_size.
Definition AMReX_ParticleContainerI.H:1315
void InitOnePerCell(Real x_off, Real y_off, Real z_off, const ParticleInitData &pdata)
This initializes the particle container with one particle per cell, where the other particle data and...
Definition AMReX_ParticleInit.H:1488
bool HasIntComp(std::string const &name)
Definition AMReX_ParticleContainerI.H:137
const Vector< ParticleLevel > & GetParticles() const
Return the underlying Vector (over AMR levels) of ParticleLevels. Const version.
Definition AMReX_ParticleContainer.H:1041
const ParticleLevel & GetParticles(int lev) const
Return the ParticleLevel for level "lev". Const version.
Definition AMReX_ParticleContainer.H:1062
std::vector< std::string > GetRealSoANames() const
Definition AMReX_ParticleContainer.H:1531
DenseBins< typename ParticleTileType::ParticleTileDataType > m_bins
Definition AMReX_ParticleContainer.H:1589
void WriteBinaryParticleData(const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F const &f, bool is_checkpoint=false) const
Writes particle data to disk in the AMReX native format.
Definition AMReX_ParticleIO.H:426
void CheckpointPre()
Definition AMReX_ParticleIO.H:450
void ShrinkToFit()
Definition AMReX_ParticleContainerI.H:723
ParticleContainer_impl(ParGDBBase *gdb)
Construct a particle container using a ParGDB object. The container will track changes in the grid st...
Definition AMReX_ParticleContainer.H:236
ParConstIter_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor > ParConstIterType
Definition AMReX_ParticleContainer.H:212
bool HasRealComp(std::string const &name)
Definition AMReX_ParticleContainerI.H:129
void Redistribute(int lev_min, int lev_max, IntVect nGrow, bool local, IntVect max_cells_moved, bool remove_negative=true)
Definition AMReX_ParticleContainerI.H:1260
void InitRandom(Long icount, ULong iseed, const ParticleInitData &pdata, bool serialize=false, RealBox bx=RealBox())
This initializes the particle container with icount randomly distributed particles....
Definition AMReX_ParticleInit.H:985
void Define(const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
Define a default-constructed ParticleContainer using a ParGDB object. Multi-level version.
Definition AMReX_ParticleContainer.H:371
void resizeData() override
This resizes the vector of dummy MultiFabs used by the ParticleContainer for the current number of le...
Definition AMReX_ParticleContainerI.H:440
int NumRuntimeRealComps() const
Definition AMReX_ParticleContainer.H:1396
void ResizeRuntimeRealComp(int new_size, bool communicate)
Definition AMReX_ParticleContainerI.H:2139
void AddIntComp(int communicate=1)
Definition AMReX_ParticleContainer.H:1391
void CreateGhostParticles(int level, int ngrow, ParticleTileType &ghosts) const
Create ghost particles for a given level that are copies of particles near coarse->fine boundaries in...
Definition AMReX_ParticleContainerI.H:1117
Vector< std::string > filePrefixPrePost
Definition AMReX_ParticleContainer.H:1477
int numLocalTilesAtLevel(int lev) const
The total number of tiles on this rank on this level.
Definition AMReX_ParticleContainer.H:382
bool OutsidePeriodic(const P &p) const
Returns true if PeriodicShift would shift the particle, i.e. if its position is outside the domain in...
Definition AMReX_ParticleContainerI.H:368
Long IncrementWithTotal(MultiFab &mf, int level, bool local=false)
Definition AMReX_ParticleContainerI.H:770
bool RedistributeInPlace(int lev_min, int lev_max, IntVect nGrow, bool remove_negative)
Definition AMReX_ParticleContainerI.H:1466
Long NumberOfParticlesAtLevel(int level, bool only_valid=true, bool only_local=false) const
Returns # of particles at specified the level.
Definition AMReX_ParticleContainerI.H:573
void SortParticlesByCell()
Sort the particles on each tile by cell, using Fortran ordering.
Definition AMReX_ParticleContainerI.H:1306
typename Particle< NStructReal, NStructInt >::RealType RealType
Definition AMReX_ParticleContainer.H:181
bool GetUseUnlink() const
Definition AMReX_ParticleContainer.H:1311
int GetRealCompIndex(std::string const &name)
Definition AMReX_ParticleContainerI.H:150
void InitFromBinaryMetaFile(const std::string &file, int extradata)
Definition AMReX_ParticleInit.H:946
int NumIntComps() const
Definition AMReX_ParticleContainer.H:1400
void ReserveForRedistribute(ParticleCopyPlan const &plan)
Definition AMReX_ParticleContainerI.H:1902
bool Where(const P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, IntVect nGrow=IntVect(0), int local_grid=-1) const
Checks a particle's location on levels lev_min and higher. Returns false if the particle does not exi...
Definition AMReX_ParticleContainerI.H:205
typename ParticleTileType::ParticleTileDataType PTDType
Definition AMReX_ParticleContainer.H:202
ParticleContainer_impl & operator=(const ParticleContainer_impl &)=delete
ParticleLevel & GetParticles(int lev)
Return the ParticleLevel for level "lev". Non-const version.
Definition AMReX_ParticleContainer.H:1077
void Restart(const std::string &dir, const std::string &file, bool is_checkpoint)
Older version, for backwards compatibility.
Definition AMReX_ParticleIO.H:642
void Redistribute_impl(int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
Definition AMReX_ParticleContainer.H:1315
int GetIntCompIndex(std::string const &name)
Definition AMReX_ParticleContainerI.H:172
ParticleTileType & DefineAndReturnParticleTile(int lev, int grid, int tile)
Define and return the ParticleTile for level "lev", grid "grid" and tile "tile.".
Definition AMReX_ParticleContainer.H:1201
std::vector< std::string > GetIntSoANames() const
Definition AMReX_ParticleContainer.H:1534
void RemoveParticlesNotAtFinestLevel()
Definition AMReX_ParticleContainerI.H:794
Vector< Long > NumberOfParticlesInGrid(int level, bool only_valid=true, bool only_local=false) const
Definition AMReX_ParticleContainerI.H:517
ParticleContainer_impl(const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
Construct a particle container using a given Geometry, DistributionMapping, BoxArray and Vector of re...
Definition AMReX_ParticleContainer.H:272
void Restart(const std::string &dir, const std::string &file)
Restart from checkpoint.
Definition AMReX_ParticleIO.H:651
Long superParticleSize() const
Definition AMReX_ParticleContainer.H:1328
ParticleLocData Reset(ParticleType &prt, bool update, bool verbose=true, ParticleLocData pld=ParticleLocData()) const
Updates a particle's location (Where), tries to periodic shift any particles that have left the domai...
Definition AMReX_ParticleContainerI.H:397
Gpu::DeviceVector< char > CharVector
Definition AMReX_ParticleContainer.H:210
void Define(const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
Define a default-constructed ParticleContainer using a ParGDB object. Multi-level version.
Definition AMReX_ParticleContainer.H:352
std::array< Long, 3 > PrintCapacity() const
Definition AMReX_ParticleContainerI.H:683
void CreateVirtualParticles(int level, AoS &virts) const
Creates virtual particles for a given level that represent in some capacity all particles at finer le...
Definition AMReX_ParticleContainerI.H:861
static constexpr bool has_polymorphic_allocator
Definition AMReX_ParticleContainer.H:214
ParIter_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor > ParIterType
Definition AMReX_ParticleContainer.H:211
void WriteParticles(int level, std::ofstream &ofs, int fnum, Vector< int > &which, Vector< int > &count, Vector< Long > &where, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::map< std::pair< int, int >, FlagsVector > > &particle_io_flags, bool is_checkpoint) const
Definition AMReX_ParticleIO.H:583
ParticleTileType & ParticlesAt(int lev, int grid, int tile)
Return the ParticleTile for level "lev", grid "grid" and tile "tile." Non-const version.
Definition AMReX_ParticleContainer.H:1126
void InitFromBinaryFile(const std::string &file, int extradata)
Definition AMReX_ParticleInit.H:490
void AddRealComp(std::string const &name, int communicate=1)
Definition AMReX_ParticleContainer.H:1330
std::array< Long, 3 > ByteSpread() const
Definition AMReX_ParticleContainerI.H:639
void WriteParticleRealData(void *data, size_t size, std::ostream &os) const
Write a contiguous chunk of real particle data to an ostream.
Definition AMReX_ParticleIO.H:17
ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignor > ParticleContainerType
Definition AMReX_ParticleContainer.H:191
ContainerLike< NewAllocator > make_alike() const
Definition AMReX_ParticleContainer.H:1432
void AddRealComp(int communicate=1)
Definition AMReX_ParticleContainer.H:1358
void AddParticlesAtLevel(AoS &particles, int level, int nGrow=0)
Add particles from a pbox to the grid at this level.
Definition AMReX_ParticleContainerI.H:1952
~ParticleContainer_impl() override=default
Long TotalNumberOfParticles(bool only_valid=true, bool only_local=false) const
Returns # of particles at all levels.
Definition AMReX_ParticleContainerI.H:502
void reserveData() override
This reserves data in the vector of dummy MultiFabs used by the ParticleContainer for the maximum num...
Definition AMReX_ParticleContainerI.H:431
Vector< ParticleLevel > & GetParticles()
Return the underlying Vector (over AMR levels) of ParticleLevels. Non-const version.
Definition AMReX_ParticleContainer.H:1047
void CreateVirtualParticles(int level, ParticleTileType &virts) const
Creates virtual particles for a given level that represent in some capacity all particles at finer le...
Definition AMReX_ParticleContainerI.H:872
Vector< Vector< int > > countPrePost
Definition AMReX_ParticleContainer.H:1474
Definition AMReX_GpuAllocators.H:156
A Box with real dimensions.
Definition AMReX_RealBox.H:28
A Descriptor of the Real Type.
Definition AMReX_FabConv.H:116
This class is a thin wrapper around std::vector. Unlike vector, Vector::operator[] provides bound che...
Definition AMReX_Vector.H:29
amrex_real Real
Floating Point Type for Fields.
Definition AMReX_REAL.H:80
amrex_particle_real ParticleReal
Floating Point Type for Particles.
Definition AMReX_REAL.H:91
amrex_ulong ULong
Unsigned integer type guaranteed to be wider than unsigned int.
Definition AMReX_INT.H:32
amrex_long Long
Definition AMReX_INT.H:30
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, F const &f) const
This version of WritePlotFile assigns component names, but allows the user to pass in a vector of int...
Definition AMReX_ParticleIO.H:372
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names) const
This version of WritePlotFile writes all components and allows the user to specify the names of the c...
Definition AMReX_ParticleIO.H:146
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F const &f) const
This version of WritePlotFile writes all components and allows the user to specify the names of the c...
Definition AMReX_ParticleIO.H:302
void Checkpoint(const std::string &dir, const std::string &name, bool is_checkpoint, const Vector< std::string > &real_comp_names=Vector< std::string >(), const Vector< std::string > &int_comp_names=Vector< std::string >()) const
Writes a particle checkpoint to file, suitable for restarting. This version allows the particle compo...
Definition AMReX_ParticleIO.H:54
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp) const
This version of WritePlotFile assigns component names, but allows the user to pass in a vector of int...
Definition AMReX_ParticleIO.H:216
void WritePlotFile(const std::string &dir, const std::string &name, F const &f) const
This version of WritePlotFile writes all components and assigns component names.
Definition AMReX_ParticleIO.H:272
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names) const
This is the most general version of WritePlotFile, which takes component names and flags for whether ...
Definition AMReX_ParticleIO.H:252
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F const &f) const
This is the most general version of WritePlotFile, which takes component names and flags for whether ...
Definition AMReX_ParticleIO.H:407
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, F const &f) const
This version of WritePlotFile writes all components and allows the user to specify the names of the c...
Definition AMReX_ParticleIO.H:335
void WritePlotFile(const std::string &dir, const std::string &name) const
This version of WritePlotFile writes all components and assigns component names.
Definition AMReX_ParticleIO.H:116
void WritePlotFile(const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names) const
This version of WritePlotFile writes all components and allows the user to specify the names of the c...
Definition AMReX_ParticleIO.H:179
PODVector< T, ArenaAllocator< T > > DeviceVector
A PODVector that uses the standard memory Arena. Note that the memory might or might not be managed d...
Definition AMReX_GpuContainers.H:24
ParticleContainer_impl< Particle< T_NStructReal, T_NStructInt >, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor > ParticleContainer
Definition AMReX_ParIter.H:29
Definition AMReX_Amr.cpp:50
ParticleContainer_impl< RTSoAParticle< RType, IType >, 0, 0, PolymorphicArenaAllocator, CellAssignor > ParticleContainerRTSoA
Definition AMReX_ParticleContainer.H:1656
@ F
Definition AMReX_Order.H:7
std::string getDefaultCompNameInt(const int i)
Definition AMReX_ParticleUtil.H:1168
amrex::ArenaAllocator< T > DefaultAllocator
Definition AMReX_GpuAllocators.H:205
BoxND< 3 > Box
Box is an alias for amrex::BoxND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:35
std::string getDefaultCompNameReal(const int i)
Definition AMReX_ParticleUtil.H:1153
ParticleContainer_impl< SoAParticle< T_NArrayReal, T_NArrayInt >, T_NArrayReal, T_NArrayInt, Allocator, CellAssignor > ParticleContainerPureSoA
Definition AMReX_ParticleContainer.H:1653
IntVectND< 3 > IntVect
IntVect is an alias for amrex::IntVectND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:38
Definition AMReX_ParticleUtil.H:445
Definition AMReX_TypeTraits.H:90
Definition AMReX_GpuAllocators.H:184
A struct used for communicating particle data across processes during multi-level operations.
Definition AMReX_ParticleContainer.H:81
RealType m_data[1+3]
Definition AMReX_ParticleContainer.H:86
ParticleReal RealType
Definition AMReX_ParticleContainer.H:82
int m_grid
Definition AMReX_ParticleContainer.H:84
IntVect m_cell
Definition AMReX_ParticleContainer.H:85
int m_lev
Definition AMReX_ParticleContainer.H:83
Definition AMReX_ParticleCommunication.H:92
A struct used to pass initial data into the various Init methods. This struct is used to pass initial...
Definition AMReX_ParticleContainer.H:119
std::array< int, NStructInt > int_struct_data
Definition AMReX_ParticleContainer.H:121
std::array< int, NArrayInt > int_array_data
Definition AMReX_ParticleContainer.H:123
std::array< double, NArrayReal > real_array_data
Definition AMReX_ParticleContainer.H:122
std::array< double, NStructReal > real_struct_data
Definition AMReX_ParticleContainer.H:120
A struct used for storing a particle's position in the AMR hierarchy.
Definition AMReX_ParticleContainer.H:93
Box m_grown_gridbox
Definition AMReX_ParticleContainer.H:100
IntVect m_cell
Definition AMReX_ParticleContainer.H:97
int m_grid
Definition AMReX_ParticleContainer.H:95
int m_tile
Definition AMReX_ParticleContainer.H:96
int m_lev
Definition AMReX_ParticleContainer.H:94
Box m_tilebox
Definition AMReX_ParticleContainer.H:99
Box m_gridbox
Definition AMReX_ParticleContainer.H:98
Definition AMReX_ParticleTileRT.H:383
Definition AMReX_ParticleTile.H:764
The struct used to store particles.
Definition AMReX_Particle.H:405
ParticleReal RealType
The floating point type used for the particles.
Definition AMReX_Particle.H:418