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

#include <FirstLayerNodeFillPattern.h>

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

Public Member Functions
	FirstLayerNodeFillPattern ()
virtual	~FirstLayerNodeFillPattern ()
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
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)

Private Member Functions
	FirstLayerNodeFillPattern (const FirstLayerNodeFillPattern &)
void	operator= (const FirstLayerNodeFillPattern &)

Private Attributes
hier::IntVector< DIM >	d_stencil_width

Static Private Attributes
static std::string	s_name_id

Detailed Description

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

Class FirstLayerNodeFillPattern 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 first layer of boundary nodes, that is the nodes that lie on the patch boundary.

Constructor & Destructor Documentation

FirstLayerNodeFillPattern() [1/2]

template<int DIM>

SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::FirstLayerNodeFillPattern

(

)

Constructor

Parameters

dim

Dimension

~FirstLayerNodeFillPattern()

template<int DIM>

virtual SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::~FirstLayerNodeFillPattern ( )

virtual

Destructor

FirstLayerNodeFillPattern() [2/2]

template<int DIM>

SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::FirstLayerNodeFillPattern ( const FirstLayerNodeFillPattern< DIM > &  )

private

Member Function Documentation

calculateOverlap()

template<int DIM>

tbox::Pointer< hier::BoxOverlap<DIM> > SAMRAI::pdat::FirstLayerNodeFillPattern< 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 node geometries that lies on the boundary of 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 >.

getStencilWidth()

template<int DIM>

hier::IntVector<DIM>& SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::getStencilWidth ( )

virtual

Returns the stencil width of 0 in all directions.

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

getPatternName()

template<int DIM>

const std::string& SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::getPatternName ( ) const

virtual

Returns a string name identifier "FIRST_LAYER_NODE_FILL_PATTERN".

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

operator=()

template<int DIM>

void SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::operator= ( const FirstLayerNodeFillPattern< DIM > &  )

private

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

virtualinherited

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 )

virtualinherited

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

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

Member Data Documentation

d_stencil_width

template<int DIM>

hier::IntVector<DIM> SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::d_stencil_width

private

s_name_id

template<int DIM>

std::string SAMRAI::pdat::FirstLayerNodeFillPattern< DIM >::s_name_id

staticprivate

---

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

• /samrai/include/FirstLayerNodeFillPattern.h