#include <AMReX_ParIter.H>

Inheritance diagram for amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >:

Public Types
using	ContainerType = ParticleContainer< NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >

using	ParticleTileType = typename ContainerType::ParticleTileType

using	AoS = typename ContainerType::AoS

using	SoA = typename ContainerType::SoA

using	ParticleType = typename ContainerType::ParticleType

using	RealVector = typename SoA::RealVector

using	IntVector = typename SoA::IntVector

using	ParticleVector = typename ContainerType::ParticleVector

Public Types inherited from amrex::MFIter
enum	Flags { Tiling = 0x01 , AllBoxes = 0x02 , NoTeamBarrier = 0x04 }
	Flags that specify tiling modes. All these flags are off by default. More...

Public Member Functions
	ParIterBase (ContainerRef pc, int level)

	ParIterBase (ContainerRef pc, int level, MFItInfo &info)

void	operator++ ()

ParticleTileRef	GetParticleTile () const

AoSRef	GetArrayOfStructs () const

SoARef	GetStructOfArrays () const

int	numParticles () const

int	numRealParticles () const

int	numNeighborParticles () const

int	GetLevel () const

std::pair< int, int >	GetPairIndex () const

const Geometry &	Geom (int lev) const

Public Member Functions inherited from amrex::MFIter
	MFIter (const FabArrayBase &fabarray, unsigned char flags_=0)
	The default constructor does not enable tiling (flags_ is set to 0 by default). However, the tiling mode can be enabled by explicitly turning the tiling flag on (i.e. flags_ = Tiling). The tile size in this case is defined by FabArrayBase::mfiter_tile_size. More...

	MFIter (const FabArrayBase &fabarray, bool do_tiling)
	Enable tiling with the default tile size, which is defined by FabArrayBase::mfiter_tile_size. More...

	MFIter (const FabArrayBase &fabarray, const IntVect &tilesize, unsigned char flags_=0)
	Enable tiling with explicit tile size and flags (See type Flags for more information) More...

	MFIter (const BoxArray &ba, const DistributionMapping &dm, unsigned char flags_=0)

	MFIter (const BoxArray &ba, const DistributionMapping &dm, bool do_tiling)

	MFIter (const BoxArray &ba, const DistributionMapping &dm, const IntVect &tilesize, unsigned char flags_=0)

	MFIter (const FabArrayBase &fabarray, const MFItInfo &info)

	MFIter (const BoxArray &ba, const DistributionMapping &dm, const MFItInfo &info)

	MFIter (MFIter &&rhs)=default

	MFIter (MFIter const &)=delete

MFIter &	operator= (MFIter const &)=delete

MFIter &	operator= (MFIter &&)=delete

	~MFIter ()

Box	tilebox () const noexcept
	Return the tile Box at the current index. More...

Box	tilebox (const IntVect &nodal) const noexcept
	Return the tilebox with provided nodal flag. More...

Box	tilebox (const IntVect &nodal, const IntVect &ngrow) const noexcept
	Return the tilebox with provided nodal flag and grown cells. More...

Box	nodaltilebox (int dir=-1) const noexcept
	Return the dir-nodal (or all nodal if dir<0) Box at the current index. More...

Box	growntilebox (int ng=-1000000) const noexcept
	Return the tile box at the current index grown to include ghost cells. More...

Box	growntilebox (const IntVect &ng) const noexcept

Box	grownnodaltilebox (int dir=-1, int ng=-1000000) const noexcept
	Return the dir-nodal (or all nodal if dir<0) box grown to include ghost cells. More...

Box	grownnodaltilebox (int dir, const IntVect &ng) const noexcept

Box	validbox () const noexcept
	Return the valid Box in which the current tile resides. More...

Box	fabbox () const noexcept
	Return the Box of the FAB at which we currently point. More...

void	operator++ () noexcept
	Increment iterator to the next tile we own. More...

bool	isValid () const noexcept
	Is the iterator valid i.e. is it associated with a FAB? More...

int	index () const noexcept
	The index into the underlying BoxArray of the current FAB. More...

int	length () const noexcept
	The number of indices. More...

int	LocalTileIndex () const noexcept
	The current local tile index in the current grid;. More...

int	numLocalTiles () const noexcept
	The the number of tiles in the current grid;. More...

int	LocalIndex () const noexcept
	Return local index into the vector of fab pointers, m_fabs_v When AllBoxes is on, local_index_map is a nullptr and local index is current index. More...

const FabArrayBase &	theFabArrayBase () const noexcept
	Constant reference to FabArray over which we're iterating. More...

int	tileIndex () const noexcept

const DistributionMapping &	DistributionMap () const noexcept

void	Finalize ()

Protected Attributes
int	m_level

int	m_pariter_index

Vector< int >	m_valid_index

Vector< ParticleTilePtr >	m_particle_tiles

ContainerRef	m_pc

Protected Attributes inherited from amrex::MFIter
std::unique_ptr< FabArrayBase >	m_fa
	This must be the first member! More...

const FabArrayBase &	fabArray

IntVect	tile_size

unsigned char	flags

int	currentIndex

int	beginIndex

int	endIndex

int	streams

IndexType	typ

bool	dynamic

bool	finalized = false

DeviceSync	device_sync

const Vector< int > *	index_map

const Vector< int > *	local_index_map

const Vector< Box > *	tile_array

const Vector< int > *	local_tile_index_map

const Vector< int > *	num_local_tiles

Private Types
using	PCType = ParticleContainer< NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >

using	ContainerRef = typename std::conditional< is_const, PCType const &, PCType & >::type

using	ParticleTileRef = typename std::conditional< is_const, typename PCType::ParticleTileType const &, typename PCType::ParticleTileType & >::type

using	ParticleTilePtr = typename std::conditional< is_const, typename PCType::ParticleTileType const , typename PCType::ParticleTileType >::type

using	AoSRef = typename std::conditional< is_const, typename PCType::AoS const &, typename PCType::AoS & >::type

using	SoARef = typename std::conditional< is_const, typename PCType::SoA const &, typename PCType::SoA & >::type

Additional Inherited Members
Static Public Member Functions inherited from amrex::MFIter
static int	allowMultipleMFIters (int allow)

Protected Member Functions inherited from amrex::MFIter
void	Initialize ()

Static Protected Attributes inherited from amrex::MFIter
static AMREX_EXPORT int	nextDynamicIndex = std::numeric_limits<int>::min()

static AMREX_EXPORT int	depth = 0

static AMREX_EXPORT int	allow_multiple_mfiters = 0

Member Typedef Documentation

◆ AoS

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::AoS = typename ContainerType::AoS

◆ AoSRef

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::AoSRef = typename std::conditional <is_const, typename PCType::AoS const&, typename PCType::AoS&>::type

private

◆ ContainerRef

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ContainerRef = typename std::conditional<is_const, PCType const&, PCType&>::type

private

◆ ContainerType

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ContainerType = ParticleContainer<NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator>

◆ IntVector

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::IntVector = typename SoA::IntVector

◆ ParticleTilePtr

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParticleTilePtr = typename std::conditional <is_const, typename PCType::ParticleTileType const*, typename PCType::ParticleTileType *>::type

private

◆ ParticleTileRef

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParticleTileRef = typename std::conditional <is_const, typename PCType::ParticleTileType const&, typename PCType::ParticleTileType &>::type

private

◆ ParticleTileType

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParticleTileType = typename ContainerType::ParticleTileType

◆ ParticleType

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParticleType = typename ContainerType::ParticleType

◆ ParticleVector

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParticleVector = typename ContainerType::ParticleVector

◆ PCType

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::PCType = ParticleContainer<NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator>

private

◆ RealVector

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::RealVector = typename SoA::RealVector

◆ SoA

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::SoA = typename ContainerType::SoA

◆ SoARef

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

using amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::SoARef = typename std::conditional <is_const, typename PCType::SoA const&, typename PCType::SoA&>::type

private

Constructor & Destructor Documentation

◆ ParIterBase() [1/2]

template<bool is_const, int NStructReal, int NStructInt, int NArrayReal, int NArrayInt, template< class > class Allocator>

amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParIterBase	(	ContainerRef	pc,
		int	level
	)

◆ ParIterBase() [2/2]

template<bool is_const, int NStructReal, int NStructInt, int NArrayReal, int NArrayInt, template< class > class Allocator>

amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::ParIterBase	(	ContainerRef	pc,
		int	level,
		MFItInfo &	info
	)

Member Function Documentation

◆ Geom()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

const Geometry& amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::Geom ( int lev ) const

inline

◆ GetArrayOfStructs()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

AoSRef amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::GetArrayOfStructs ( ) const

inline

◆ GetLevel()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

int amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::GetLevel ( ) const

inline

◆ GetPairIndex()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

std::pair<int, int> amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::GetPairIndex ( ) const

inline

◆ GetParticleTile()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

ParticleTileRef amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::GetParticleTile ( ) const

inline

◆ GetStructOfArrays()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

SoARef amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::GetStructOfArrays ( ) const

inline

◆ numNeighborParticles()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

int amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::numNeighborParticles ( ) const

inline

◆ numParticles()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

int amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::numParticles ( ) const

inline

◆ numRealParticles()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

int amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::numRealParticles ( ) const

inline

◆ operator++()

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

void amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::operator++ ( )

inline

Member Data Documentation

◆ m_level

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

int amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::m_level

protected

◆ m_pariter_index

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

int amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::m_pariter_index

protected

◆ m_particle_tiles

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

Vector<ParticleTilePtr> amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::m_particle_tiles

protected

◆ m_pc

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

ContainerRef amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::m_pc

protected

◆ m_valid_index

template<bool is_const, int NStructReal, int NStructInt = 0, int NArrayReal = 0, int NArrayInt = 0, template< class > class Allocator = DefaultAllocator>

Vector<int> amrex::ParIterBase< is_const, NStructReal, NStructInt, NArrayReal, NArrayInt, Allocator >::m_valid_index

protected

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

/home/runner/work/amrex/amrex/Src/Particle/AMReX_ParIter.H

Public Types

Public Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Member Typedef Documentation

◆ AoS

◆ AoSRef

◆ ContainerRef

◆ ContainerType

◆ IntVector

◆ ParticleTilePtr

◆ ParticleTileRef

◆ ParticleTileType

◆ ParticleType

◆ ParticleVector

◆ PCType

◆ RealVector

◆ SoA

◆ SoARef

Constructor & Destructor Documentation

◆ ParIterBase() [1/2]

◆ ParIterBase() [2/2]

Member Function Documentation

◆ Geom()

◆ GetArrayOfStructs()

◆ GetLevel()

◆ GetPairIndex()

◆ GetParticleTile()

◆ GetStructOfArrays()

◆ numNeighborParticles()

◆ numParticles()

◆ numRealParticles()

◆ operator++()

Member Data Documentation

◆ m_level

◆ m_pariter_index

◆ m_particle_tiles

◆ m_pc

◆ m_valid_index