Class RefinePatchStrategySet is a utility class that allows multiple SAMRAI::xfer::RefinePatchStrategy objects to be employed by a single SAMRAI::xfer::RefineSchedule.

#include <ibtk/RefinePatchStrategySet.h>

Inheritance diagram for IBTK::RefinePatchStrategySet:

[legend]

Public Member Functions
template<typename InputIterator >
	RefinePatchStrategySet (InputIterator first, InputIterator last, bool managed=true)
	Constructor. More...

	~RefinePatchStrategySet ()
	Destructor. More...

void	setPhysicalBoundaryConditions (SAMRAI::hier::Patch< NDIM > &patch, double fill_time, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill) override

SAMRAI::hier::IntVector< NDIM >	getRefineOpStencilWidth () const override

void	preprocessRefine (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::Box< NDIM > &fine_box, const SAMRAI::hier::IntVector< NDIM > &ratio) override

void	postprocessRefine (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::Box< NDIM > &fine_box, const SAMRAI::hier::IntVector< NDIM > &ratio) override

void	preprocessRefineBoxes (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::BoxList< NDIM > &fine_boxes, const SAMRAI::hier::IntVector< NDIM > &ratio) override

void	postprocessRefineBoxes (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::BoxList< NDIM > &fine_boxes, const SAMRAI::hier::IntVector< NDIM > &ratio) override

virtual void	setPhysicalBoundaryConditions (hier::Patch< DIM > &patch, const double fill_time, const hier::IntVector< DIM > &ghost_width_to_fill)=0

virtual hier::IntVector< DIM >	getRefineOpStencilWidth () const=0

virtual void	preprocessRefine (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::Box< DIM > &fine_box, const hier::IntVector< DIM > &ratio)=0

virtual void	postprocessRefine (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::Box< DIM > &fine_box, const hier::IntVector< DIM > &ratio)=0

virtual void	preprocessRefineBoxes (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::BoxList< DIM > &fine_boxes, const hier::IntVector< DIM > &ratio)

virtual void	postprocessRefineBoxes (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::BoxList< DIM > &fine_boxes, const hier::IntVector< DIM > &ratio)

Private Member Functions
	RefinePatchStrategySet ()=delete
	Default constructor. More...

	RefinePatchStrategySet (const RefinePatchStrategySet &from)=delete
	Copy constructor. More...

RefinePatchStrategySet &	operator= (const RefinePatchStrategySet &that)=delete
	Assignment operator. More...

Private Attributes
std::vector< SAMRAI::xfer::RefinePatchStrategy< NDIM > * >	d_strategy_set
	The set of SAMRAI::xfer:RefinePatchStrategy objects. More...

const bool	d_managed
	Boolean value that indicates whether this class should provide memory management for the strategy objects. More...

Constructor & Destructor Documentation

◆ RefinePatchStrategySet() [1/3]

template<typename InputIterator >

IBTK::RefinePatchStrategySet::RefinePatchStrategySet	(	InputIterator	first,
		InputIterator	last,
		bool	managed = `true`
	)

inline

◆ ~RefinePatchStrategySet()

IBTK::RefinePatchStrategySet::~RefinePatchStrategySet ( )

Note: The patch strategy objects provided to the constructor are deleted by this class destructor.

◆ RefinePatchStrategySet() [2/3]

IBTK::RefinePatchStrategySet::RefinePatchStrategySet ( )

privatedelete

Note: This constructor is not implemented and should not be used.

◆ RefinePatchStrategySet() [3/3]

IBTK::RefinePatchStrategySet::RefinePatchStrategySet ( const RefinePatchStrategySet & from )

privatedelete

Note: This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

◆ setPhysicalBoundaryConditions() [1/2]

void IBTK::RefinePatchStrategySet::setPhysicalBoundaryConditions	(	SAMRAI::hier::Patch< NDIM > &	patch,
		double	fill_time,
		const SAMRAI::hier::IntVector< NDIM > &	ghost_width_to_fill
	)

override

Function to set data associated with the given list of patch data indices at patch boundaries that intersect the physical domain boundary. The specific boundary conditions are determined by the user. The patch data components set in this routine correspond to the scratch components specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

Parameters

patch	Patch on which to fill boundary data.
fill_time	Double simulation time for boundary filling.
ghost_width_to_fill	Integer vector describing maximum ghost width to fill over all registered scratch components.

◆ getRefineOpStencilWidth() [1/2]

SAMRAI::hier::IntVector<NDIM> IBTK::RefinePatchStrategySet::getRefineOpStencilWidth ( ) const

override

Function to return maximum stencil width needed over user-defined data interpolation operations. This is needed to determine the correct interpolation data dependencies.

◆ preprocessRefine() [1/2]

void IBTK::RefinePatchStrategySet::preprocessRefine	(	SAMRAI::hier::Patch< NDIM > &	fine,
		const SAMRAI::hier::Patch< NDIM > &	coarse,
		const SAMRAI::hier::Box< NDIM > &	fine_box,
		const SAMRAI::hier::IntVector< NDIM > &	ratio
	)

override

Function to perform user-defined preprocess data refine operations. This member function is called before standard refine operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The preprocess function refines data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefine() [1/2]

void IBTK::RefinePatchStrategySet::postprocessRefine	(	SAMRAI::hier::Patch< NDIM > &	fine,
		const SAMRAI::hier::Patch< NDIM > &	coarse,
		const SAMRAI::hier::Box< NDIM > &	fine_box,
		const SAMRAI::hier::IntVector< NDIM > &	ratio
	)

override

Function to perform user-defined preprocess data refine operations. This member function is called after standard refine operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The postprocess function refines data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ preprocessRefineBoxes() [1/2]

void IBTK::RefinePatchStrategySet::preprocessRefineBoxes	(	SAMRAI::hier::Patch< NDIM > &	fine,
		const SAMRAI::hier::Patch< NDIM > &	coarse,
		const SAMRAI::hier::BoxList< NDIM > &	fine_boxes,
		const SAMRAI::hier::IntVector< NDIM > &	ratio
	)

override

Function to perform user-defined refine operations. This member function is called before standard refining operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The preprocess function refines data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box regions.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_boxes	List of box regions on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefineBoxes() [1/2]

void IBTK::RefinePatchStrategySet::postprocessRefineBoxes	(	SAMRAI::hier::Patch< NDIM > &	fine,
		const SAMRAI::hier::Patch< NDIM > &	coarse,
		const SAMRAI::hier::BoxList< NDIM > &	fine_boxes,
		const SAMRAI::hier::IntVector< NDIM > &	ratio
	)

override

Function to perform user-defined refine operations. This member function is called after standard refining operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The postprocess function refines data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box regions.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_boxes	List of box regions on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ operator=()

RefinePatchStrategySet& IBTK::RefinePatchStrategySet::operator= ( const RefinePatchStrategySet & that )

privatedelete

Note: This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns: A reference to this object.

◆ setPhysicalBoundaryConditions() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::setPhysicalBoundaryConditions	(	hier::Patch< DIM > &	patch,
		const double	fill_time,
		const hier::IntVector< DIM > &	ghost_width_to_fill
	)

pure virtualinherited

Pure virtual function to set data associated with the given list of patch data indices at patch boundaries that intersect the physical domain boundary. The specific boundary conditions are determined by the user. The patch data components set in this routine correspond to the "scratch" components specified in calls to the registerRefine() function in the RefineAlgorithm<DIM> class.

Parameters

patch	hier::Patch on which to fill boundary data.
fill_time	Double simulation time for boundary filling.
ghost_width_to_fill	Integer vector describing maximum ghost width to fill over all registered scratch components.

◆ getRefineOpStencilWidth() [2/2]

virtual hier::IntVector<DIM> SAMRAI::xfer::RefinePatchStrategy< DIM >::getRefineOpStencilWidth ( ) const

pure virtualinherited

Pure virtual function to return maximum stencil width needed over user-defined data interpolation operations. This is needed to determine the correct interpolation data dependencies.

◆ preprocessRefine() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::preprocessRefine	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::Box< DIM > &	fine_box,
		const hier::IntVector< DIM > &	ratio
	)

pure virtualinherited

Pure virtual function to perform user-defined preprocess data refine operations. This member function is called before standard refine operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The preprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the RefineAlgorithm<DIM> class.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	hier::Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefine() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::postprocessRefine	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::Box< DIM > &	fine_box,
		const hier::IntVector< DIM > &	ratio
	)

pure virtualinherited

Pure virtual function to perform user-defined postprocess data refine operations. This member function is called after standard refine operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The postprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the RefineAlgorithm<DIM> class.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	hier::Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ preprocessRefineBoxes() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::preprocessRefineBoxes	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::BoxList< DIM > &	fine_boxes,
		const hier::IntVector< DIM > &	ratio
	)

virtualinherited

Virtual function to perform user-defined refine operations. This member function is called before standard refining operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The preprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box regions.

Typically, only the pure virtual members of this class are implemented in user-defined subclasses of this base class. This version of the preprocess function operates on an entire box list. By default, this version simply loops over the box list and calls the single-box version, which is a pure virtual function.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_boxes	tbox::List of box regions on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefineBoxes() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::postprocessRefineBoxes	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::BoxList< DIM > &	fine_boxes,
		const hier::IntVector< DIM > &	ratio
	)

virtualinherited

Virtual function to perform user-defined refine operations. This member function is called after standard refining operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The postprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box regions.

Typically, only the pure virtual members of this class are implemented in user-defined subclasses of this base class. This version of the postprocess function operates on an entire box list. By default, this version simply loops over the box list and calls the single-box version, which is a pure virtual function.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_boxes	tbox::List of box regions on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

Member Data Documentation

◆ d_strategy_set

std::vector<SAMRAI::xfer::RefinePatchStrategy<NDIM>*> IBTK::RefinePatchStrategySet::d_strategy_set

private

◆ d_managed

const bool IBTK::RefinePatchStrategySet::d_managed

private

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

ibtk/include/ibtk/RefinePatchStrategySet.h

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ RefinePatchStrategySet() [1/3]

◆ ~RefinePatchStrategySet()

◆ RefinePatchStrategySet() [2/3]

◆ RefinePatchStrategySet() [3/3]

Member Function Documentation

◆ setPhysicalBoundaryConditions() [1/2]

◆ getRefineOpStencilWidth() [1/2]

◆ preprocessRefine() [1/2]

◆ postprocessRefine() [1/2]

◆ preprocessRefineBoxes() [1/2]

◆ postprocessRefineBoxes() [1/2]

◆ operator=()

◆ setPhysicalBoundaryConditions() [2/2]

◆ getRefineOpStencilWidth() [2/2]

◆ preprocessRefine() [2/2]

◆ postprocessRefine() [2/2]

◆ preprocessRefineBoxes() [2/2]

◆ postprocessRefineBoxes() [2/2]

Member Data Documentation

◆ d_strategy_set

◆ d_managed