1#ifndef AMREX_PARTICLE_CONTAINER_H_
2#define AMREX_PARTICLE_CONTAINER_H_
3#include <AMReX_Config.H>
20#include <AMReX_Particle_mod_K.H>
73#ifdef AMREX_USE_HDF5_ASYNC
74 extern hid_t es_par_g;
117template<
int NStructReal,
int NStructInt,
int NArrayReal,
int NArrayInt>
126template <
bool is_const,
typename T_ParticleType,
int NArrayReal,
int NArrayInt,
127 template<
class>
class Allocator,
class CellAssignor>
149template <
typename T_ParticleType,
int T_NArrayReal,
int T_NArrayInt,
176 template <
typename T>
183#ifdef AMREX_SINGLE_PRECISION_PARTICLES
189 static constexpr bool is_rtsoa_pc = ParticleType::is_rtsoa_particle;
202 using PTDType =
typename ParticleTileType::ParticleTileDataType;
203 using ConstPTDType =
typename ParticleTileType::ConstParticleTileDataType;
204 using AoS =
typename ParticleTileType::AoS;
205 using SoA =
typename ParticleTileType::SoA;
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");
383 return (lev < m_particles.size()) ? m_particles[lev].size() : 0;
401 const IntVect* Nrep =
nullptr);
520 int local = 0,
bool remove_negative=
true)
523 local > 0,
IntVect(local), remove_negative);
537 bool local,
IntVect max_cells_moved,
538 bool remove_negative=
true);
552 template <
class index_type>
594 bool OK (
int lev_min = 0,
int lev_max = -1,
int nGrow = 0)
const;
619 template <std::
integral Int>
620 requires (
sizeof(Int) >=
sizeof(
Long))
716 template <
class PCType>
727 template <
class PCType>
745 template <
class F,
class PCType>
762 template <
class F,
class PCType>
792 void Checkpoint (
const std::string& dir,
const std::string& name,
796 Checkpoint(dir, name,
true, real_comp_names, int_comp_names);
804 void Checkpoint (
const std::string& dir,
const std::string& name,
bool is_checkpoint,
820 void Checkpoint (
const std::string& dir,
const std::string& name,
842 const std::string& name,
847 F const& f,
bool is_checkpoint=
false)
const;
859 void Restart (
const std::string& dir,
const std::string& file);
868 void Restart (
const std::string& dir,
const std::string& file,
bool is_checkpoint);
890 void WritePlotFile (
const std::string& dir,
const std::string& name,
F const& f)
const;
960 const std::string& name,
980 const std::string& name,
998 const std::string& name,
1024 const std::string& name,
1102 {
return m_particles[lev].at(std::make_pair(grid, tile)); }
1127 {
return m_particles[lev].at(std::make_pair(grid, tile)); }
1150 template <
class Iterator>
1152 {
return ParticlesAt(lev, iter.index(), iter.LocalTileIndex()); }
1175 template <
class Iterator>
1177 {
return ParticlesAt(lev, iter.index(), iter.LocalTileIndex()); }
1203 m_particles[lev][std::make_pair(grid, tile)].define(
1205 &m_soa_rdata_names, &m_soa_idata_names,
1232 template <
class Iterator>
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,
1255 Vector<std::unique_ptr<MultiFab> >& mf_to_be_filled,
1256 int lev_min,
int ncomp,
int finest_level,
int ngrow=2)
const;
1259 int ncomp=1,
int particle_lvl_offset = 0)
const;
1261 template <
typename P,
typename Assignor=CellAssignor>
1281 template <
typename P>
1290 template <
typename P>
1316 int local = 0,
bool remove_negative=
true)
1319 local > 0,
IntVect(local), remove_negative);
1323 bool local,
IntVect max_cells_moved,
1324 bool remove_negative=
true);
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.");
1337 m_soa_rdata_names.push_back(name);
1339 m_runtime_comps_defined =
true;
1340 m_num_runtime_real++;
1346 for (
int lev = 0; lev <
numLevels(); ++lev) {
1347 for (
ParIterType pti(*
this,lev); pti.isValid(); ++pti) {
1349 auto np = tile.numParticles();
1351 auto& soa = tile.GetStructOfArrays();
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.");
1370 m_soa_idata_names.push_back(name);
1372 m_runtime_comps_defined =
true;
1373 m_num_runtime_int++;
1379 for (
int lev = 0; lev <
numLevels(); ++lev) {
1380 for (
ParIterType pti(*
this,lev); pti.isValid(); ++pti) {
1382 auto np = tile.numParticles();
1384 auto& soa = tile.GetStructOfArrays();
1430 template <
template<
class>
class NewAllocator=Allocator>
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]; }
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]; }
1494 template <
typename P>
1497 int local_grid=-1)
const;
1510 template <
typename P>
1512 int lev_min = 0,
int lev_max = -1,
int local_grid=-1)
const;
1521 const Vector<std::map<std::pair<int, int>,
FlagsVector>>& particle_io_flags,
bool is_checkpoint)
const;
1522#ifdef AMREX_USE_HDF5
1570 template <
class RTYPE>
1571 void ReadParticles (
int cnt,
int grd,
int lev, std::ifstream& ifs,
int finest_level_in_file,
bool convert_ids);
1595 virtual void correctCellVectors (
int ,
int ,
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);
1603 int lev,
int gid,
int tid,
1604 int lev_min,
int lev_max,
IntVect nGrow,
bool local,
1605 bool remove_negative,
int myproc,
1614 int lev,
int gid,
int tid,
1615 int lev_min,
int lev_max,
int nGrow,
int local,
1616 bool remove_negative,
int myproc,
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);
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;
1635 bool m_runtime_comps_defined{
false};
1636 int m_num_runtime_real{0};
1637 int m_num_runtime_int{0};
1639 size_t particle_size, superparticle_size;
1640 int num_real_comm_comps, num_int_comm_comps;
1641 Vector<ParticleLevel> m_particles;
1644 std::vector<std::string> m_soa_rdata_names;
1645 std::vector<std::string> m_soa_idata_names;
1649template <
int T_NStructReal,
int T_NStructInt,
int T_NArrayReal,
int T_NArrayInt,
template<
class>
class Allocator,
class CellAssignor>
1655template <
class RType=ParticleReal,
class IType=
int,
class CellAssignor=DefaultAssignor>
1664#ifdef AMREX_USE_HDF5
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
ParticleContainerBase()=default
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
Vector< Long > nParticlesAtLevelPrePost
Definition AMReX_ParticleContainer.H:1472
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
bool doUnlink
Definition AMReX_ParticleContainer.H:1468
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
std::string HdrFileNamePrePost
Definition AMReX_ParticleContainer.H:1476
Vector< Vector< Long > > wherePrePost
Definition AMReX_ParticleContainer.H:1475
RealDescriptor ParticleRealDescriptor
Definition AMReX_ParticleContainer.H:186
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
int nOutFilesPrePost
Definition AMReX_ParticleContainer.H:1470
void CapacityOfParticlesInGrid(LayoutData< Int > &mem, int lev) const
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
bool levelDirectoriesCreated
Definition AMReX_ParticleContainer.H:1466
static constexpr int NArrayInt
Definition AMReX_ParticleContainer.H:167
void InitFromAsciiFile(const std::string &file, int extradata, const IntVect *Nrep=nullptr)
Definition AMReX_ParticleInit.H:42
static constexpr int NArrayReal
Definition AMReX_ParticleContainer.H:165
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
static constexpr int NStructInt
Definition AMReX_ParticleContainer.H:163
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
Vector< int > h_redistribute_int_comp
Definition AMReX_ParticleContainer.H:1463
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
CellAssignor CellAssignor
Definition AMReX_ParticleContainer.H:158
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
Long nparticlesPrePost
Definition AMReX_ParticleContainer.H:1471
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
static constexpr int NStructReal
Definition AMReX_ParticleContainer.H:161
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
Vector< int > h_redistribute_real_comp
Definition AMReX_ParticleContainer.H:1462
void addParticles(const PCType &other, bool local=false)
typename Particle< NStructReal, NStructInt >::RealType RealType
Definition AMReX_ParticleContainer.H:181
static constexpr bool is_rtsoa_pc
Definition AMReX_ParticleContainer.H:189
bool GetUseUnlink() const
Definition AMReX_ParticleContainer.H:1311
int GetRealCompIndex(std::string const &name)
Definition AMReX_ParticleContainerI.H:150
Long maxnextidPrePost
Definition AMReX_ParticleContainer.H:1469
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
Allocator< T > AllocatorType
Definition AMReX_ParticleContainer.H:177
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 copyParticles(const PCType &other, bool local=false)
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
void Define(ParGDBBase *gdb)
Definition AMReX_ParticleContainer.H:320
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
typename SoA::IntVector IntVector
Definition AMReX_ParticleContainer.H:208
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
T_ParticleType ParticleType
Definition AMReX_ParticleContainer.H:156
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
bool usePrePost
Definition AMReX_ParticleContainer.H:1467
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