Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
amrex::MultiFabCopyDescriptor Class Reference

#include <AMReX_MFCopyDescriptor.H>

Inheritance diagram for amrex::MultiFabCopyDescriptor:
amrex::FabArrayCopyDescriptor< FArrayBox >

Public Member Functions

 MultiFabCopyDescriptor ()=default
 
 ~MultiFabCopyDescriptor ()=default
 
 MultiFabCopyDescriptor (const MultiFabCopyDescriptor &)=delete
 
 MultiFabCopyDescriptor (MultiFabCopyDescriptor &&)=delete
 
MultiFabCopyDescriptoroperator= (const MultiFabCopyDescriptor &)=delete
 
MultiFabCopyDescriptoroperator= (MultiFabCopyDescriptor &&)=delete
 
MultiFabId RegisterMultiFab (MultiFab *mf)
 
- Public Member Functions inherited from amrex::FabArrayCopyDescriptor< FArrayBox >
 FabArrayCopyDescriptor ()=default
 
 FabArrayCopyDescriptor (const FabArrayCopyDescriptor< FArrayBox > &)=delete
 
 FabArrayCopyDescriptor (FabArrayCopyDescriptor< FArrayBox > &&)=delete
 
 ~FabArrayCopyDescriptor ()
 
FabArrayCopyDescriptor< FArrayBox > & operator= (const FabArrayCopyDescriptor< FArrayBox > &)=delete
 
FabArrayCopyDescriptor< FArrayBox > & operator= (FabArrayCopyDescriptor< FArrayBox > &&)=delete
 
FabArrayId RegisterFabArray (FabArray< FArrayBox > *fabarray)
 Register a FabArray from which copies may be requested.
 
FillBoxId AddBox (FabArrayId fabarrayid, const Box &destFabBox, BoxList *unfilledBoxes)
 Describe a destination box that needs to be filled.
 
FillBoxId AddBox (FabArrayId fabarrayid, const Box &destFabBox, BoxList *unfilledBoxes, int srccomp, int destcomp, int numcomp)
 Add a destination box specifying component ranges explicitly.
 
FillBoxId AddBox (FabArrayId fabarrayid, const Box &destFabBox, BoxList *unfilledBoxes, int fabarrayindex, int srccomp, int destcomp, int numcomp, bool bUseValidBox=true)
 Add a destination box but restrict fills to a specific Fab index.
 
void CollectData ()
 Exchange staged data for all FillBox entries.
 
void FillFab (FabArrayId faid, const FillBoxId &fillboxid, FArrayBox &destFab)
 Copy staged data into the requested fill region of the destination Fab.
 
void FillFab (FabArrayId faid, const FillBoxId &fillboxid, FArrayBox &destFab, const Box &destBox)
 Copy staged data into a user-specified sub-box of the destination Fab.
 
void PrintStats () const
 Print per-rank box-array information for each registered FabArray.
 
bool DataAvailable () const
 Return true once all requested data have been staged locally.
 
void clear ()
 Reset the descriptor, unregistering all FabArrays and outstanding boxes.
 
int CurrentNFabArrays () const
 Number of FabArrays currently registered with this descriptor.
 
int nFabComTags () const
 Number of remote-transfer FabComTag entries currently stored.
 
int nFabCopyDescs () const
 Number of per-FabArray FabCopyDescriptor maps held (one per registered FabArray).
 

Constructor & Destructor Documentation

◆ MultiFabCopyDescriptor() [1/3]

amrex::MultiFabCopyDescriptor::MultiFabCopyDescriptor ( )
default

◆ ~MultiFabCopyDescriptor()

amrex::MultiFabCopyDescriptor::~MultiFabCopyDescriptor ( )
default

◆ MultiFabCopyDescriptor() [2/3]

amrex::MultiFabCopyDescriptor::MultiFabCopyDescriptor ( const MultiFabCopyDescriptor )
delete

◆ MultiFabCopyDescriptor() [3/3]

amrex::MultiFabCopyDescriptor::MultiFabCopyDescriptor ( MultiFabCopyDescriptor &&  )
delete

Member Function Documentation

◆ operator=() [1/2]

MultiFabCopyDescriptor & amrex::MultiFabCopyDescriptor::operator= ( const MultiFabCopyDescriptor )
delete

◆ operator=() [2/2]

MultiFabCopyDescriptor & amrex::MultiFabCopyDescriptor::operator= ( MultiFabCopyDescriptor &&  )
delete

◆ RegisterMultiFab()

MultiFabId amrex::MultiFabCopyDescriptor::RegisterMultiFab ( MultiFab mf)
inline

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