Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages
SAMRAI::mblk::MultiblockRefineSchedule

SAMRAI::mblk::MultiblockRefineSchedule< DIM > Class Template Reference

#include <source/multiblock/MultiblockRefineSchedule.h>

List of all members.

Public Member Functions

 MultiblockRefineSchedule (tbox::Pointer< MultiblockPatchLevel< DIM > > dst_level, tbox::Pointer< MultiblockPatchLevel< DIM > > src_level, tbox::Pointer< MultiblockPatchHierarchy< DIM > > multiblock, tbox::Pointer< xfer::RefineAlgorithm< DIM > > refine_alg, MultiblockRefinePatchStrategy< DIM > *strategy, bool use_time_refinement=false)
 MultiblockRefineSchedule (tbox::Pointer< MultiblockPatchLevel< DIM > > dst_level, tbox::Pointer< MultiblockPatchLevel< DIM > > src_level, const int next_coarser_level, tbox::Pointer< MultiblockPatchHierarchy< DIM > > multiblock, tbox::Pointer< xfer::RefineAlgorithm< DIM > > refine_alg, MultiblockRefinePatchStrategy< DIM > *strategy, bool use_time_refinement=false)
virtual ~MultiblockRefineSchedule ()
void fillData (double fill_time, bool do_physical_boundary_fill=true) const
 Execute the stored communication schedule and perform the data movement.
void initializeSourceVector (hier::ComponentSelector &allocate_vector) const
 Initialize a vector to contain source data components.
const tbox::Pointer< xfer::RefineClasses<
DIM > > & 		getEquivalenceClasses () const
 Get the equivalence classes associated with the algorithm that created this schedule.
void allocateScratchSpace (tbox::Pointer< hier::PatchLevel< DIM > > level, double fill_time, hier::ComponentSelector &allocate_vector) const
 Allocate scratch space on the specified level and return the allocated patch data indices in the component selector for later deallocation.

Classes

struct  SingularityPatch
 struct SingularityPatch allows a temporary patch that contains data near a singularity to be paired with a block id number. More...

template<int DIM>
class SAMRAI::mblk::MultiblockRefineSchedule< DIM >

Constructor & Destructor Documentation

template<int DIM>
SAMRAI::mblk::MultiblockRefineSchedule< DIM >::MultiblockRefineSchedule (  tbox::Pointer< MultiblockPatchLevel< DIM > >  dst_level,
tbox::Pointer< MultiblockPatchLevel< DIM > >  src_level,
tbox::Pointer< MultiblockPatchHierarchy< DIM > >  multiblock,
tbox::Pointer< xfer::RefineAlgorithm< DIM > >  refine_alg,
MultiblockRefinePatchStrategy< DIM > *  strategy,
bool  use_time_refinement = false
) 
 

Constructor to create a MultiblockRefineSchedule that copies data from the interiors of source patch data components on the source level into the interiors and ghost cells of destination patch data components on the destination level. Only data on the intersection of the source and destination patch components will be copied. The source and destination patch levels must reside in the same Multiblock domain. In general, this constructor is called by a MultiblockRefineAlgorithm<DIM> object.

Parameters:
dst_level Pointer to destination level.
src_level Pointer to source level.
multiblock Multiblock patch hierarchy object containing all of the levels that hold the data being communicated
refine_alg Pointer to an xfer::RefineAlgorithm<DIM> that will be used to create refine schedules that will do the data transfers and communication. In general, this is a data member of the calling MultiblockRefineAlgorithm<DIM> object.
strategy Pointer to a multiblock patch strategy object that provides user-defined boundary filling operations for patch boundaries that touch a multiblock singularity point, as well as user- defined physical boundary filling operations. This pointer may be null, in which case no boundary filling operations will occur. case no boundary filling operations will occur.
use_time_refinement Let the destination level be filled using time refinement operations. This defaults to false because it should only be used in recursive calls within this class

template<int DIM>
SAMRAI::mblk::MultiblockRefineSchedule< DIM >::MultiblockRefineSchedule (  tbox::Pointer< MultiblockPatchLevel< DIM > >  dst_level,
tbox::Pointer< MultiblockPatchLevel< DIM > >  src_level,
const int  next_coarser_level,
tbox::Pointer< MultiblockPatchHierarchy< DIM > >  multiblock,
tbox::Pointer< xfer::RefineAlgorithm< DIM > >  refine_alg,
MultiblockRefinePatchStrategy< DIM > *  strategy,
bool  use_time_refinement = false
) 
 

Constructor to create a MultiblockRefineShedule that moves data from the interiors of source patch data components on the source level and coarser levels in the patch hierarchy into the interiors and ghost cells of destination patch data components on the destination level. Only data on the intersection of the source and destination patch components will be copied. If portions of the destination level remain unfilled, then the algorithm recursively fills those unfilled portions from coarser levels in the AMR hierarchy. The source and destination patch levels must reside in the same index space. However, the levels do not have to be in the same AMR patch hierarchy. In general, this constructor is called by a MultiblockRefineAlgorithm<DIM> object.

Parameters:
dst_level Pointer to destination level.
src_level Pointer to source level. This pointer may be null, in which case the destination level will be filled only using data interpolated from coarser levels.
next_coarser_level Integer number of next coarser level in relative to the destination level. Note that when the destination level has number zero (i.e., the coarsest level), this value should be < 0.
multiblock Multiblock object containing all of the levels that hold the data being communicated
refine_alg Pointer to an xfer::RefineAlgorithm<DIM> that will be used to create refine schedules that will do the data transfers and communication. In general, this is a data member of the calling MultiblockRefineAlgorithm<DIM> object.
strategy Pointer to a multiblock patch strategy object that provides user-defined boundary filling operations for patch boundaries that touch a multiblock singularity point, as well as user- defined physical boundary filling operations. This pointer may be null, in which case no boundary filling operations will occur. case no boundary filling operations will occur.
use_time_refinement Let the destination level be filled using time refinement operations. This defaults to false because it should only be used in recursive calls within this class

template<int DIM>
SAMRAI::mblk::MultiblockRefineSchedule< DIM >::~MultiblockRefineSchedule (   )  [virtual]
 

Virtual destructor

Member Function Documentation

template<int DIM>
void SAMRAI::mblk::MultiblockRefineSchedule< DIM >::fillData (  double  fill_time,
bool  do_physical_boundary_fill = true
)  const
 

Execute the stored communication schedule and perform the data movement.

Parameters:
fill_time Double simulation time when the fill take place.
do_physical_boundary_fill Boolean flag used to bypass the physical boundary data filling operations on the destination level. The default value is true indicating that boundary data will be filled (assuming a non-null refine patch strategy pointer was passed to the createSchedule() function. Note that even when the value is false, boundary routines may be called on levels coarser than the destination level if such data is needed for proper interpolation.
filling_coarse_scratch Boolean flag that should only be true if fillData is being called recursively to fill scratch data on a coarser multiblock level.
filling crse_scr_recursive Boolean flag that should only be true when fillData is called in a second or greater level of recursion

template<int DIM>
void SAMRAI::mblk::MultiblockRefineSchedule< DIM >::initializeSourceVector (  hier::ComponentSelector &  allocate_vector  )  const
 

Initialize a vector to contain source data components.

The component selector argument will be filled with the data component id's that have been registered as source items for the algorithm that created this schedule

template<int DIM>
const tbox::Pointer< xfer::RefineClasses< DIM > > & SAMRAI::mblk::MultiblockRefineSchedule< DIM >::getEquivalenceClasses (   )  const
 

Get the equivalence classes associated with the algorithm that created this schedule.

template<int DIM>
void SAMRAI::mblk::MultiblockRefineSchedule< DIM >::allocateScratchSpace (  tbox::Pointer< hier::PatchLevel< DIM > >  level,
double  fill_time,
hier::ComponentSelector &  allocate_vector
)  const
 

Allocate scratch space on the specified level and return the allocated patch data indices in the component selector for later deallocation.

Parameters:
level Level on which to allocate scratch space
fill_time Simulation time
allocate_vector The patch data indices associated with scratch space will be stored here to be used later for deallocation

The documentation for this class was generated from the following files:
Generated on Fri Dec 2 11:28:23 2005 for SAMRAI by  doxygen 1.4.2