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

Class CartSideDoubleDivPreservingRefine is a concrete SAMRAI::xfer::RefinePatchStrategy which prolongs side-centered double precision patch data via conservative linear interpolation with divergence- and curl-preserving corrections. More...

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

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

Public Member Functions

 CartSideDoubleDivPreservingRefine (int u_dst_idx, int u_src_idx, int indicator_idx, SAMRAI::tbox::Pointer< SAMRAI::xfer::RefineOperator< NDIM > > refine_op, SAMRAI::tbox::Pointer< SAMRAI::xfer::CoarsenOperator< NDIM > > coarsen_op, double fill_time, SAMRAI::xfer::RefinePatchStrategy< NDIM > *phys_bdry_op)
 Constructor.
 
virtual ~CartSideDoubleDivPreservingRefine ()=default
 Virtual destructor.
 
- Public Member Functions inherited from SAMRAI::xfer::RefinePatchStrategy< NDIM >
virtual void preprocessRefineBoxes (hier::Patch< NDIM > &fine, const hier::Patch< NDIM > &coarse, const hier::BoxList< NDIM > &fine_boxes, const hier::IntVector< NDIM > &ratio)
 
virtual void postprocessRefineBoxes (hier::Patch< NDIM > &fine, const hier::Patch< NDIM > &coarse, const hier::BoxList< NDIM > &fine_boxes, const hier::IntVector< NDIM > &ratio)
 

Static Public Attributes

static const int REFINE_OP_STENCIL_WIDTH = 4
 The number of required ghost cells. More...
 

Implementation of SAMRAI::xfer::RefinePatchStrategy interface.

virtual void setPhysicalBoundaryConditions (SAMRAI::hier::Patch< NDIM > &patch, double fill_time, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill) override
 
virtual SAMRAI::hier::IntVector< NDIM > getRefineOpStencilWidth () const override
 
virtual void preprocessRefine (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::Box< NDIM > &fine_box, const SAMRAI::hier::IntVector< NDIM > &ratio) override
 
virtual void postprocessRefine (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::Box< NDIM > &fine_box, const SAMRAI::hier::IntVector< NDIM > &ratio) override
 

Detailed Description

Class CartSideDoubleDivPreservingRefine is a concrete SAMRAI::xfer::RefinePatchStrategy which prolongs side-centered double precision patch data via conservative linear interpolation with divergence- and curl-preserving corrections.

Member Function Documentation

◆ getRefineOpStencilWidth()

IntVector< NDIM > IBTK::CartSideDoubleDivPreservingRefine::getRefineOpStencilWidth ( ) const
overridevirtual

Function to return maximum stencil width needed over user-defined data interpolation operations. This is needed to determine the correct interpolation data dependencies.

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

◆ postprocessRefine()

void IBTK::CartSideDoubleDivPreservingRefine::postprocessRefine ( SAMRAI::hier::Patch< NDIM > &  fine,
const SAMRAI::hier::Patch< NDIM > &  coarse,
const SAMRAI::hier::Box< NDIM > &  fine_box,
const SAMRAI::hier::IntVector< NDIM > &  ratio 
)
overridevirtual

Function to perform user-defined preprocess data refine operations. This member function is called after standard refine operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The postprocess function refines data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

Parameters
fineFine patch containing destination data.
coarseCoarse patch containing source data.
fine_boxBox region on fine patch into which data is refined.
ratioInteger vector containing ratio relating index space between coarse and fine patches.

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

◆ preprocessRefine()

void IBTK::CartSideDoubleDivPreservingRefine::preprocessRefine ( SAMRAI::hier::Patch< NDIM > &  fine,
const SAMRAI::hier::Patch< NDIM > &  coarse,
const SAMRAI::hier::Box< NDIM > &  fine_box,
const SAMRAI::hier::IntVector< NDIM > &  ratio 
)
overridevirtual

Function to perform user-defined preprocess data refine operations. This member function is called before standard refine operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The preprocess function refines data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

Parameters
fineFine patch containing destination data.
coarseCoarse patch containing source data.
fine_boxBox region on fine patch into which data is refined.
ratioInteger vector containing ratio relating index space between coarse and fine patches.

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

◆ setPhysicalBoundaryConditions()

void IBTK::CartSideDoubleDivPreservingRefine::setPhysicalBoundaryConditions ( SAMRAI::hier::Patch< NDIM > &  patch,
double  fill_time,
const SAMRAI::hier::IntVector< NDIM > &  ghost_width_to_fill 
)
overridevirtual

Function to set data associated with the given list of patch data indices at patch boundaries that intersect the physical domain boundary. The specific boundary conditions are determined by the user. The patch data components set in this routine correspond to the scratch components specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

Parameters
patchPatch on which to fill boundary data.
fill_timeDouble simulation time for boundary filling.
ghost_width_to_fillInteger vector describing maximum ghost width to fill over all registered scratch components.

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

Member Data Documentation

◆ REFINE_OP_STENCIL_WIDTH

const int IBTK::CartSideDoubleDivPreservingRefine::REFINE_OP_STENCIL_WIDTH = 4
static

The number of required ghost cells.

Note
This value is chosen to allow refinement ratios up to 4. A larger value would be necessary for refinement ratios greater than 4.

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