#include <NamedComponentParticleContainer.H>

Inheritance diagram for NamedComponentParticleContainer< T_Allocator >:

Public Member Functions
	NamedComponentParticleContainer ()

	NamedComponentParticleContainer (amrex::AmrParGDB *amr_pgdb)

virtual	~NamedComponentParticleContainer ()=default

	NamedComponentParticleContainer (amrex::ParticleContainer< 0, 0, 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 (NamedComponentParticleContainer &&)=default

NamedComponentParticleContainer &	operator= (NamedComponentParticleContainer &&)=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)

std::map< std::string, int >	getParticleComps () const noexcept

std::map< std::string, int >	getParticleiComps () const noexcept

std::map< std::string, int >	getParticleRuntimeComps () const noexcept

std::map< std::string, int >	getParticleRuntimeiComps () const noexcept

Public Member Functions inherited from amrex::ParticleContainer< 0, 0, PIdx::nattribs, 0, T_Allocator >
	ParticleContainer ()

	ParticleContainer (ParGDBBase *gdb)

	ParticleContainer (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)

	ParticleContainer (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)

	ParticleContainer (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)

	ParticleContainer (const ParticleContainer &)=delete

	ParticleContainer (ParticleContainer &&)=default

virtual	~ParticleContainer ()=default

ParticleContainer &	operator= (const ParticleContainer &)=delete

ParticleContainer &	operator= (ParticleContainer &&)=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 &mass, 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	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	CreateVirtualParticles (int level, ParticleTileType &virts) const

void	CreateGhostParticles (int level, int ngrow, AoS &ghosts) const

void	CreateGhostParticles (int level, int ngrow, ParticleTileType &ghosts) const

void	AddParticlesAtLevel (AoS &particles, int level, int nGrow=0)

void	AddParticlesAtLevel (ParticleTileType &particles, int level, int nGrow=0)

void	clearParticles ()

void	copyParticles (const PCType &other, bool local=false)

void	copyParticles (const PCType &other, F &&f, bool local=false)

void	copyParticles (const PCType &other, bool local)

void	copyParticles (const PCType &other, F &&f, bool local)

void	addParticles (const PCType &other, bool local=false)

void	addParticles (const PCType &other, F &&f, bool local=false)

void	addParticles (const PCType &other, bool local)

void	addParticles (const PCType &other, F &&f, bool local)

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	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	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	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	WritePlotFilePre ()

void	WritePlotFilePost ()

void	WriteAsciiFile (const std::string &file)

const Vector< ParticleLevel > &	GetParticles () const

Vector< ParticleLevel > &	GetParticles ()

const ParticleLevel &	GetParticles (int lev) const

ParticleLevel &	GetParticles (int lev)

const ParticleTileType &	ParticlesAt (int lev, int grid, int tile) const

ParticleTileType &	ParticlesAt (int lev, int grid, int tile)

const ParticleTileType &	ParticlesAt (int lev, const Iterator &iter) const

ParticleTileType &	ParticlesAt (int lev, const Iterator &iter)

ParticleTileType &	DefineAndReturnParticleTile (int lev, int grid, int tile)

ParticleTileType &	DefineAndReturnParticleTile (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	Interpolate (Vector< std::unique_ptr< MultiFab > > &mesh_data, int lev_min, int lev_max)

void	InterpolateSingleLevel (MultiFab &mesh_data, int lev)

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

IntVect	Index (const P &p, int lev) const

ParticleLocData	Reset (ParticleType &prt, bool update, bool verbose=true, ParticleLocData pld=ParticleLocData()) const

bool	PeriodicShift (ParticleType &prt) 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

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

bool	Where (const P &p, ParticleLocData &pld, int lev_min, int lev_max, int nGrow, int local_grid) const

void	ReadParticles (int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)

Protected Attributes
std::map< std::string, int >	particle_comps

std::map< std::string, int >	particle_icomps

std::map< std::string, int >	particle_runtime_comps

std::map< std::string, int >	particle_runtime_icomps

Protected Attributes inherited from amrex::ParticleContainer< 0, 0, PIdx::nattribs, 0, T_Allocator >
DenseBins< ParticleType >	m_bins

Additional Inherited Members
Public Types inherited from amrex::ParticleContainer< 0, 0, PIdx::nattribs, 0, T_Allocator >
typedef T_Allocator< T >	AllocatorType

typedef Particle< NStructReal, NStructInt >	ParticleType

typedef Particle< NStructReal+NArrayReal, NStructInt+NArrayInt >	SuperParticleType

typedef typename Particle< NStructReal, NStructInt >::RealType	RealType

typedef ParticleContainer< NStructReal, NStructInt, NArrayReal, NArrayInt, T_Allocator >	ParticleContainerType

typedef ParticleTile< NStructReal, NStructInt, NArrayReal, NArrayInt, T_Allocator >	ParticleTileType

typedef ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayInt >	ParticleInitData

typedef std::map< std::pair< int, int >, ParticleTileType >	ParticleLevel

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 Gpu::PolymorphicVector< char >	SendBuffer

typedef ParIter< NStructReal, NStructInt, NArrayReal, NArrayInt, T_Allocator >	ParIterType

typedef ParConstIter< NStructReal, NStructInt, NArrayReal, NArrayInt, T_Allocator >	ParConstIterType

typedef amrex::ParticleContainer< NStructReal, NStructInt, NArrayReal, NArrayInt, NewAllocator >	ContainerLike

Public Attributes inherited from amrex::ParticleContainer< 0, 0, PIdx::nattribs, 0, T_Allocator >
RealDescriptor	ParticleRealDescriptor

Vector< int >	h_redistribute_real_comp

Vector< int >	h_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

Static Public Attributes inherited from amrex::ParticleContainer< 0, 0, PIdx::nattribs, 0, T_Allocator >
static constexpr int	NStructReal

static constexpr int	NStructInt

static constexpr int	NArrayReal

static constexpr int	NArrayInt

Protected Member Functions inherited from amrex::ParticleContainer< 0, 0, PIdx::nattribs, 0, T_Allocator >
bool	Where (const P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int nGrow=0, int local_grid=-1) const

void	ReadParticles (int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)

bool	EnforcePeriodicWhere (ParticleType &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int local_grid=-1) const

void	SetParticleSize ()

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 quantities - except those that are stored in an AoS by amrex, i.e. the particle positions and ID)

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

Template Parameters

T_Allocator Mainly 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/4]

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

NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( )

inline

Construct an empty NamedComponentParticleContainer

◆ NamedComponentParticleContainer() [2/4]

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_pgdb A 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>

virtual NamedComponentParticleContainer< T_Allocator >::~NamedComponentParticleContainer ( )

virtualdefault

Destructor for NamedComponentParticleContainer

◆ NamedComponentParticleContainer() [3/4]

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

NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer	(	amrex::ParticleContainer< 0, 0, 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

pc	regular particle container, where components are not named (only indexed)
p_comps	name-to-index map for compile-time and run-time real components
p_icomps	name-to-index map for compile-time and run-time integer components
p_rcomps	name-to-index map for run-time real components
p_ricomps	name-to-index map for run-time integer components

◆ NamedComponentParticleContainer() [4/4]

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

NamedComponentParticleContainer< T_Allocator >::NamedComponentParticleContainer ( NamedComponentParticleContainer< T_Allocator > && )

default

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

name	Name of the new component
comm	Whether 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

name	Name of the new component
comm	Whether to communicate this component, in the particle Redistribute

◆ 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=()

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

NamedComponentParticleContainer& NamedComponentParticleContainer< T_Allocator >::operator= ( NamedComponentParticleContainer< T_Allocator > && )

default

Move operator for NamedComponentParticleContainer

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:

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/22.11/Source/Particles/NamedComponentParticleContainer.H

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ NamedComponentParticleContainer() [1/4]

◆ NamedComponentParticleContainer() [2/4]

◆ ~NamedComponentParticleContainer()

◆ NamedComponentParticleContainer() [3/4]

◆ NamedComponentParticleContainer() [4/4]

Member Function Documentation

◆ AddIntComp()

◆ AddRealComp()

◆ getParticleComps()

◆ getParticleiComps()

◆ getParticleRuntimeComps()

◆ getParticleRuntimeiComps()

◆ make_alike()

◆ operator=()

Member Data Documentation

◆ particle_comps

◆ particle_icomps

◆ particle_runtime_comps

◆ particle_runtime_icomps

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