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

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

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

[legend]List of all members.

Public Member Functions
	BoxGeometryFillPattern ()
virtual	~BoxGeometryFillPattern ()
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::xfer::BoxGeometryFillPattern< DIM >

Class BoxGeometryFillPattern is a default implementation of the abstract base class VariableFillPattern. It is used to calculate overlaps that consist of the intersections between boxes, including the full ghost regions.

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::xfer::BoxGeometryFillPattern< DIM >::BoxGeometryFillPattern

(

)

Default constructor

template<int DIM>

SAMRAI::xfer::BoxGeometryFillPattern< DIM >::~BoxGeometryFillPattern

(

)

[virtual]

Destructor

---

Member Function Documentation

template<int DIM>

tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::xfer::BoxGeometryFillPattern< 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 using the geometries' own overlap calculation methods.

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::xfer::BoxGeometryFillPattern< DIM >::getStencilWidth

(

)

[virtual]

Implementation of interface to get stencil width of a VariableFillPattern. For this class BoxGeometryFillPattern, this method should never be called, since overlaps are computed based on box geometry objects and not on any stencil. An error will result if this method is invoked.

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

template<int DIM>

const std::string & SAMRAI::xfer::BoxGeometryFillPattern< DIM >::getPatternName

(

)

const [virtual]

Returns a string name identifier "BOX_GEOMETRY_FILL_PATTERN".

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

---

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

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

---