IBAMR
An adaptive and distributed-memory parallel implementation of the immersed boundary (IB) method
Public Member Functions | List of all members
IBTK::SideSynchCopyFillPattern Class Reference

Class SideCellSynchCopyFillPattern is a concrete implementation of the abstract base class SAMRAI::xfer::VariableFillPattern. It is used to calculate overlaps according to a pattern which limits overlaps to the side-centered ghost region surrounding a patch appropriate for "synchronizing" side-centered values at patch boundaries. More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/SideSynchCopyFillPattern.h>

Inheritance diagram for IBTK::SideSynchCopyFillPattern:
Inheritance graph
[legend]

Public Member Functions

 SideSynchCopyFillPattern ()=default
 Default constructor.
 
 ~SideSynchCopyFillPattern ()=default
 Destructor.
 
SAMRAI::tbox::Pointer< SAMRAI::hier::BoxOverlap< NDIM > > calculateOverlap (const SAMRAI::hier::BoxGeometry< NDIM > &dst_geometry, const SAMRAI::hier::BoxGeometry< NDIM > &src_geometry, const SAMRAI::hier::Box< NDIM > &dst_patch_box, const SAMRAI::hier::Box< NDIM > &src_mask, bool overwrite_interior, const SAMRAI::hier::IntVector< NDIM > &src_offset) const override
 
SAMRAI::hier::IntVector< NDIM > & getStencilWidth () override
 
const std::stringgetPatternName () const override
 

Detailed Description

Class SideCellSynchCopyFillPattern is a concrete implementation of the abstract base class SAMRAI::xfer::VariableFillPattern. It is used to calculate overlaps according to a pattern which limits overlaps to the side-centered ghost region surrounding a patch appropriate for "synchronizing" side-centered values at patch boundaries.

Member Function Documentation

◆ calculateOverlap()

Pointer< BoxOverlap< NDIM > > IBTK::SideSynchCopyFillPattern::calculateOverlap ( const SAMRAI::hier::BoxGeometry< NDIM > &  dst_geometry,
const SAMRAI::hier::BoxGeometry< NDIM > &  src_geometry,
const SAMRAI::hier::Box< NDIM > &  dst_patch_box,
const SAMRAI::hier::Box< NDIM > &  src_mask,
bool  overwrite_interior,
const SAMRAI::hier::IntVector< NDIM > &  src_offset 
) const
overridevirtual

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 the specified width surrounding the patch, excluding all edges and corners. The patch is identified by the argument dst_patch_box.

Parameters
dst_geometrygeometry object for destination box
src_geometrygeometry object for source box
dst_patch_boxbox for the destination patch
src_maskthe source mask, the box resulting from shifting the source box
overwrite_interiorcontrols whether or not to include the destination box interior in the overlap
src_offsetthe offset between source and destination index space (src + src_offset = dst)
Returns
pointer to the calculated overlap object

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

◆ getPatternName()

const std::string & IBTK::SideSynchCopyFillPattern::getPatternName ( ) const
overridevirtual

Returns a string name identifier "SIDE_SYNCH_COPY_FILL_PATTERN".

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

◆ getStencilWidth()

IntVector< NDIM > & IBTK::SideSynchCopyFillPattern::getStencilWidth ( )
overridevirtual

Returns the stencil width.

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


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