#include <MultiblockRefineSchedule.h>

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

Public Member Functions
	MultiblockRefineSchedule (const std::string &fill_pattern, tbox::Pointer< hier::MultiblockPatchLevel< DIM > > dst_level, tbox::Pointer< hier::MultiblockPatchLevel< DIM > > src_level, tbox::Pointer< hier::MultiblockPatchHierarchy< DIM > > multiblock, tbox::Pointer< xfer::RefineAlgorithm< DIM > > refine_alg, tbox::Pointer< xfer::RefineTransactionFactory< DIM > > transaction_factory, MultiblockRefinePatchStrategy< DIM > *strategy, bool use_time_refinement=false)

	MultiblockRefineSchedule (const std::string &fill_pattern, tbox::Pointer< hier::MultiblockPatchLevel< DIM > > dst_level, tbox::Pointer< hier::MultiblockPatchLevel< DIM > > src_level, const int next_coarser_level, tbox::Pointer< hier::MultiblockPatchHierarchy< DIM > > multiblock, tbox::Pointer< xfer::RefineAlgorithm< DIM > > refine_alg, tbox::Pointer< xfer::RefineTransactionFactory< DIM > > transaction_factory, 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. More...

void	initializeSourceVector (hier::ComponentSelector &allocate_vector) const
	Initialize a vector to contain source data components. More...

const tbox::Pointer< xfer::RefineClasses< DIM > > &	getEquivalenceClasses () const
	Get the equivalence classes associated with the algorithm that created this schedule. More...

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. More...

Private Member Functions
void	fillData (double fill_time, bool do_physical_boundary_fill, bool filling_coarse_scratch, bool filling_crse_scr_recursive=false) const

void	createInterblockSchedules (tbox::Pointer< hier::MultiblockPatchLevel< DIM > > dst_level, tbox::Pointer< hier::MultiblockPatchLevel< DIM > > src_level, xfer::RefinePatchStrategy< DIM > *refine_strategy, int level_number=MULTIBLOCK_FAKE_LEVEL_NUMBER, bool use_time_refinement=false)

void	copyBetweenBlocks (tbox::Pointer< hier::PatchLevel< DIM > > dst_level, const tbox::Pointer< hier::PatchLevel< DIM > > src_level, const hier::IntVector< DIM > &shift, const typename hier::MultiblockPatchHierarchy< DIM >::RotationIdentifier rotate, const tbox::Pointer< xfer::RefineClasses< DIM > > refine_classes) const

void	fillBetweenBlocks (tbox::Pointer< hier::PatchLevel< DIM > > dst_level, const tbox::Pointer< hier::PatchLevel< DIM > > src_level, const hier::IntVector< DIM > &shift, const typename hier::MultiblockPatchHierarchy< DIM >::RotationIdentifier rotate, const tbox::Pointer< xfer::RefineClasses< DIM > > refine_classes) const

void	fillSingularityBoundary (tbox::Pointer< hier::PatchLevel< DIM > > &level, tbox::Array< tbox::List< SingularityPatch > > &singularity_patches, const int block_number, const double fill_time) const

bool	needOtherSourceBlocks (hier::BoxList< DIM > &dst_boxes, hier::BoxList< DIM > &src_boxes, hier::BoxList< DIM > &domain_outside_block) const

void	createCoarseSchedule (tbox::Pointer< hier::PatchLevel< DIM > > &fine_level, int next_coarser_level, const hier::IntVector< DIM > &ratio_to_coarser, tbox::Pointer< hier::PatchHierarchy< DIM > > &hierarchy, int block_number)

void	createNeighborCoarseSchedule (tbox::Pointer< hier::PatchLevel< DIM > > &fine_level, int next_coarser_level, const hier::IntVector< DIM > &ratio_to_coarser, tbox::Pointer< hier::PatchHierarchy< DIM > > &hierarchy, int neighbor_block_number, int dst_block_number, int neighbor_counter)

void	findUnfilledBoxes (hier::BoxList< DIM > &unfilled_boxes, const int block_number, tbox::Pointer< hier::MultiblockPatchLevel< DIM > > coarse_hierarchy_level, const hier::BoxList< DIM > &pseudo_domain, const hier::IntVector< DIM > &gcw)

void	constructScratchRefineAlgorithm ()

void	refineScratchData (tbox::Pointer< hier::MultiblockPatchLevel< DIM > > coarse_level, tbox::Pointer< hier::PatchLevel< DIM > > fine_level, const hier::BoxList< DIM > &unfilled_boxes, const int block_number, const bool use_fine_gcw) const

void	copyScratchToDestination (tbox::Pointer< hier::PatchLevel< DIM > > level, const hier::BoxList< DIM > &unfilled_boxes, const tbox::Pointer< xfer::RefineClasses< DIM > > refine_classes) const

tbox::Pointer< hier::BoxOverlap< DIM > >	calculateOverlap (const hier::Patch< DIM > &dst_patch, const hier::Patch< DIM > &src_patch, const xfer::RefineClasses< DIM > &refine_classes, const int refine_class_id) const

hier::IntVector< DIM >	getBoundaryFillGhostWidth () const

tbox::Pointer< hier::ComponentSelector > &	getCoarseScratchVector (const int block_num)

void	initializeDestinationVector (hier::ComponentSelector &dst_vector) const

Private Attributes
tbox::Pointer< hier::MultiblockPatchHierarchy< DIM > >	d_multiblock_hierarchy

tbox::Pointer< xfer::RefineAlgorithm< DIM > >	d_single_block_refine_alg

tbox::Pointer< xfer::RefineAlgorithm< DIM > >	d_single_block_scratch_refine_alg

std::string	d_fill_pattern

tbox::Pointer< xfer::RefineTransactionFactory< DIM > >	d_transaction_factory

tbox::Array< tbox::Pointer< xfer::RefineSchedule< DIM > > >	d_single_block_fill_local

tbox::Array< tbox::Pointer< MultiblockRefineSchedule< DIM > > >	d_multiblock_coarse_schedule

tbox::Array< tbox::Pointer< hier::ComponentSelector > >	d_coarse_selector

tbox::Array< bool >	d_local_fill_only

tbox::Array< hier::BoxList< DIM > >	d_unfilled_boxes

tbox::Array< tbox::Pointer< hier::MultiblockPatchLevel< DIM > > >	d_multiblock_coarse_scratch_level

tbox::Array< tbox::Array< bool > >	d_neighbor_copy_only

tbox::Array< tbox::Array< hier::BoxList< DIM > > >	d_neighbor_unfilled_boxes

tbox::Array< tbox::Array< tbox::Pointer< hier::MultiblockPatchLevel< DIM > > > >	d_neighbor_multiblock_coarse_level

tbox::Array< tbox::Array< tbox::Pointer< MultiblockRefineSchedule< DIM > > > >	d_neighbor_multiblock_coarse_schedule

tbox::Array< tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > >	d_neighbor_ghost_level

tbox::Array< tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > >	d_finalize_ghost_level

tbox::Array< tbox::Array< tbox::Array< int > > >	d_finalize_ghost_patch_numbers

tbox::Array< tbox::Array< tbox::Array< int > > >	d_finalize_ghost_num_src_patches

tbox::Array< tbox::Array< tbox::Pointer< xfer::RefineSchedule< DIM > > > >	d_neighbor_single_block_refine_schedule

bool	d_using_standard_transaction

tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	d_multiblock_dst_level

MultiblockRefinePatchStrategy< DIM > *	d_multiblock_strategy

Constructor & Destructor Documentation

◆ MultiblockRefineSchedule() [1/2]

template<int DIM>

SAMRAI::xfer::MultiblockRefineSchedule< DIM >::MultiblockRefineSchedule	(	const std::string &	fill_pattern,
		tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	dst_level,
		tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	src_level,
		tbox::Pointer< hier::MultiblockPatchHierarchy< DIM > >	multiblock,
		tbox::Pointer< xfer::RefineAlgorithm< DIM > >	refine_alg,
		tbox::Pointer< xfer::RefineTransactionFactory< DIM > >	transaction_factory,
		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

fill_pattern	Indicates which parts of the destination level to fill. See RefineSchedule for valid values.
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.
transaction_factory	Transaction factory.
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

◆ MultiblockRefineSchedule() [2/2]

template<int DIM>

SAMRAI::xfer::MultiblockRefineSchedule< DIM >::MultiblockRefineSchedule	(	const std::string &	fill_pattern,
		tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	dst_level,
		tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	src_level,
		const int	next_coarser_level,
		tbox::Pointer< hier::MultiblockPatchHierarchy< DIM > >	multiblock,
		tbox::Pointer< xfer::RefineAlgorithm< DIM > >	refine_alg,
		tbox::Pointer< xfer::RefineTransactionFactory< DIM > >	transaction_factory,
		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

fill_pattern	Indicates which parts of the destination level to fill. See RefineSchedule for valid values.
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.
transaction_factory	Transaction factory.
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

◆ ~MultiblockRefineSchedule()

template<int DIM>

virtual SAMRAI::xfer::MultiblockRefineSchedule< DIM >::~MultiblockRefineSchedule ( )

virtual

Virtual destructor

Member Function Documentation

◆ fillData() [1/2]

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::fillData	(	double	fill_time,
		bool	do_physical_boundary_fill = `true`
	)		const

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.

◆ initializeSourceVector()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::initializeSourceVector ( hier::ComponentSelector & allocate_vector ) const

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

◆ getEquivalenceClasses()

template<int DIM>

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

◆ allocateScratchSpace()

template<int DIM>

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

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

◆ fillData() [2/2]

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::fillData	(	double	fill_time,
		bool	do_physical_boundary_fill,
		bool	filling_coarse_scratch,
		bool	filling_crse_scr_recursive = `false`
	)		const

private

◆ createInterblockSchedules()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::createInterblockSchedules	(	tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	dst_level,
		tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	src_level,
		xfer::RefinePatchStrategy< DIM > *	refine_strategy,
		int	level_number = `MULTIBLOCK_FAKE_LEVEL_NUMBER`,
		bool	use_time_refinement = `false`
	)

private

◆ copyBetweenBlocks()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::copyBetweenBlocks	(	tbox::Pointer< hier::PatchLevel< DIM > >	dst_level,
		const tbox::Pointer< hier::PatchLevel< DIM > >	src_level,
		const hier::IntVector< DIM > &	shift,
		const typename hier::MultiblockPatchHierarchy< DIM >::RotationIdentifier	rotate,
		const tbox::Pointer< xfer::RefineClasses< DIM > >	refine_classes
	)		const

private

◆ fillBetweenBlocks()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::fillBetweenBlocks	(	tbox::Pointer< hier::PatchLevel< DIM > >	dst_level,
		const tbox::Pointer< hier::PatchLevel< DIM > >	src_level,
		const hier::IntVector< DIM > &	shift,
		const typename hier::MultiblockPatchHierarchy< DIM >::RotationIdentifier	rotate,
		const tbox::Pointer< xfer::RefineClasses< DIM > >	refine_classes
	)		const

private

◆ fillSingularityBoundary()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::fillSingularityBoundary	(	tbox::Pointer< hier::PatchLevel< DIM > > &	level,
		tbox::Array< tbox::List< SingularityPatch > > &	singularity_patches,
		const int	block_number,
		const double	fill_time
	)		const

private

◆ needOtherSourceBlocks()

template<int DIM>

bool SAMRAI::xfer::MultiblockRefineSchedule< DIM >::needOtherSourceBlocks	(	hier::BoxList< DIM > &	dst_boxes,
		hier::BoxList< DIM > &	src_boxes,
		hier::BoxList< DIM > &	domain_outside_block
	)		const

private

◆ createCoarseSchedule()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::createCoarseSchedule	(	tbox::Pointer< hier::PatchLevel< DIM > > &	fine_level,
		int	next_coarser_level,
		const hier::IntVector< DIM > &	ratio_to_coarser,
		tbox::Pointer< hier::PatchHierarchy< DIM > > &	hierarchy,
		int	block_number
	)

private

◆ createNeighborCoarseSchedule()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::createNeighborCoarseSchedule	(	tbox::Pointer< hier::PatchLevel< DIM > > &	fine_level,
		int	next_coarser_level,
		const hier::IntVector< DIM > &	ratio_to_coarser,
		tbox::Pointer< hier::PatchHierarchy< DIM > > &	hierarchy,
		int	neighbor_block_number,
		int	dst_block_number,
		int	neighbor_counter
	)

private

◆ findUnfilledBoxes()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::findUnfilledBoxes	(	hier::BoxList< DIM > &	unfilled_boxes,
		const int	block_number,
		tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	coarse_hierarchy_level,
		const hier::BoxList< DIM > &	pseudo_domain,
		const hier::IntVector< DIM > &	gcw
	)

private

◆ constructScratchRefineAlgorithm()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::constructScratchRefineAlgorithm ( )

private

◆ refineScratchData()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::refineScratchData	(	tbox::Pointer< hier::MultiblockPatchLevel< DIM > >	coarse_level,
		tbox::Pointer< hier::PatchLevel< DIM > >	fine_level,
		const hier::BoxList< DIM > &	unfilled_boxes,
		const int	block_number,
		const bool	use_fine_gcw
	)		const

private

◆ copyScratchToDestination()

template<int DIM>

void SAMRAI::xfer::MultiblockRefineSchedule< DIM >::copyScratchToDestination	(	tbox::Pointer< hier::PatchLevel< DIM > >	level,
		const hier::BoxList< DIM > &	unfilled_boxes,
		const tbox::Pointer< xfer::RefineClasses< DIM > >	refine_classes
	)		const

private

◆ calculateOverlap()

template<int DIM>

tbox::Pointer< hier::BoxOverlap<DIM> > SAMRAI::xfer::MultiblockRefineSchedule< DIM >::calculateOverlap	(	const hier::Patch< DIM > &	dst_patch,
		const hier::Patch< DIM > &	src_patch,
		const xfer::RefineClasses< DIM > &	refine_classes,
		const int	refine_class_id
	)		const