Class CoarseFineBoundaryRefinePatchStrategy is a subclass of the abstract base class SAMRAI::xfer::RefinePatchStrategy that extends the functionality of SAMRAI::xfer::RefinePatchStrategy to facilitate the implementation of coarse-fine interface discretizations.

#include <ibtk/CoarseFineBoundaryRefinePatchStrategy.h>

Inheritance diagram for IBTK::CoarseFineBoundaryRefinePatchStrategy:

[legend]

Public Member Functions
	CoarseFineBoundaryRefinePatchStrategy ()=default
	Constructor. More...

virtual	~CoarseFineBoundaryRefinePatchStrategy ()=default
	Destructor. More...

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)

SAMRAI::xfer::RefinePatchStrategy interface.
void	setPhysicalBoundaryConditions (SAMRAI::hier::Patch< NDIM > &patch, double fill_time, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill) override=0

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

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=0

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=0

Extension of SAMRAI::xfer::RefinePatchStrategy interface to support more
complex coarse-fine interface discretizations.
virtual void	setConsistentInterpolationScheme (bool consistent_type_2_bdry)=0

virtual void	setPatchDataIndex (int patch_data_index)=0
	Reset the patch data index operated upon by this class. More...

virtual void	setPatchDataIndices (const std::set< int > &patch_data_indices)=0
	Reset the patch data indices operated upon by this class. More...

virtual void	setPatchDataIndices (const SAMRAI::hier::ComponentSelector &patch_data_indices)=0
	Reset the patch data indices operated upon by this class. More...

virtual void	setPatchHierarchy (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy)=0

virtual void	clearPatchHierarchy ()=0

virtual void	computeNormalExtension (SAMRAI::hier::Patch< NDIM > &patch, const SAMRAI::hier::IntVector< NDIM > &ratio, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill)=0

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

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

Constructor & Destructor Documentation

◆ CoarseFineBoundaryRefinePatchStrategy() [1/2]

IBTK::CoarseFineBoundaryRefinePatchStrategy::CoarseFineBoundaryRefinePatchStrategy ( )

default

◆ ~CoarseFineBoundaryRefinePatchStrategy()

virtual IBTK::CoarseFineBoundaryRefinePatchStrategy::~CoarseFineBoundaryRefinePatchStrategy ( )

virtualdefault

◆ CoarseFineBoundaryRefinePatchStrategy() [2/2]

IBTK::CoarseFineBoundaryRefinePatchStrategy::CoarseFineBoundaryRefinePatchStrategy ( const CoarseFineBoundaryRefinePatchStrategy & 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::CoarseFineBoundaryRefinePatchStrategy::setPhysicalBoundaryConditions	(	SAMRAI::hier::Patch< NDIM > &	patch,
		double	fill_time,
		const SAMRAI::hier::IntVector< NDIM > &	ghost_width_to_fill
	)

overridepure virtual

Function to set data associated with the given list of patch data indices at patch boundaries that intersect the physical domain boundary. 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.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ getRefineOpStencilWidth() [1/2]

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

overridepure virtual

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

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ preprocessRefine() [1/2]

void IBTK::CoarseFineBoundaryRefinePatchStrategy::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
	)

overridepure 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 SAMRAI::xfer::RefineOperator 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 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.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ postprocessRefine() [1/2]

void IBTK::CoarseFineBoundaryRefinePatchStrategy::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
	)

overridepure 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 SAMRAI::xfer::RefineOperator 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 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.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ setConsistentInterpolationScheme()

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::setConsistentInterpolationScheme ( bool consistent_type_2_bdry )

pure virtual

Whether or not to employ a consistent interpolation scheme at "Type 2" coarse-fine interface ghost cells.

Note: This subclasses may choose not to support a consistent "Type 2" coarse-fine interface ghost cell interpolation scheme.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ setPatchDataIndex()

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::setPatchDataIndex ( int patch_data_index )

pure virtual

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ setPatchDataIndices() [1/2]

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::setPatchDataIndices ( const std::set< int > & patch_data_indices )

pure virtual

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ setPatchDataIndices() [2/2]

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::setPatchDataIndices ( const SAMRAI::hier::ComponentSelector & patch_data_indices )

pure virtual

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ setPatchHierarchy()

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::setPatchHierarchy ( SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy )

pure virtual

Set the patch hierarchy used in constructing coarse-fine interface boundary boxes.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ clearPatchHierarchy()

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::clearPatchHierarchy ( )

pure virtual

Clear the patch hierarchy used in constructing coarse-fine interface boundary boxes.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ computeNormalExtension()

virtual void IBTK::CoarseFineBoundaryRefinePatchStrategy::computeNormalExtension	(	SAMRAI::hier::Patch< NDIM > &	patch,
		const SAMRAI::hier::IntVector< NDIM > &	ratio,
		const SAMRAI::hier::IntVector< NDIM > &	ghost_width_to_fill
	)

pure virtual

Compute the normal extension of fine data at coarse-fine interfaces.

Implemented in IBTK::CartSideDoubleQuadraticCFInterpolation, IBTK::CartCellDoubleQuadraticCFInterpolation, and IBTK::CartCellDoubleLinearCFInterpolation.

◆ operator=()

CoarseFineBoundaryRefinePatchStrategy& IBTK::CoarseFineBoundaryRefinePatchStrategy::operator= ( const CoarseFineBoundaryRefinePatchStrategy & 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()

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()

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.

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

ibtk/include/ibtk/CoarseFineBoundaryRefinePatchStrategy.h

Public Member Functions

Extension of SAMRAI::xfer::RefinePatchStrategy interface to support more

Constructor & Destructor Documentation

◆ CoarseFineBoundaryRefinePatchStrategy() [1/2]

◆ ~CoarseFineBoundaryRefinePatchStrategy()

◆ CoarseFineBoundaryRefinePatchStrategy() [2/2]

Member Function Documentation

◆ setPhysicalBoundaryConditions() [1/2]

◆ getRefineOpStencilWidth() [1/2]

◆ preprocessRefine() [1/2]

◆ postprocessRefine() [1/2]

◆ setConsistentInterpolationScheme()

◆ setPatchDataIndex()

◆ setPatchDataIndices() [1/2]

◆ setPatchDataIndices() [2/2]

◆ setPatchHierarchy()

◆ clearPatchHierarchy()

◆ computeNormalExtension()

◆ operator=()

◆ setPhysicalBoundaryConditions() [2/2]

◆ getRefineOpStencilWidth() [2/2]

◆ preprocessRefine() [2/2]

◆ postprocessRefine() [2/2]

◆ preprocessRefineBoxes()

◆ postprocessRefineBoxes()