SAMRAI::pdat::FirstLayerCellFillPattern< DIM > Class Template Reference

#include <source/patchdata/boxgeometry/FirstLayerCellFillPattern.h>

Inheritance diagram for SAMRAI::pdat::FirstLayerCellFillPattern< DIM >:

[legend]List of all members.

Public Member Functions
	FirstLayerCellFillPattern ()
virtual	~FirstLayerCellFillPattern ()
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
hier::IntVector< DIM > &	getStencilWidth ()
const std::string &	getPatternName () const

---

Detailed Description

template<int DIM>
class SAMRAI::pdat::FirstLayerCellFillPattern< DIM >

Class FirstLayerCellFillPattern is a concrete implementation of the abstract base class VariableFillPattern. It is used to calculate overlaps according to a pattern which limits overlaps to the cell-centered ghost region of width 1 surrounding a patch, including all edges and corners.

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::FirstLayerCellFillPattern< DIM >::FirstLayerCellFillPattern

(

)

Constructor

Parameters:

dim

Dimension

template<int DIM>

SAMRAI::pdat::FirstLayerCellFillPattern< DIM >::~FirstLayerCellFillPattern

(

)

[virtual]

Destructor

---

Member Function Documentation

template<int DIM>

tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::FirstLayerCellFillPattern< 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 [virtual]

Calculate overlaps between the destination and source geometries according to the desired pattern. This will return the portion of the intersection of the geometries that lies in the ghost region of width 1 surrounding the patch. The patch is identified by the argument dst_patch_box.

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

Implements SAMRAI::xfer::VariableFillPattern< DIM >.

template<int DIM>

hier::IntVector< DIM > & SAMRAI::pdat::FirstLayerCellFillPattern< DIM >::getStencilWidth

(

)

[virtual]

Returns the stencil width of 1 in all directions.

Implements SAMRAI::xfer::VariableFillPattern< DIM >.

template<int DIM>

const std::string & SAMRAI::pdat::FirstLayerCellFillPattern< DIM >::getPatternName

(

)

const [virtual]

Returns a string name identifier "FIRST_LAYER_CELL_FILL_PATTERN".

Implements SAMRAI::xfer::VariableFillPattern< DIM >.

---

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

• source/patchdata/boxgeometry/FirstLayerCellFillPattern.h
• source/patchdata/boxgeometry/FirstLayerCellFillPattern.C

---