Iterator for looping ever tiles and boxes of amrex::FabArray based containers. More...

#include <AMReX_MFIter.H>

Inheritance diagram for amrex::MFIter:

Classes
struct	DeviceSync

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

Public Member Functions
	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.
	MFIter (const FabArrayBase &fabarray, bool do_tiling)
	Enable tiling with the default tile size, which is defined by FabArrayBase::mfiter_tile_size.
	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).
	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.
Box	tilebox (const IntVect &nodal) const noexcept
	Return the tilebox with provided nodal flag.
Box	tilebox (const IntVect &nodal, const IntVect &ngrow) const noexcept
	Return the tilebox with provided nodal flag and grown cells.
Box	nodaltilebox (int dir=-1) const noexcept
	Return the dir-nodal (or all nodal if dir<0) tile Box at the current index. The Box is cell-centered in the other directions regardless of the FabArray's index type, like grownnodaltilebox.
Box	growntilebox (int ng=-1000000) const noexcept
	Return the tile box at the current index grown to include ghost cells.
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.
Box	grownnodaltilebox (int dir, const IntVect &ng) const noexcept
Box	validbox () const noexcept
	Return the valid Box in which the current tile resides.
Box	fabbox () const noexcept
	Return the Box of the FAB at which we currently point.
void	operator++ () noexcept
	Increment iterator to the next tile we own.
bool	isValid () const noexcept
	Is the iterator valid i.e. is it associated with a FAB?
int	index () const noexcept
	The index into the underlying BoxArray of the current FAB.
int	length () const noexcept
	The number of indices.
int	LocalTileIndex () const noexcept
	The current local tile index in the current grid;.
int	numLocalTiles () const noexcept
	The the number of tiles in the current grid;.
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.
const FabArrayBase &	theFabArrayBase () const noexcept
	Constant reference to FabArray over which we're iterating.
int	tileIndex () const noexcept
const DistributionMapping &	DistributionMap () const noexcept
void	Finalize ()

Static Public Member Functions
static int	allowMultipleMFIters (int allow)
static int	currentDepth ()

Protected Member Functions
void	Initialize ()

Protected Attributes
std::unique_ptr< FabArrayBase >	m_fa
	This must be the first member!
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
DeviceSync	device_sync_pre {true}
DeviceSync	device_sync_post {true}
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

Static Protected Attributes
static int	nextDynamicIndex = std::numeric_limits<int>::min()
static int	depth = 0
static int	allow_multiple_mfiters = 0

Detailed Description

Iterator for looping ever tiles and boxes of amrex::FabArray based containers.

Member Enumeration Documentation

◆ Flags

enum amrex::MFIter::Flags

Flags that specify tiling modes. All these flags are off by default.

Enumerator
Tiling	Tiling: Enabling the tiling mode.
AllBoxes	AllBoxes: If on, all threads/workers loop over all boxes without tiling. This essentially loops over indexMap. Note that many functions won't work with this.
NoTeamBarrier	NoTeamBarrier: This option is for Team only. If on, there is no barrier in MFIter dtor.

Constructor & Destructor Documentation

◆ MFIter() [1/10]

amrex::MFIter::MFIter	(	const FabArrayBase &	fabarray,
		unsigned char	flags_ = 0 )

explicit

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.

◆ MFIter() [2/10]

amrex::MFIter::MFIter	(	const FabArrayBase &	fabarray,
		bool	do_tiling )

Enable tiling with the default tile size, which is defined by FabArrayBase::mfiter_tile_size.

◆ MFIter() [3/10]

amrex::MFIter::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).

◆ MFIter() [4/10]

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

◆ MFIter() [5/10]

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

◆ MFIter() [6/10]

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

◆ MFIter() [7/10]

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

◆ MFIter() [8/10]

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

◆ MFIter() [9/10]

amrex::MFIter::MFIter ( MFIter && rhs )

default

◆ MFIter() [10/10]

amrex::MFIter::MFIter ( MFIter const & )

delete

◆ ~MFIter()

amrex::MFIter::~MFIter ( )

Member Function Documentation

◆ allowMultipleMFIters()

int amrex::MFIter::allowMultipleMFIters ( int allow )

static

◆ currentDepth()

int amrex::MFIter::currentDepth ( )

static

◆ DistributionMap()

const DistributionMapping & amrex::MFIter::DistributionMap ( ) const

inlinenodiscardnoexcept

◆ fabbox()

Box amrex::MFIter::fabbox ( ) const

inlinenodiscardnoexcept

Return the Box of the FAB at which we currently point.

◆ Finalize()

void amrex::MFIter::Finalize ( )

◆ grownnodaltilebox() [1/2]

Box amrex::MFIter::grownnodaltilebox	(	int	dir,
		const IntVect &	ng ) const

nodiscardnoexcept

◆ grownnodaltilebox() [2/2]

Box amrex::MFIter::grownnodaltilebox	(	int	dir = -1,
		int	ng = -1000000 ) const

nodiscardnoexcept

Return the dir-nodal (or all nodal if dir<0) box grown to include ghost cells.

◆ growntilebox() [1/2]

Box amrex::MFIter::growntilebox ( const IntVect & ng ) const

nodiscardnoexcept

◆ growntilebox() [2/2]

Box amrex::MFIter::growntilebox ( int ng = -1000000 ) const

nodiscardnoexcept

Return the tile box at the current index grown to include ghost cells.

◆ index()

int amrex::MFIter::index ( ) const

inlinenodiscardnoexcept

The index into the underlying BoxArray of the current FAB.

◆ Initialize()

void amrex::MFIter::Initialize ( )

protected

◆ isValid()

bool amrex::MFIter::isValid ( ) const

inlinenodiscardnoexcept

Is the iterator valid i.e. is it associated with a FAB?

◆ length()

int amrex::MFIter::length ( ) const

inlinenodiscardnoexcept

The number of indices.

◆ LocalIndex()

int amrex::MFIter::LocalIndex ( ) const

inlinenodiscardnoexcept

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.

◆ LocalTileIndex()

int amrex::MFIter::LocalTileIndex ( ) const

inlinenodiscardnoexcept

The current local tile index in the current grid;.

◆ nodaltilebox()

Box amrex::MFIter::nodaltilebox ( int dir = -1 ) const

nodiscardnoexcept

Return the dir-nodal (or all nodal if dir<0) tile Box at the current index. The Box is cell-centered in the other directions regardless of the FabArray's index type, like grownnodaltilebox.

◆ numLocalTiles()

int amrex::MFIter::numLocalTiles ( ) const

inlinenodiscardnoexcept

The the number of tiles in the current grid;.

◆ operator++()

void amrex::MFIter::operator++ ( )

noexcept

Increment iterator to the next tile we own.

◆ operator=() [1/2]

MFIter & amrex::MFIter::operator= ( MFIter && )

delete

◆ operator=() [2/2]

MFIter & amrex::MFIter::operator= ( MFIter const & )

delete

◆ theFabArrayBase()

const FabArrayBase & amrex::MFIter::theFabArrayBase ( ) const

inlinenodiscardnoexcept

Constant reference to FabArray over which we're iterating.

◆ tilebox() [1/3]

Box amrex::MFIter::tilebox ( ) const

nodiscardnoexcept

Return the tile Box at the current index.

◆ tilebox() [2/3]

Box amrex::MFIter::tilebox ( const IntVect & nodal ) const

nodiscardnoexcept

Return the tilebox with provided nodal flag.

◆ tilebox() [3/3]

Box amrex::MFIter::tilebox	(	const IntVect &	nodal,
		const IntVect &	ngrow ) const

nodiscardnoexcept

Return the tilebox with provided nodal flag and grown cells.

◆ tileIndex()

int amrex::MFIter::tileIndex ( ) const

inlinenodiscardnoexcept

◆ validbox()

Box amrex::MFIter::validbox ( ) const

inlinenodiscardnoexcept

Return the valid Box in which the current tile resides.

Member Data Documentation

◆ allow_multiple_mfiters

int amrex::MFIter::allow_multiple_mfiters = 0

staticprotected

◆ beginIndex

int amrex::MFIter::beginIndex

protected

◆ currentIndex

int amrex::MFIter::currentIndex

protected

◆ depth

int amrex::MFIter::depth = 0

staticprotected

◆ device_sync

DeviceSync amrex::MFIter::device_sync

protected

◆ device_sync_post

DeviceSync amrex::MFIter::device_sync_post {true}

protected

◆ device_sync_pre

DeviceSync amrex::MFIter::device_sync_pre {true}

protected

◆ dynamic

bool amrex::MFIter::dynamic

protected

◆ endIndex

int amrex::MFIter::endIndex

protected

◆ fabArray

const FabArrayBase* amrex::MFIter::fabArray

protected

◆ finalized

bool amrex::MFIter::finalized = false

protected

◆ flags

unsigned char amrex::MFIter::flags

protected

◆ index_map

const Vector<int>* amrex::MFIter::index_map

protected

◆ local_index_map

const Vector<int>* amrex::MFIter::local_index_map

protected

◆ local_tile_index_map

const Vector<int>* amrex::MFIter::local_tile_index_map

protected

◆ m_fa

std::unique_ptr<FabArrayBase> amrex::MFIter::m_fa

protected

This must be the first member!

◆ nextDynamicIndex

int amrex::MFIter::nextDynamicIndex = std::numeric_limits<int>::min()

staticprotected

◆ num_local_tiles

const Vector<int>* amrex::MFIter::num_local_tiles

protected

◆ streams

int amrex::MFIter::streams

protected

◆ tile_array

const Vector<Box>* amrex::MFIter::tile_array

protected

◆ tile_size

IntVect amrex::MFIter::tile_size

protected

◆ typ

IndexType amrex::MFIter::typ

protected

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

/home/runner/work/amrex/amrex/Src/Base/AMReX_MFIter.H
/home/runner/work/amrex/amrex/Src/Base/AMReX_MFIter.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ MFIter() [1/10]

◆ MFIter() [2/10]

◆ MFIter() [3/10]

◆ MFIter() [4/10]

◆ MFIter() [5/10]

◆ MFIter() [6/10]

◆ MFIter() [7/10]

◆ MFIter() [8/10]

◆ MFIter() [9/10]

◆ MFIter() [10/10]

◆ ~MFIter()

Member Function Documentation

◆ allowMultipleMFIters()

◆ currentDepth()

◆ DistributionMap()

◆ fabbox()

◆ Finalize()

◆ grownnodaltilebox() [1/2]

◆ grownnodaltilebox() [2/2]

◆ growntilebox() [1/2]

◆ growntilebox() [2/2]

◆ index()

◆ Initialize()

◆ isValid()

◆ length()

◆ LocalIndex()

◆ LocalTileIndex()

◆ nodaltilebox()

◆ numLocalTiles()

◆ operator++()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ theFabArrayBase()

◆ tilebox() [1/3]

◆ tilebox() [2/3]

◆ tilebox() [3/3]

◆ tileIndex()

◆ validbox()

Member Data Documentation

◆ allow_multiple_mfiters

◆ beginIndex

◆ currentIndex

◆ depth

◆ device_sync

◆ device_sync_post

◆ device_sync_pre

◆ dynamic

◆ endIndex

◆ fabArray

◆ finalized

◆ flags

◆ index_map

◆ local_index_map

◆ local_tile_index_map

◆ m_fa

◆ nextDynamicIndex

◆ num_local_tiles

◆ streams

◆ tile_array

◆ tile_size

◆ typ