WarpX
Public Member Functions | Protected Attributes | List of all members
NamedComponentParticleContainer< T_Allocator > Class Template Reference

#include <NamedComponentParticleContainer.H>

Inheritance diagram for NamedComponentParticleContainer< T_Allocator >:
amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class > amrex::ParticleContainerBase

Public Member Functions

 NamedComponentParticleContainer ()
 
 NamedComponentParticleContainer (amrex::AmrParGDB *amr_pgdb)
 
 ~NamedComponentParticleContainer () override=default
 
 NamedComponentParticleContainer (amrex::ParticleContainerPureSoA< PIdx::nattribs, 0, T_Allocator > &&pc, std::map< std::string, int > p_comps, std::map< std::string, int > p_icomps, std::map< std::string, int > p_rcomps, std::map< std::string, int > p_ricomps)
 
 NamedComponentParticleContainer (const NamedComponentParticleContainer &)=delete
 
NamedComponentParticleContaineroperator= (const NamedComponentParticleContainer &)=delete
 
 NamedComponentParticleContainer (NamedComponentParticleContainer &&) noexcept=default
 
NamedComponentParticleContaineroperator= (NamedComponentParticleContainer &&) noexcept=default
 
template<template< class > class NewAllocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< NewAllocator > make_alike () const
 
void AddRealComp (const std::string &name, bool comm=true)
 
void AddIntComp (const std::string &name, bool comm=true)
 
void defineAllParticleTiles () noexcept
 
std::map< std::string, intgetParticleComps () const noexcept
 
std::map< std::string, intgetParticleiComps () const noexcept
 
std::map< std::string, intgetParticleRuntimeComps () const noexcept
 
std::map< std::string, intgetParticleRuntimeiComps () const noexcept
 
- Public Member Functions inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
 ParticleContainer_impl ()
 
 ParticleContainer_impl (ParGDBBase *gdb)
 
 ParticleContainer_impl (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
 ParticleContainer_impl (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
 ParticleContainer_impl (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
 ~ParticleContainer_impl () override=default
 
 ParticleContainer_impl (const ParticleContainer_impl &)=delete
 
ParticleContainer_imploperator= (const ParticleContainer_impl &)=delete
 
 ParticleContainer_impl (ParticleContainer_impl &&) noexcept=default
 
ParticleContainer_imploperator= (ParticleContainer_impl &&) noexcept=default
 
void Define (ParGDBBase *gdb)
 
void Define (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
int numLocalTilesAtLevel (int lev) const
 
void reserveData () override
 
void resizeData () override
 
void InitFromAsciiFile (const std::string &file, int extradata, const IntVect *Nrep=nullptr)
 
void InitFromBinaryFile (const std::string &file, int extradata)
 
void InitFromBinaryMetaFile (const std::string &file, int extradata)
 
void InitRandom (Long icount, ULong iseed, const ParticleInitData &pdata, bool serialize=false, RealBox bx=RealBox())
 
void InitRandomPerBox (Long icount, ULong iseed, const ParticleInitData &pdata)
 
void InitOnePerCell (Real x_off, Real y_off, Real z_off, const ParticleInitData &pdata)
 
void InitNRandomPerCell (int n_per_cell, const ParticleInitData &pdata)
 
void Increment (MultiFab &mf, int level)
 
Long IncrementWithTotal (MultiFab &mf, int level, bool local=false)
 
void Redistribute (int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
 
void ReorderParticles (int lev, const MFIter &mfi, const index_type *permutations)
 
void SortParticlesForDeposition (IntVect idx_type)
 
void SortParticlesByCell ()
 
void SortParticlesByBin (IntVect bin_size)
 
bool OK (int lev_min=0, int lev_max=-1, int nGrow=0) const
 
std::array< Long, 3 > ByteSpread () const
 
std::array< Long, 3 > PrintCapacity () const
 
void ShrinkToFit ()
 
Long NumberOfParticlesAtLevel (int level, bool only_valid=true, bool only_local=false) const
 
Vector< Long > NumberOfParticlesInGrid (int level, bool only_valid=true, bool only_local=false) const
 
Long TotalNumberOfParticles (bool only_valid=true, bool only_local=false) const
 
void RemoveParticlesAtLevel (int level)
 
void RemoveParticlesNotAtFinestLevel ()
 
void CreateVirtualParticles (int level, AoS &virts) const
 
void CreateGhostParticles (int level, int ngrow, AoS &ghosts) const
 
void AddParticlesAtLevel (AoS &particles, int level, int nGrow=0)
 
void CreateVirtualParticles (int level, ParticleTileType &virts) const
 
void CreateGhostParticles (int level, int ngrow, ParticleTileType &ghosts) const
 
void AddParticlesAtLevel (ParticleTileType &particles, int level, int nGrow=0)
 
void clearParticles ()
 
void copyParticles (const PCType &other, bool local=false)
 
void addParticles (const PCType &other, bool local=false)
 
void copyParticles (const PCType &other, F &&f, bool local=false)
 
void addParticles (const PCType &other, F const &f, bool local=false)
 
void WriteParticleRealData (void *data, size_t size, std::ostream &os) const
 
void ReadParticleRealData (void *data, size_t size, std::istream &is)
 
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
 
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
 
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 &&f, bool is_checkpoint=false) const
 
void CheckpointPre ()
 
void CheckpointPost ()
 
void Restart (const std::string &dir, const std::string &file)
 
void Restart (const std::string &dir, const std::string &file, bool is_checkpoint)
 
void WritePlotFile (const std::string &dir, const std::string &name) const
 
void WritePlotFile (const std::string &dir, const std::string &name, F &&f) const
 
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
 
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 &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, F &&f) const
 
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
 
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 &&f) const
 
void WritePlotFilePre ()
 
void WritePlotFilePost ()
 
void WriteAsciiFile (const std::string &file)
 
const Vector< ParticleLevel > & GetParticles () const
 
Vector< ParticleLevel > & GetParticles ()
 
const ParticleLevelGetParticles (int lev) const
 
ParticleLevelGetParticles (int lev)
 
const ParticleTileTypeParticlesAt (int lev, int grid, int tile) const
 
ParticleTileTypeParticlesAt (int lev, int grid, int tile)
 
const ParticleTileTypeParticlesAt (int lev, const Iterator &iter) const
 
ParticleTileTypeParticlesAt (int lev, const Iterator &iter)
 
ParticleTileTypeDefineAndReturnParticleTile (int lev, int grid, int tile)
 
ParticleTileTypeDefineAndReturnParticleTile (int lev, const Iterator &iter)
 
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
 
void AssignCellDensitySingleLevel (int rho_index, MultiFab &mf, int level, int ncomp=1, int particle_lvl_offset=0) const
 
IntVect Index (const P &p, int lev) const
 
ParticleLocData Reset (ParticleType &prt, bool update, bool verbose=true, ParticleLocData pld=ParticleLocData()) const
 
bool PeriodicShift (P &p) const
 
void SetLevelDirectoriesCreated (bool tf)
 
bool GetLevelDirectoriesCreated () const
 
void SetUsePrePost (bool tf) const
 
bool GetUsePrePost () const
 
int GetMaxNextIDPrePost () const
 
Long GetNParticlesPrePost () const
 
void SetUseUnlink (bool tf) const
 
bool GetUseUnlink () const
 
void RedistributeCPU (int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
 
void RedistributeGPU (int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
 
Long superParticleSize () const
 
void AddRealComp (T communicate=true)
 
void AddIntComp (T communicate=true)
 
int NumRuntimeRealComps () const
 
int NumRuntimeIntComps () const
 
int NumRealComps () const
 
int NumIntComps () const
 
void ResizeRuntimeRealComp (int new_size, bool communicate)
 
void ResizeRuntimeIntComp (int new_size, bool communicate)
 
ContainerLike< NewAllocator > make_alike () const
 
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 >, IntVector >> &particle_io_flags, bool is_checkpoint) const
 
IntVect Index (const P &p, int lev) const
 
bool Where (const P &p, ParticleLocData &pld, int lev_min, int lev_max, int nGrow, int local_grid) const
 
bool EnforcePeriodicWhere (P &p, ParticleLocData &pld, int lev_min, int lev_max, int local_grid) const
 
bool PeriodicShift (P &p) const
 
void locateParticle (P &p, ParticleLocData &pld, int lev_min, int lev_max, int nGrow, int local_grid) const
 
void copyParticles (const PCType &other, bool local)
 
void addParticles (const PCType &other, bool local)
 
void copyParticles (const PCType &other, F &&f, bool local)
 
void addParticles (const PCType &other, F const &f, bool local)
 
void ReorderParticles (int lev, const MFIter &mfi, const index_type *permutations)
 
void WritePlotFile (const std::string &dir, const std::string &name, F &&f) const
 
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 &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, F &&f) const
 
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 &&f) const
 
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 &&f, bool is_checkpoint) const
 
void ReadParticles (int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)
 
- Public Member Functions inherited from amrex::ParticleContainerBase
 ParticleContainerBase ()=default
 
 ParticleContainerBase (ParGDBBase *gdb)
 
 ParticleContainerBase (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
 ParticleContainerBase (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
 ParticleContainerBase (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
virtual ~ParticleContainerBase ()=default
 
 ParticleContainerBase (const ParticleContainerBase &)=delete
 
ParticleContainerBaseoperator= (const ParticleContainerBase &)=delete
 
 ParticleContainerBase (ParticleContainerBase &&)=default
 
ParticleContainerBaseoperator= (ParticleContainerBase &&)=default
 
void Define (ParGDBBase *gdb)
 
void Define (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
bool isDefined () const
 
void RedefineDummyMF (int lev)
 
MFIter MakeMFIter (int lev, const MFItInfo &info) const
 
MFIter MakeMFIter (int lev) const
 
MFIter MakeMFIter (int lev, bool tile) const
 
void SetParGDB (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
void SetParGDB (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
void SetParGDB (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
void SetParticleBoxArray (int lev, BoxArray new_ba)
 
void SetParticleDistributionMap (int lev, DistributionMapping new_dmap)
 
void SetParticleGeometry (int lev, Geometry new_geom)
 
const BoxArrayParticleBoxArray (int lev) const
 
const DistributionMappingParticleDistributionMap (int lev) const
 
const GeometryGeom (int lev) const
 
const GeometryParticleGeom (int lev) const
 
int finestLevel () const
 
int maxLevel () const
 
int numLevels () const
 
const ParGDBBaseGetParGDB () const
 
ParGDBBaseGetParGDB ()
 
int Verbose () const
 
void SetVerbose (int verbose)
 
const ParticleBufferMapBufferMap () const
 
Vector< intNeighborProcs (int ngrow) const
 
bool OnSameGrids (int level, const MF &mf) const
 

Protected Attributes

std::map< std::string, intparticle_comps
 
std::map< std::string, intparticle_icomps
 
std::map< std::string, intparticle_runtime_comps
 
std::map< std::string, intparticle_runtime_icomps
 
- Protected Attributes inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
DenseBins< typename ParticleTileType::ParticleTileDataTypem_bins
 
- Protected Attributes inherited from amrex::ParticleContainerBase
int m_verbose
 
std::unique_ptr< ParGDBm_gdb_object
 
ParGDBBasem_gdb
 
Vector< std::unique_ptr< MultiFab > > m_dummy_mf
 
std::unique_ptr< iMultiFabredistribute_mask_ptr
 
int redistribute_mask_nghost
 
amrex::Vector< intneighbor_procs
 
ParticleBufferMap m_buffer_map
 

Additional Inherited Members

- Public Types inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
typedef T_ParticleType ParticleType
 
typedef typename ParticleType::ConstType ConstParticleType
 
typedef T_CellAssignor CellAssignor
 
typedef Allocator< T > AllocatorType
 
typedef Particle< NStructReal+NArrayReal, NStructInt+NArrayIntSuperParticleType
 
typedef typename Particle< NStructReal, NStructInt >::RealType RealType
 
typedef ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignorParticleContainerType
 
typedef ParticleTile< ParticleType, NArrayReal, NArrayInt, Allocator > ParticleTileType
 
typedef ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayIntParticleInitData
 
typedef std::map< std::pair< int, int >, ParticleTileTypeParticleLevel
 
typedef typename ParticleTileType::AoS AoS
 
typedef typename ParticleTileType::SoA SoA
 
typedef typename SoA::RealVector RealVector
 
typedef typename SoA::IntVector IntVector
 
typedef typename AoS::ParticleVector ParticleVector
 
typedef Gpu::DeviceVector< char > CharVector
 
typedef ParIter_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignorParIterType
 
typedef ParConstIter_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignorParConstIterType
 
typedef amrex::ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, NewAllocator > ContainerLike
 
- Static Public Member Functions inherited from amrex::ParticleContainerBase
static const std::string & CheckpointVersion ()
 
static const std::string & PlotfileVersion ()
 
static const std::string & DataPrefix ()
 
static int MaxReaders ()
 
static Long MaxParticlesPerRead ()
 
static const std::string & AggregationType ()
 
static int AggregationBuffer ()
 
- Public Attributes inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
RealDescriptor ParticleRealDescriptor
 
Vector< inth_redistribute_real_comp
 
Vector< inth_redistribute_int_comp
 
bool levelDirectoriesCreated
 
bool usePrePost
 
bool doUnlink
 
int maxnextidPrePost
 
int nOutFilesPrePost
 
Long nparticlesPrePost
 
Vector< Long > nParticlesAtLevelPrePost
 
Vector< Vector< int > > whichPrePost
 
Vector< Vector< int > > countPrePost
 
Vector< Vector< Long > > wherePrePost
 
std::string HdrFileNamePrePost
 
Vector< std::string > filePrefixPrePost
 
- Public Attributes inherited from amrex::ParticleContainerBase
AmrParticleLocator< DenseBins< Box > > m_particle_locator
 
- Static Public Attributes inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
static constexpr int NStructReal
 
static constexpr int NStructInt
 
static constexpr int NArrayReal
 
static constexpr int NArrayInt
 
- Static Public Attributes inherited from amrex::ParticleContainerBase
static AMREX_EXPORT bool do_tiling
 
static AMREX_EXPORT IntVect tile_size
 
static AMREX_EXPORT bool memEfficientSort
 
- Protected Member Functions inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
bool Where (const P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int nGrow=0, int local_grid=-1) const
 
bool EnforcePeriodicWhere (P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int local_grid=-1) const
 
void ReadParticles (int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)
 
void SetParticleSize ()
 
- Protected Member Functions inherited from amrex::ParticleContainerBase
void BuildRedistributeMask (int lev, int nghost=1) const
 
void defineBufferMap () const
 

Detailed Description

template<template< class > class T_Allocator = amrex::DefaultAllocator>
class NamedComponentParticleContainer< T_Allocator >

Particle Container class that allows to add/access particle components with a name (string) instead of doing so with an integer index. (The "components" are all the particle amrex::Real quantities.)

This is done by storing maps that give the index of the component that corresponds to a given string.

Template Parameters
T_AllocatorMainly controls in which type of memory (e.g. device arena, pinned memory arena, etc.) the particle data will be stored

Constructor & Destructor Documentation

◆ NamedComponentParticleContainer() [1/5]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( )
inline

Construct an empty NamedComponentParticleContainer

◆ NamedComponentParticleContainer() [2/5]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( amrex::AmrParGDB amr_pgdb)
inline

Construct a NamedComponentParticleContainer from an AmrParGDB object

In this case, the only components are the default ones: weight, momentum and (in RZ geometry) theta.

Parameters
amr_pgdbA pointer to a ParGDBBase, which contains pointers to the Geometry, DistributionMapping, and BoxArray objects that define the AMR hierarchy. Usually, this is generated by an AmrCore or AmrLevel object.

◆ ~NamedComponentParticleContainer()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< T_Allocator >::~NamedComponentParticleContainer ( )
overridedefault

◆ NamedComponentParticleContainer() [3/5]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( amrex::ParticleContainerPureSoA< PIdx::nattribs, 0, T_Allocator > &&  pc,
std::map< std::string, int p_comps,
std::map< std::string, int p_icomps,
std::map< std::string, int p_rcomps,
std::map< std::string, int p_ricomps 
)
inline

Construct a NamedComponentParticleContainer from a regular amrex::ParticleContainer, and additional name-to-index maps

Parameters
pcregular particle container, where components are not named (only indexed)
p_compsname-to-index map for compile-time and run-time real components
p_icompsname-to-index map for compile-time and run-time integer components
p_rcompsname-to-index map for run-time real components
p_ricompsname-to-index map for run-time integer components

◆ NamedComponentParticleContainer() [4/5]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( const NamedComponentParticleContainer< T_Allocator > &  )
delete

Copy constructor for NamedComponentParticleContainer

◆ NamedComponentParticleContainer() [5/5]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( NamedComponentParticleContainer< T_Allocator > &&  )
defaultnoexcept

Move constructor for NamedComponentParticleContainer

Member Function Documentation

◆ AddIntComp()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
void NamedComponentParticleContainer< T_Allocator >::AddIntComp ( const std::string &  name,
bool  comm = true 
)
inline

Allocate a new run-time integer component

Parameters
nameName of the new component
commWhether to communicate this component, in the particle Redistribute

◆ AddRealComp()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
void NamedComponentParticleContainer< T_Allocator >::AddRealComp ( const std::string &  name,
bool  comm = true 
)
inline

Allocate a new run-time real component

Parameters
nameName of the new component
commWhether to communicate this component, in the particle Redistribute

◆ defineAllParticleTiles()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
void NamedComponentParticleContainer< T_Allocator >::defineAllParticleTiles ( )
inlinenoexcept

◆ getParticleComps()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::getParticleComps ( ) const
inlinenoexcept

Return the name-to-index map for the compile-time and runtime-time real components

◆ getParticleiComps()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::getParticleiComps ( ) const
inlinenoexcept

Return the name-to-index map for the compile-time and runtime-time integer components

◆ getParticleRuntimeComps()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::getParticleRuntimeComps ( ) const
inlinenoexcept

Return the name-to-index map for the runtime-time real components

◆ getParticleRuntimeiComps()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::getParticleRuntimeiComps ( ) const
inlinenoexcept

Return the name-to-index map for the runtime-time integer components

◆ make_alike()

template<template< class > class T_Allocator = amrex::DefaultAllocator>
template<template< class > class NewAllocator = amrex::DefaultAllocator>
NamedComponentParticleContainer<NewAllocator> NamedComponentParticleContainer< T_Allocator >::make_alike ( ) const
inline

Create an empty particle container

This creates a new NamedComponentParticleContainer with same compile-time and run-time attributes. But it can change its allocator.

This function overloads the corresponding function from the parent class (amrex::ParticleContainer)

◆ operator=() [1/2]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer& NamedComponentParticleContainer< T_Allocator >::operator= ( const NamedComponentParticleContainer< T_Allocator > &  )
delete

◆ operator=() [2/2]

template<template< class > class T_Allocator = amrex::DefaultAllocator>
NamedComponentParticleContainer& NamedComponentParticleContainer< T_Allocator >::operator= ( NamedComponentParticleContainer< T_Allocator > &&  )
defaultnoexcept

Member Data Documentation

◆ particle_comps

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::particle_comps
protected

◆ particle_icomps

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::particle_icomps
protected

◆ particle_runtime_comps

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::particle_runtime_comps
protected

◆ particle_runtime_icomps

template<template< class > class T_Allocator = amrex::DefaultAllocator>
std::map<std::string, int> NamedComponentParticleContainer< T_Allocator >::particle_runtime_icomps
protected

The documentation for this class was generated from the following file: