SAMRAI::xfer::VariableFillPattern< DIM > Class Template Reference

#include <source/transfer/operators/VariableFillPattern.h>

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

[legend]List of all members.

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 hier::IntVector< DIM > &	getStencilWidth ()=0
virtual const std::string &	getPatternName () const=0

---

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

template<int DIM>

SAMRAI::xfer::VariableFillPattern< DIM >::VariableFillPattern

(

)

Default constructor

template<int DIM>

SAMRAI::xfer::VariableFillPattern< DIM >::~VariableFillPattern

(

)

[virtual]

Destructor

---

Member Function Documentation

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::xfer::BoxGeometryFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellNoCornersFillPattern< DIM >, SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeFillPattern< DIM >, and SAMRAI::pdat::SecondLayerNodeNoCornersFillPattern< DIM >.

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 SAMRAI::xfer::BoxGeometryFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellNoCornersFillPattern< DIM >, SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeFillPattern< DIM >, and SAMRAI::pdat::SecondLayerNodeNoCornersFillPattern< DIM >.

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::xfer::BoxGeometryFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellFillPattern< DIM >, SAMRAI::pdat::FirstLayerCellNoCornersFillPattern< DIM >, SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >, SAMRAI::pdat::SecondLayerNodeFillPattern< DIM >, and SAMRAI::pdat::SecondLayerNodeNoCornersFillPattern< DIM >.

---

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

• source/transfer/operators/VariableFillPattern.h
• source/transfer/operators/VariableFillPattern.C

---