Templated class for holding particles on an AMR hierarchy with particle remapping. More...

#include <CD_ParticleContainer.H>

Inheritance diagram for ParticleContainer:

Public Types
using	ValidMask = RefCountedPtr< LevelData< BaseFab< bool > > >
	alias type alias.

Public Member Functions
	ParticleContainer ()
	Default constructor. Leaves object in undefined state.

	ParticleContainer (const Vector< DisjointBoxLayout > &a_grids, const Vector< ProblemDomain > &a_domains, const Vector< Real > &a_dx, const Vector< int > &a_refRat, const Vector< ValidMask > &a_validMask, const Vector< RefCountedPtr< LevelTiles > > &a_levelTiles, const RealVect &a_probLo, int a_blockingFactor, int a_finestLevel, std::string a_realm)
	Full constructor.

virtual	~ParticleContainer ()
	Destructor ( does nothing)

	ParticleContainer (const ParticleContainer &)=delete

ParticleContainer &	operator= (const ParticleContainer &)=delete

	ParticleContainer (ParticleContainer &&)=default
	Move constructor.

ParticleContainer &	operator= (ParticleContainer &&)=default
	Move assignment operator.

void	define (const Vector< DisjointBoxLayout > &a_grids, const Vector< ProblemDomain > &a_domains, const Vector< Real > &a_dx, const Vector< int > &a_refRat, const Vector< ValidMask > &a_validMask, const Vector< RefCountedPtr< LevelTiles > > &a_levelTiles, const RealVect &a_probLo, int a_blockingFactor, int a_finestLevel, const std::string &a_realm)
	Define the container. This will do a clear-out of all particles.

void	regrid (const Vector< DisjointBoxLayout > &a_grids, const Vector< ProblemDomain > &a_domains, const Vector< Real > &a_dx, const Vector< int > &a_refRat, const Vector< ValidMask > &a_validMask, const Vector< RefCountedPtr< LevelTiles > > &a_levelTiles, int a_base, int a_newFinestLevel)
	Regrid function. a_base is the coarsest grid level which did not change.

void	preRegrid (int a_lmin)
	Cache particles before calling regrid.

void	resetParticleIDs () noexcept
	Compute new particle IDs.

void	copyMaskParticles (const Vector< RefCountedPtr< LevelData< BaseFab< bool > > > > &a_mask) const
	Copy particles to mask particle data holder.

void	copyMaskParticles (int a_level, const LevelData< BaseFab< bool > > &a_mask) const
	Copy particles to masked particle data holder.

void	transferMaskParticles (const Vector< RefCountedPtr< LevelData< BaseFab< bool > > > > &a_mask)
	Copy particles to the mask particle data holder.

void	transferMaskParticles (int a_level, const LevelData< BaseFab< bool > > &a_mask)
	Copy particles to masked particle data holder.

void	sortParticles () noexcept
	Sort particles according to the < operator in the particle.

void	clearParticles ()
	Clear all particles.

void	clearBufferParticles () const
	Clear the buffer particles.

void	clearMaskParticles () const
	Clear the "mask" particles.

void	clearOutcast () noexcept
	Clear outcast particles.

void	clear (AMRParticles< P > &a_particles) const
	Clear particles on input data holder.

bool	isOrganizedByCell () const
	Is cell-sorted or not.

int	getFinestLevel () const
	Get finest AMR level.

std::string	getRealm () const
	Get the realm where this ParticleContainer lives.

AMRParticles< P > &	getParticles ()
	Get all particles on all levels.

const AMRParticles< P > &	getParticles () const
	Get all particles on a level. Const version.

AMRParticles< P > &	getBufferParticles ()
	Get buffer particles on all levels.

const AMRParticles< P > &	getBufferParticles () const
	Get buffer particles on all levels. Const version.

AMRParticles< P > &	getMaskParticles ()
	Get the mask particles.

const AMRParticles< P > &	getMaskParticles () const
	Get the mask particles. Const version.

const Vector< DisjointBoxLayout > &	getGrids () const
	Get the AMR grids.

RealVect	getProbLo () const noexcept
	Get lower-left corner.

Vector< RealVect >	getDx () const noexcept
	Get grid resolutions.

ParticleData< P > &	operator[] (int a_lvl)
	Get particle data on a level.

const ParticleData< P > &	operator[] (int a_level) const
	Get data on a level. Const version.

AMRCellParticles< P > &	getCellParticles ()
	Get all cell particles.

const AMRCellParticles< P > &	getCellParticles () const
	Get cell particles, const version.

LayoutData< BinFab< P > > &	getCellParticles (int a_level)
	Get cell particles.

const LayoutData< BinFab< P > > &	getCellParticles (int a_level) const
	Get cell particles, const version.

BinFab< P > &	getCellParticles (int a_level, const DataIndex &a_dit)
	Get cell particles on a specific level and grid inex.

const BinFab< P > &	getCellParticles (int a_level, const DataIndex &a_dit) const
	Get cell particles, const version.

void	getCellParticles (BinFab< P > &a_cellParticles, int a_lvl, const DataIndex &a_dit) const
	Fill a cell-sorted particle data holder with all the particles in the grid patch.

void	getCellParticlesDestructive (BinFab< P > &a_cellParticles, int a_lvl, const DataIndex &a_dit)
	Fill a cell-sorted particle data holder with all the particles in the grid patch. The original particles are destroyed.

void	organizeParticlesByCell ()
	Sort particles by cell.

void	organizeParticlesByPatch ()
	Sort particles by cell.

void	addParticles (const List< P > &a_particles)
	Add particles to container.

void	addParticlesDestructive (List< P > &a_particles)
	Add particles to container. The input particles are destroyed by this routine.

void	addParticles (const BinFab< P > &a_particles, int a_lvl, const DataIndex &a_dit)
	Add particles to a certain level and patch. The input particles are cell-sorted.

void	addParticlesDestructive (BinFab< P > &a_particles, int a_lvl, const DataIndex &a_dit)
	Add particles to a certain level and patch. The input particles are cell-sorted (and destroyed on output).

void	addParticles (const ParticleContainer< P > &a_otherContainer)
	Add particles from other container to this one.

void	addParticlesDestructive (ParticleContainer< P > &a_otherContainer)
	Add particles from other container to this one. This destroys the particles in the other container.

void	sanityCheck () const noexcept
	Run a sanity check and make sure all particles are in their correctly assigned box.

void	remap ()
	Remap over the entire AMR hierarchy.

void	transferParticles (ParticleContainer< P > &a_otherContainer)
	Move particles into this container.

void	transferParticles (AMRParticles< P > &a_otherContainer)
	Move particles into this container.

void	admitValidParticles (List< P > &a_evictedParticles, ParticleData< P > &a_particles, int a_coarseLevel)
	Evict particles if they move out of the valid region.

template<Real &(P::*)() particleScalarField>
void	setValue (Real a_value)
	Set the particle member to the input value.

template<RealVect &(P::*)() particleVectorField>
void	setValue (const RealVect &a_value)
	Set the particle member to the input value.

unsigned long long	getNumberOfValidParticlesLocal () const
	Get local number of particles.

unsigned long long	getNumberOfValidParticlesGlobal () const
	Get global number of particles.

unsigned long long	getNumberOfOutcastParticlesLocal () const
	Get local number of particles.

unsigned long long	getNumberOfOutcastParticlesGlobal () const
	Get global number of particles.

unsigned long long	getNumberOfMaskParticlesLocal () const
	Get the number particles in the halo cells.

unsigned long long	getNumberOfMaskParticlesGlobal () const
	Get the number particles in the halo cells.

Protected Member Functions
void	setupGrownGrids (int a_base, int a_finestLevel)
	Set up grown grids.

void	setupParticleData (int a_base, int a_finestLevel)
	Setup function for the particle data (m_particles and m_maskParticles)

void	transferParticlesToSingleList (List< P > &a_list, AMRParticles< P > &a_particles) const noexcept
	Gather the particles onto a single list.

void	copyParticlesToSingleList (List< P > &a_list, const AMRParticles< P > &a_particles) const noexcept
	Copy the input particles onto a single list.

void	mapParticlesToAMRGrid (std::vector< ParticleMap< List< P > > > &a_mappedParticles, List< P > &a_unmappedParticles) const noexcept
	Iterate through the unmapped particles and map them to proper level, grid indices, and grid ranks.

void	catenateParticleMaps (std::vector< ParticleMap< List< P > > > &a_globalParticles, std::vector< ParticleMap< List< P > > > &a_localParticles) const noexcept
	Catenate the particles. This is usually called within OpenMP parallel regions.

void	assignLocalParticles (ParticleMap< List< P > > &a_mappedParticles, AMRParticles< P > &a_particleData) const noexcept
	Gather particles locally.

Protected Attributes
std::string	m_realm
	Realm on which the ParticleContainer is defined.

int	m_blockingFactor
	Blocking factor, aka grid size.

int	m_finestLevel
	Finest grid level.

RealVect	m_probLo
	Lower left corner of the physical domain.

bool	m_isDefined = false
	Check if particle container is defined.

bool	m_isOrganizedByCell = false
	Check if particle container is "cell sorted".

bool	m_profile = false
	Profile or not.

bool	m_debug = false
	Debug or not.

bool	m_verbose = false
	Verbose or not.

Vector< RefCountedPtr< LevelTiles > >	m_levelTiles
	Tiled AMR space.

Vector< DisjointBoxLayout >	m_grids
	AMR grids.

Vector< DisjointBoxLayout >	m_oldGrids
	Old AMR grids. Used during regrids.

Vector< ProblemDomain >	m_domains
	Problem domains.

Vector< RefCountedPtr< LevelData< BaseFab< bool > > > >	m_validRegion
	Map of valid cells; evaluates to false if a cell is covered by a finer grid.

Vector< BoxLayout >	m_grownGrids
	Grown layouts.

Vector< RealVect >	m_dx
	Resolutions on each grid level.

Vector< int >	m_refRat
	Refinement ratios. Entry at index 'l' is the refinement between level 'l' and level 'l+1'.

AMRParticles< P >	m_particles
	The actual particles that this ParticleContainer represents.

AMRParticles< P >	m_bufferParticles
	Special data holder that holds particles on a grown grid layout.

AMRParticles< P >	m_maskParticles
	Special data holder that holds copies of particles on the coarse level that are within a specified range of the refinement boundary. Used for deposition of coarse-level particle clouds across refinement boundaries.

AMRParticles< P >	m_cacheParticles
	Particles stored on the old grid.

AMRCellParticles< P >	m_cellSortedParticles
	Cell particles.

Detailed Description

template<class P>
class ParticleContainer

Templated class for holding particles on an AMR hierarchy with particle remapping.

The template parameter P should derive from Chombo's BinItem.

Note: ParticleContainers are, because of Chombo, restricted to square-block grids. This means that the blocking factor and maximum box size must be the same.

Constructor & Destructor Documentation

◆ ParticleContainer()

template<class P >

ParticleContainer< P >::ParticleContainer	(	const Vector< DisjointBoxLayout > &	a_grids,
		const Vector< ProblemDomain > &	a_domains,
		const Vector< Real > &	a_dx,
		const Vector< int > &	a_refRat,
		const Vector< ValidMask > &	a_validMask,
		const Vector< RefCountedPtr< LevelTiles > > &	a_levelTiles,
		const RealVect &	a_probLo,
		int	a_blockingFactor,
		int	a_finestLevel,
		std::string	a_realm
	)

Full constructor.

Parameters

[in]	a_grids	AMR grids
[in]	a_domains	AMR domains
[in]	a_dx	Grid resolutions
[in]	a_refRat	Refinement ratios
[in]	a_validMask	Valid cells (false for cells covered by a finer grid)
[in]	a_levelTiles	Tiled AMR grids
[in]	a_probLo	Lower-left corner of the physical domain
[in]	a_blockingFactor	Grid blocking factor
[in]	a_finestLevel	Finest grid level
[in]	a_realm	Realm where these particles live.

Member Function Documentation

◆ addParticles() [1/3]

template<class P >

void ParticleContainer< P >::addParticles	(	const BinFab< P > &	a_particles,
		int	a_lvl,
		const DataIndex &	a_dit
	)

Add particles to a certain level and patch. The input particles are cell-sorted.

Parameters

[in]	a_particles	Input particles (cell-sorted)
[in]	a_lvl	Grid level
[in]	a_dit	Grid index

◆ addParticles() [2/3]

template<class P >

void ParticleContainer::addParticles ( const List & a_particles )

Add particles to container.

Parameters

[in] a_particles particles to add to this container.

◆ addParticles() [3/3]

template<class P >

void ParticleContainer::addParticles ( const ParticleContainer & a_otherContainer )

Add particles from other container to this one.

Parameters

[in] a_otherContainer Other particle container.

◆ addParticlesDestructive() [1/3]

template<class P >

void ParticleContainer< P >::addParticlesDestructive	(	BinFab< P > &	a_particles,
		int	a_lvl,
		const DataIndex &	a_dit
	)

Add particles to a certain level and patch. The input particles are cell-sorted (and destroyed on output).

Parameters

[in,out]	a_particles	Input particles (cell-sorted). Destroyed on exit.
[in]	a_lvl	Grid level
[in]	a_dit	Grid index

◆ addParticlesDestructive() [2/3]

template<class P >

void ParticleContainer::addParticlesDestructive ( List & a_particles )

Add particles to container. The input particles are destroyed by this routine.

Parameters

[in] a_particles particles to add to this container. .

◆ addParticlesDestructive() [3/3]

template<class P >

void ParticleContainer::addParticlesDestructive ( ParticleContainer & a_otherContainer )

Add particles from other container to this one. This destroys the particles in the other container.

Parameters

[in,out] a_otherContainer Other particle container (destroyed on output).

◆ admitValidParticles()

template<class P >

void ParticleContainer< P >::admitValidParticles	(	List< P > &	a_evictedParticles,
		ParticleData< P > &	a_particles,
		int	a_coarseLevel
	)

Evict particles if they move out of the valid region.

Parameters

[in,out]	a_evictedParticles	List that the particles are moved into.
[in,out]	a_particles	Particles.
[in]	a_coarseLevel	Coarse level

◆ assignLocalParticles()

template<typename P >

void ParticleContainer< P >::assignLocalParticles	(	ParticleMap< List< P > > &	a_mappedParticles,
		AMRParticles< P > &	a_particleData
	)		const

inlineprotectednoexcept

Gather particles locally.

Parameters

[in,out]	a_mappedParticles	Particles that have been mapped to this rank.
[in,out]	a_particleData	Where to assign the mapped particles

◆ catenateParticleMaps()

template<typename P >

void ParticleContainer< P >::catenateParticleMaps	(	std::vector< ParticleMap< List< P > > > &	a_globalParticles,
		std::vector< ParticleMap< List< P > > > &	a_localParticles
	)		const

inlineprotectednoexcept

Catenate the particles. This is usually called within OpenMP parallel regions.

Parameters

[in,out]	a_globalParticles	Global particle map
[in,out]	a_localParticles	Local particle map

◆ clear()

template<class P >

void ParticleContainer::clear ( AMRParticles & a_particles ) const

Clear particles on input data holder.

Parameters

[in,out] a_particles

◆ copyMaskParticles() [1/2]

template<class P >

void ParticleContainer::copyMaskParticles ( const Vector< RefCountedPtr< LevelData< BaseFab< bool > > > > & a_mask ) const

Copy particles to mask particle data holder.

Parameters

[in] a_mask Mask

Note: If the mask is nullptr on any of the levels, those levels will be ignored.

◆ copyMaskParticles() [2/2]

template<class P >

void ParticleContainer< P >::copyMaskParticles	(	int	a_level,
		const LevelData< BaseFab< bool > > &	a_mask
	)		const

Copy particles to masked particle data holder.

Parameters

[in]	a_level	Grid level
[in]	a_mask	Mask

◆ copyParticlesToSingleList()

template<typename P >

void ParticleContainer< P >::copyParticlesToSingleList	(	List< P > &	a_list,
		const AMRParticles< P > &	a_particles
	)		const

inlineprotectednoexcept

Copy the input particles onto a single list.

Parameters

[in,out]	a_list	List containing all the particles in a_particles
[in,out]	a_particles	Particles to transfer to list

Note: This is supposed to get inside an OpenMP parallel region.

◆ define()

template<class P >

void ParticleContainer< P >::define	(	const Vector< DisjointBoxLayout > &	a_grids,
		const Vector< ProblemDomain > &	a_domains,
		const Vector< Real > &	a_dx,
		const Vector< int > &	a_refRat,
		const Vector< ValidMask > &	a_validMask,
		const Vector< RefCountedPtr< LevelTiles > > &	a_levelTiles,
		const RealVect &	a_probLo,
		int	a_blockingFactor,
		int	a_finestLevel,
		const std::string &	a_realm
	)

Define the container. This will do a clear-out of all particles.

Parameters

[in]	a_grids	AMR grids
[in]	a_domains	AMR domains
[in]	a_dx	Grid resolutions
[in]	a_refRat	Refinement ratios
[in]	a_validMask	Valid cells (false for cells covered by a finer grid)
[in]	a_levelTiles	Tiled AMR grids
[in]	a_probLo	Lower-left corner of the physical domain
[in]	a_blockingFactor	Grid blocking factor
[in]	a_finestLevel	Finest grid level
[in]	a_realm	Realm where these particles live.

◆ getBufferParticles() [1/2]

template<class P >

AMRParticles & ParticleContainer::getBufferParticles ( )

Get buffer particles on all levels.

Returns: m_bufferParticles

◆ getBufferParticles() [2/2]

template<class P >

const AMRParticles & ParticleContainer::getBufferParticles ( ) const

Get buffer particles on all levels. Const version.

Returns: m_bufferParticles

◆ getCellParticles() [1/7]

template<class P >

AMRCellParticles & ParticleContainer::getCellParticles ( )

Get all cell particles.

Note: This will issue an error if the particles are not sorted by cell.

Returns: Cell particles

◆ getCellParticles() [2/7]

template<class P >

const AMRCellParticles & ParticleContainer::getCellParticles ( ) const

Get cell particles, const version.

Note: This will issue an error if the particles are not sorted by cell.

Returns: Cell particles

◆ getCellParticles() [3/7]

template<class P >

void ParticleContainer< P >::getCellParticles	(	BinFab< P > &	a_cellParticles,
		int	a_lvl,
		const DataIndex &	a_dit
	)		const

Fill a cell-sorted particle data holder with all the particles in the grid patch.

Parameters

[out]	a_cellParticles	Particles in the input grid patch, sorted by cell.
[in]	a_dit	Grid index

Note: This will define a_cellParticles over the DisjointBoxLayout grid box and fill it with the particles in the patch.

Parameters

[in] a_lvl Lvl

◆ getCellParticles() [4/7]

template<class P >

LayoutData< BinFab > & ParticleContainer::getCellParticles ( int a_level )

Get cell particles.

Parameters

[in] a_level Grid level

Note: This will issue an error if the particles are not sorted by cell.

Returns: Cell particles

◆ getCellParticles() [5/7]

template<class P >

const LayoutData< BinFab > & ParticleContainer::getCellParticles ( int a_level ) const

Get cell particles, const version.

Parameters

[in] a_level Grid level

Note: This will issue an error if the particles are not sorted by cell.

Returns: Cell particles

◆ getCellParticles() [6/7]

template<class P >

BinFab< P > & ParticleContainer< P >::getCellParticles	(	int	a_level,
		const DataIndex &	a_dit
	)

Get cell particles on a specific level and grid inex.

Parameters

[in]	a_level	Grid level
[in]	a_dit	Grid index

Note: This will issue an error if the particles are not sorted by cell.

Returns: Cell particles

◆ getCellParticles() [7/7]

template<class P >

const BinFab< P > & ParticleContainer< P >::getCellParticles	(	int	a_level,
		const DataIndex &	a_dit
	)		const

Get cell particles, const version.

Parameters

[in]	a_level	Grid level
[in]	a_dit	Grid index

Note: This will issue an error if the particles are not sorted by cell.

Returns: Cell particles

◆ getCellParticlesDestructive()

template<class P >

void ParticleContainer< P >::getCellParticlesDestructive	(	BinFab< P > &	a_cellParticles,
		int	a_lvl,
		const DataIndex &	a_dit
	)

Fill a cell-sorted particle data holder with all the particles in the grid patch. The original particles are destroyed.

Parameters

[out]	a_cellParticles	Particles in the input grid patch, sorted by cell.
[in]	a_dit	Grid index

Note: This will define a_cellParticles over the DisjointBoxLayout grid box and fill it with the particles in the patch.

Parameters

[in] a_lvl Lvl

◆ getDx()

template<class P >

Vector< RealVect > ParticleContainer::getDx ( ) const

noexcept

Get grid resolutions.

Returns: m_dx

◆ getFinestLevel()

template<class P >

int ParticleContainer::getFinestLevel ( ) const

Get finest AMR level.

Returns: Finest level

◆ getGrids()

template<class P >

const Vector< DisjointBoxLayout > & ParticleContainer::getGrids ( ) const

Get the AMR grids.

Returns: Grids

◆ getMaskParticles() [1/2]

template<class P >

AMRParticles & ParticleContainer::getMaskParticles ( )

Get the mask particles.

Returns: m_maskParticles

◆ getMaskParticles() [2/2]

template<class P >

const AMRParticles & ParticleContainer::getMaskParticles ( ) const

Get the mask particles. Const version.

Returns: m_maskParticles

◆ getNumberOfMaskParticlesGlobal()

template<class P >

unsigned long long ParticleContainer::getNumberOfMaskParticlesGlobal ( ) const

Get the number particles in the halo cells.

Returns: Number of mask particles global

◆ getNumberOfMaskParticlesLocal()

template<class P >

unsigned long long ParticleContainer::getNumberOfMaskParticlesLocal ( ) const

Get the number particles in the halo cells.

Returns: Number of mask particles local

◆ getNumberOfOutcastParticlesGlobal()

template<class P >

unsigned long long ParticleContainer::getNumberOfOutcastParticlesGlobal ( ) const

Get global number of particles.

Returns: Number of outcast particles global

◆ getNumberOfOutcastParticlesLocal()

template<class P >

unsigned long long ParticleContainer::getNumberOfOutcastParticlesLocal ( ) const

Get local number of particles.

Returns: Number of outcast particles local

◆ getNumberOfValidParticlesGlobal()

template<class P >

unsigned long long ParticleContainer::getNumberOfValidParticlesGlobal ( ) const

Get global number of particles.

Returns: Number of valid particles global

◆ getNumberOfValidParticlesLocal()

template<class P >

unsigned long long ParticleContainer::getNumberOfValidParticlesLocal ( ) const

Get local number of particles.

Returns: Number of valid particles local

◆ getParticles() [1/2]

template<class P >

AMRParticles & ParticleContainer::getParticles ( )

Get all particles on all levels.

Returns: m_particles

◆ getParticles() [2/2]

template<class P >

const AMRParticles & ParticleContainer::getParticles ( ) const

Get all particles on a level. Const version.

Returns: m_particles

◆ getProbLo()

template<class P >

RealVect ParticleContainer::getProbLo ( ) const

noexcept

Get lower-left corner.

Returns: m_probLo

◆ getRealm()

template<class P >

std::string ParticleContainer::getRealm ( ) const

Get the realm where this ParticleContainer lives.

Returns: Realm

◆ isOrganizedByCell()

template<class P >

bool ParticleContainer::isOrganizedByCell ( ) const

Is cell-sorted or not.

Returns: True if organized by cell, false otherwise

◆ mapParticlesToAMRGrid()

template<typename P >

void ParticleContainer< P >::mapParticlesToAMRGrid	(	std::vector< ParticleMap< List< P > > > &	a_mappedParticles,
		List< P > &	a_unmappedParticles
	)		const

inlineprotectednoexcept

Iterate through the unmapped particles and map them to proper level, grid indices, and grid ranks.

Parameters

[in,out]	a_mappedParticles	Particles mapped according to rank ownership (vector index) and grid level and index (std::pair)
[in,out]	a_unmappedParticles	Particles that are not mapped (yet)

◆ operator=()

template<class P >

ParticleContainer & ParticleContainer::operator= ( ParticleContainer && )

default

Move assignment operator.

Returns: Reference to this.

◆ operator[]() [1/2]

template<class P >

const ParticleData & ParticleContainer::operator[] ( int a_level ) const

Get data on a level. Const version.

Parameters

[in] a_level AMR level

Returns: Return value

◆ operator[]() [2/2]

template<class P >

ParticleData & ParticleContainer::operator[] ( int a_lvl )

Get particle data on a level.

Parameters

[in] a_lvl AMR level

Returns: Return value

◆ organizeParticlesByCell()

template<class P >

void ParticleContainer::organizeParticlesByCell ( )

Sort particles by cell.

This will fill m_cellSortedParticles and destroy the patch-sorted particles.

◆ organizeParticlesByPatch()

template<class P >

void ParticleContainer::organizeParticlesByPatch ( )

Sort particles by cell.

This will fill m_particles from m_cellSortedParticles and destroy the cell-sorted particles.

◆ preRegrid()

template<class P >

void ParticleContainer::preRegrid ( int a_lmin )

Cache particles before calling regrid.

Parameters

[in] a_lmin Coarsest grid level which will not change.

◆ regrid()

template<class P >

void ParticleContainer< P >::regrid	(	const Vector< DisjointBoxLayout > &	a_grids,
		const Vector< ProblemDomain > &	a_domains,
		const Vector< Real > &	a_dx,
		const Vector< int > &	a_refRat,
		const Vector< ValidMask > &	a_validMask,
		const Vector< RefCountedPtr< LevelTiles > > &	a_levelTiles,
		int	a_base,
		int	a_newFinestLevel
	)

Regrid function. a_base is the coarsest grid level which did not change.

Parameters

[in]	a_grids	AMR grids
[in]	a_domains	AMR domains
[in]	a_dx	Grid resolutions
[in]	a_refRat	Refinement ratios
[in]	a_validMask	Valid cells
[in]	a_levelTiles	Tiled AMR grids
[in]	a_base	Coarsest grid level that did not change.
[in]	a_newFinestLevel	New finest grid level

◆ setupGrownGrids()

template<class P >

void ParticleContainer< P >::setupGrownGrids	(	int	a_base,
		int	a_finestLevel
	)

protected

Set up grown grids.

Parameters

[in]	a_base	Base level
[in]	a_finestLevel	Finest AMR level

◆ setupParticleData()

template<class P >

void ParticleContainer< P >::setupParticleData	(	int	a_base,
		int	a_finestLevel
	)

protected

Setup function for the particle data (m_particles and m_maskParticles)

Parameters

[in]	a_base	Base level
[in]	a_finestLevel	Finest AMR level

◆ setValue() [1/2]

template<class P >

template<RealVect &(P::*)() particleVectorField>

void ParticleContainer::setValue ( const RealVect & a_value )

inline

Set the particle member to the input value.

This is a jack-of-all-trades kind of routine for setting a particle field. The template parameter indicates the field to be set, it must be a pointer-to-member-function that returns the field to be set. For example, if the particle class P has a field vector which one wants to set, and this field is returned by a function RealVect& P::velocity(), one can set the quantity for all particles by calling ParticleContainer::setValue<&P::velocity>(RealVect);

Parameters

[in] a_value Value

◆ setValue() [2/2]

template<class P >

template<Real &(P::*)() particleScalarField>

void ParticleContainer::setValue ( Real a_value )

inline

Set the particle member to the input value.

This is a jack-of-all-trades kind of routine for setting a particle field. The template parameter indicates the field to be set, it must be a pointer-to-member-function that returns the field to be set. For example, if the particle class P has a field mass which one wants to set, and this field is returned by a function Real& P::mass(), one can set the quantity for all particles by calling ParticleContainer::setValue<&P::mass>(Real)

Parameters

[in] a_value Value

◆ transferMaskParticles() [1/2]

template<class P >

void ParticleContainer::transferMaskParticles ( const Vector< RefCountedPtr< LevelData< BaseFab< bool > > > > & a_mask )

Copy particles to the mask particle data holder.

Parameters

[in] a_mask Mask

Note: If the mask is nullptr on any of the levels, those levels will be ignored.

◆ transferMaskParticles() [2/2]

template<class P >

void ParticleContainer< P >::transferMaskParticles	(	int	a_level,
		const LevelData< BaseFab< bool > > &	a_mask
	)

Copy particles to masked particle data holder.

Parameters

[in]	a_level	Grid level
[in]	a_mask	Mask

◆ transferParticles() [1/2]

template<class P >

void ParticleContainer::transferParticles ( AMRParticles & a_otherContainer )

Move particles into this container.

Parameters

[in,out] a_otherContainer Other particle container.

Note: The grids MUST be the same for both containers. That is, the containers MUST be defined over the same realm.

◆ transferParticles() [2/2]

template<class P >

void ParticleContainer::transferParticles ( ParticleContainer & a_otherContainer )

Move particles into this container.

Parameters

[in,out] a_otherContainer Other particle container.

Note: The grids MUST be the same for both containers. That is, the containers MUST be defined over the same realm.

◆ transferParticlesToSingleList()

template<typename P >

void ParticleContainer< P >::transferParticlesToSingleList	(	List< P > &	a_list,
		AMRParticles< P > &	a_particles
	)		const

inlineprotectednoexcept

Gather the particles onto a single list.

Parameters

[in,out]	a_list	List containing all the particles in a_particles
[in,out]	a_particles	Particles to transfer to list

Note: This is supposed to get inside an OpenMP parallel region.

Member Data Documentation

◆ m_bufferParticles

template<class P >

AMRParticles ParticleContainer::m_bufferParticles

mutableprotected

Special data holder that holds particles on a grown grid layout.

This particle data holder uses grids that exceed the DisjointBoxLayout on each level (boxes are grown by m_refRat). This means that this particle data holder can store particles that are out the DisjointBoxLayout by m_refRat cells. This is very useful when one wants to deposit particles on the fine level, but where the particles live on the coarse level. In such cases one will typically copy some (or all) particles from the coarse level to this data holder and deposit from this data holder onto the fine level.

◆ m_cacheParticles

template<class P >

AMRParticles ParticleContainer::m_cacheParticles

protected

Particles stored on the old grid.

Populated during the preRegrid call.

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

Source/Particle/CD_ParticleContainer.H
Source/Particle/CD_ParticleContainerImplem.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParticleContainer()

Member Function Documentation

◆ addParticles() [1/3]

◆ addParticles() [2/3]

◆ addParticles() [3/3]

◆ addParticlesDestructive() [1/3]

◆ addParticlesDestructive() [2/3]

◆ addParticlesDestructive() [3/3]

◆ admitValidParticles()

◆ assignLocalParticles()

◆ catenateParticleMaps()

◆ clear()

◆ copyMaskParticles() [1/2]

◆ copyMaskParticles() [2/2]

◆ copyParticlesToSingleList()

◆ define()

◆ getBufferParticles() [1/2]

◆ getBufferParticles() [2/2]

◆ getCellParticles() [1/7]

◆ getCellParticles() [2/7]

◆ getCellParticles() [3/7]

◆ getCellParticles() [4/7]

◆ getCellParticles() [5/7]

◆ getCellParticles() [6/7]

◆ getCellParticles() [7/7]

◆ getCellParticlesDestructive()

◆ getDx()

◆ getFinestLevel()

◆ getGrids()

◆ getMaskParticles() [1/2]

◆ getMaskParticles() [2/2]

◆ getNumberOfMaskParticlesGlobal()

◆ getNumberOfMaskParticlesLocal()

◆ getNumberOfOutcastParticlesGlobal()

◆ getNumberOfOutcastParticlesLocal()

◆ getNumberOfValidParticlesGlobal()

◆ getNumberOfValidParticlesLocal()

◆ getParticles() [1/2]

◆ getParticles() [2/2]

◆ getProbLo()

◆ getRealm()

◆ isOrganizedByCell()

◆ mapParticlesToAMRGrid()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ organizeParticlesByCell()

◆ organizeParticlesByPatch()

◆ preRegrid()

◆ regrid()

◆ setupGrownGrids()

◆ setupParticleData()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ transferMaskParticles() [1/2]

◆ transferMaskParticles() [2/2]

◆ transferParticles() [1/2]

◆ transferParticles() [2/2]

◆ transferParticlesToSingleList()

Member Data Documentation

◆ m_bufferParticles

◆ m_cacheParticles