#include <VariableFillPattern.h>

Inheritance diagram for SAMRAI::xfer::VariableFillPattern< DIM >:

[legend]

Public Member Functions
	VariableFillPattern ()

virtual	~VariableFillPattern ()

virtual tbox::Pointer< hier::BoxOverlap< DIM > >	calculateOverlap (const hier::BoxGeometry< DIM > &dst_geometry, const hier::BoxGeometry< DIM > &src_geometry, const hier::Box< DIM > &dst_patch_box, const hier::Box< DIM > &src_mask, const bool overwrite_interior, const hier::IntVector< DIM > &src_offset) const =0

virtual tbox::Pointer< hier::BoxOverlap< DIM > >	calculateOverlapOnLevel (const hier::BoxGeometry< DIM > &dst_geometry, const hier::BoxGeometry< DIM > &src_geometry, const hier::Box< DIM > &dst_patch_box, const hier::Box< DIM > &src_mask, const bool overwrite_interior, const hier::IntVector< DIM > &src_offset, const int dst_level_num, const int src_level_num) const

virtual void	setTargetPatchLevelNumber (const int level_num)

virtual hier::IntVector< DIM > &	getStencilWidth ()=0

virtual const std::string &	getPatternName () const =0

Private Member Functions
	VariableFillPattern (const VariableFillPattern< DIM > &)

void	operator= (const VariableFillPattern< DIM > &)

Detailed Description

template<int DIM>
class SAMRAI::xfer::VariableFillPattern< DIM >

Class VariableFillPattern is an abstract base class that provides an interface to create objects that can calculate overlaps which correspond to a specific stencil.

Constructor & Destructor Documentation

◆ VariableFillPattern() [1/2]

template<int DIM>

SAMRAI::xfer::VariableFillPattern< DIM >::VariableFillPattern ( )

Default constructor

◆ ~VariableFillPattern()

template<int DIM>

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

virtual

Destructor

◆ VariableFillPattern() [2/2]

template<int DIM>

SAMRAI::xfer::VariableFillPattern< DIM >::VariableFillPattern ( const VariableFillPattern< DIM > & )

private

Member Function Documentation

◆ calculateOverlap()

template<int DIM>

virtual tbox::Pointer< hier::BoxOverlap<DIM> > SAMRAI::xfer::VariableFillPattern< DIM >::calculateOverlap	(	const hier::BoxGeometry< DIM > &	dst_geometry,
		const hier::BoxGeometry< DIM > &	src_geometry,
		const hier::Box< DIM > &	dst_patch_box,
		const hier::Box< DIM > &	src_mask,
		const bool	overwrite_interior,
		const hier::IntVector< DIM > &	src_offset
	)		const

pure virtual

This pure virtual method provides an interface to calculate overlaps between the destination and source geometries.

Parameters

dst_geometry	geometry object for destination box
src_geometry	geometry object for source box
dst_patch_box	box for the destination patch
src_mask	the source mask, the box resulting from shifting the source box
overwrite_interior	controls whether or not to include the destination box interior in the overlap
src_offset	the offset between source and destination index space. src + src_offset = dst

Returns: Pointer to the calculated overlap object

Implemented in SAMRAI::pdat::FirstLayerCellNoCornersFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellFillPattern< DIM >, SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeNoCornersFillPattern< DIM >, and SAMRAI::xfer::BoxGeometryFillPattern< DIM >.

◆ calculateOverlapOnLevel()

template<int DIM>

virtual tbox::Pointer< hier::BoxOverlap<DIM> > SAMRAI::xfer::VariableFillPattern< DIM >::calculateOverlapOnLevel	(	const hier::BoxGeometry< DIM > &	dst_geometry,
		const hier::BoxGeometry< DIM > &	src_geometry,
		const hier::Box< DIM > &	dst_patch_box,
		const hier::Box< DIM > &	src_mask,
		const bool	overwrite_interior,
		const hier::IntVector< DIM > &	src_offset,
		const int	dst_level_num,
		const int	src_level_num
	)		const

virtual

This virtual method provides an interface to calculate overlaps between the destination and source geometries on a specified level of the patch hierarchy.

Note: A default implementation is provided that simply calls the pure virtual method calculateOverlap() for implementations that are level independent.

Parameters

dst_geometry	geometry object for destination box
src_geometry	geometry object for source box
dst_patch_box	box for the destination patch
src_mask	the source mask, the box resulting from shifting the source box
overwrite_interior	controls whether or not to include the destination box interior in the overlap
src_offset	the offset between source and destination index space. src + src_offset = dst
dst_level_num	the level of the patch hierarchy on which the dst boxes are located
src_level_num	the level of the patch hierarchy on which the src boxes are located

Returns: Pointer to the calculated overlap object

◆ setTargetPatchLevelNumber()

template<int DIM>

virtual void SAMRAI::xfer::VariableFillPattern< DIM >::setTargetPatchLevelNumber ( const int level_num )

virtual

Set the target patch level number for the variable fill pattern. The default implementation is empty.

Reimplemented in IBTK::SideNoCornersFillPattern, and IBTK::CellNoCornersFillPattern.

◆ getStencilWidth()

template<int DIM>

virtual hier::IntVector<DIM>& SAMRAI::xfer::VariableFillPattern< DIM >::getStencilWidth ( )

pure virtual

Return the maximum ghost width of the boundary stencil. The default implementation throws an error.

Implemented in IBTK::SideNoCornersFillPattern, IBTK::CellNoCornersFillPattern, IBTK::EdgeSynchCopyFillPattern, IBTK::NodeSynchCopyFillPattern, IBTK::FaceSynchCopyFillPattern, IBTK::SideSynchCopyFillPattern, SAMRAI::pdat::FirstLayerCellNoCornersFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellFillPattern< DIM >, SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeNoCornersFillPattern< DIM >, and SAMRAI::xfer::BoxGeometryFillPattern< DIM >.

◆ getPatternName()

template<int DIM>

virtual const std::string& SAMRAI::xfer::VariableFillPattern< DIM >::getPatternName ( ) const

pure virtual

Return a string name identifying the concrete subclass.

Implemented in SAMRAI::pdat::FirstLayerCellNoCornersFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellFillPattern< DIM >, SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeNoCornersFillPattern< DIM >, and SAMRAI::xfer::BoxGeometryFillPattern< DIM >.

◆ operator=()

template<int DIM>

void SAMRAI::xfer::VariableFillPattern< DIM >::operator= ( const VariableFillPattern< DIM > & )

private

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

/samrai/include/VariableFillPattern.h

Public Member Functions

Private Member Functions

Detailed Description

template<int DIM> class SAMRAI::xfer::VariableFillPattern< DIM >

Constructor & Destructor Documentation

◆ VariableFillPattern() [1/2]

◆ ~VariableFillPattern()

◆ VariableFillPattern() [2/2]

Member Function Documentation

◆ calculateOverlap()

◆ calculateOverlapOnLevel()

◆ setTargetPatchLevelNumber()

◆ getStencilWidth()

◆ getPatternName()

◆ operator=()

template<int DIM>
class SAMRAI::xfer::VariableFillPattern< DIM >