amrex::FabArrayCopyDescriptor< FAB > Class Template Reference

This class orchestrates filling a destination fab of size destFabBox from fabarray on the local processor (myProc). More...

#include <AMReX_FACopyDescriptor.H>

Public Member Functions
	FabArrayCopyDescriptor ()=default
	~FabArrayCopyDescriptor ()
	FabArrayCopyDescriptor (const FabArrayCopyDescriptor< FAB > &)=delete
	FabArrayCopyDescriptor (FabArrayCopyDescriptor< FAB > &&)=delete
FabArrayCopyDescriptor< FAB > &	operator= (const FabArrayCopyDescriptor< FAB > &)=delete
FabArrayCopyDescriptor< FAB > &	operator= (FabArrayCopyDescriptor< FAB > &&)=delete
FabArrayId	RegisterFabArray (FabArray< FAB > *fabarray)
FillBoxId	AddBox (FabArrayId fabarrayid, const Box &destFabBox, BoxList *unfilledBoxes)
FillBoxId	AddBox (FabArrayId fabarrayid, const Box &destFabBox, BoxList *unfilledBoxes, int srccomp, int destcomp, int numcomp)
FillBoxId	AddBox (FabArrayId fabarrayid, const Box &destFabBox, BoxList *unfilledBoxes, int fabarrayindex, int srccomp, int destcomp, int numcomp, bool bUseValidBox=true)
void	CollectData ()
void	FillFab (FabArrayId faid, const FillBoxId &fillboxid, FAB &destFab)
void	FillFab (FabArrayId faid, const FillBoxId &fillboxid, FAB &destFab, const Box &destBox)
void	PrintStats () const
bool	DataAvailable () const
void	clear ()
int	CurrentNFabArrays () const
int	nFabComTags () const
int	nFabCopyDescs () const

Detailed Description

template<class FAB>
class amrex::FabArrayCopyDescriptor< FAB >

This class orchestrates filling a destination fab of size destFabBox from fabarray on the local processor (myProc).

Constructor & Destructor Documentation

FabArrayCopyDescriptor() [1/3]

template<class FAB >

amrex::FabArrayCopyDescriptor< FAB >::FabArrayCopyDescriptor ( )

default

~FabArrayCopyDescriptor()

template<class FAB >

amrex::FabArrayCopyDescriptor< FAB >::~FabArrayCopyDescriptor

(

)

FabArrayCopyDescriptor() [2/3]

template<class FAB >

amrex::FabArrayCopyDescriptor< FAB >::FabArrayCopyDescriptor ( const FabArrayCopyDescriptor< FAB > &  )

delete

FabArrayCopyDescriptor() [3/3]

template<class FAB >

amrex::FabArrayCopyDescriptor< FAB >::FabArrayCopyDescriptor ( FabArrayCopyDescriptor< FAB > &&  )

delete

Member Function Documentation

AddBox() [1/3]

template<class FAB >

FillBoxId amrex::FabArrayCopyDescriptor< FAB >::AddBox	(	FabArrayId	fabarrayid,
		const Box &	destFabBox,
		BoxList *	unfilledBoxes
	)

AddBox() [2/3]

template<class FAB >

FillBoxId amrex::FabArrayCopyDescriptor< FAB >::AddBox	(	FabArrayId	fabarrayid,
		const Box &	destFabBox,
		BoxList *	unfilledBoxes,
		int	fabarrayindex,
		int	srccomp,
		int	destcomp,
		int	numcomp,
		bool	bUseValidBox = true
	)

Add a box but only from FabArray[fabarrayindex].

AddBox() [3/3]

template<class FAB >

FillBoxId amrex::FabArrayCopyDescriptor< FAB >::AddBox	(	FabArrayId	fabarrayid,
		const Box &	destFabBox,
		BoxList *	unfilledBoxes,
		int	srccomp,
		int	destcomp,
		int	numcomp
	)

clear()

template<class FAB >

void amrex::FabArrayCopyDescriptor< FAB >::clear

(

)

CollectData()

template<class FAB >

void amrex::FabArrayCopyDescriptor< FAB >::CollectData

(

)

CurrentNFabArrays()

template<class FAB >

int amrex::FabArrayCopyDescriptor< FAB >::CurrentNFabArrays ( ) const

inline

DataAvailable()

template<class FAB >

bool amrex::FabArrayCopyDescriptor< FAB >::DataAvailable ( ) const

inline

FillFab() [1/2]

template<class FAB >

void amrex::FabArrayCopyDescriptor< FAB >::FillFab	(	FabArrayId	faid,
		const FillBoxId &	fillboxid,
		FAB &	destFab
	)

FillFab() [2/2]

template<class FAB >

void amrex::FabArrayCopyDescriptor< FAB >::FillFab	(	FabArrayId	faid,
		const FillBoxId &	fillboxid,
		FAB &	destFab,
		const Box &	destBox
	)

nFabComTags()

template<class FAB >

int amrex::FabArrayCopyDescriptor< FAB >::nFabComTags ( ) const

inline

nFabCopyDescs()

template<class FAB >

int amrex::FabArrayCopyDescriptor< FAB >::nFabCopyDescs ( ) const

inline

operator=() [1/2]

template<class FAB >

FabArrayCopyDescriptor< FAB > & amrex::FabArrayCopyDescriptor< FAB >::operator= ( const FabArrayCopyDescriptor< FAB > &  )

delete

operator=() [2/2]

template<class FAB >

FabArrayCopyDescriptor< FAB > & amrex::FabArrayCopyDescriptor< FAB >::operator= ( FabArrayCopyDescriptor< FAB > &&  )

delete

PrintStats()

template<class FAB >

void amrex::FabArrayCopyDescriptor< FAB >::PrintStats

(

)

const

RegisterFabArray()

template<class FAB >

FabArrayId amrex::FabArrayCopyDescriptor< FAB >::RegisterFabArray

(

FabArray< FAB > *

fabarray

)

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_FACopyDescriptor.H