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

Class CartCellDoubleLinearCFInterpolation is a concrete SAMRAI::xfer::RefinePatchStrategy which sets coarse-fine interface ghost cell values for cell-centered double precision patch data via linear interpolation in the normal and tangential directions at coarse-fine interfaces. More...

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

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

Public Member Functions

 CartCellDoubleLinearCFInterpolation ()=default
 Constructor.
 
 ~CartCellDoubleLinearCFInterpolation ()
 Destructor.
 
SAMRAI::xfer::RefinePatchStrategy interface.
void setPhysicalBoundaryConditions (SAMRAI::hier::Patch< NDIM > &patch, double fill_time, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill) override
 
SAMRAI::hier::IntVector< NDIM > getRefineOpStencilWidth () const override
 
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
 
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
 
- Public Member Functions inherited from IBTK::CoarseFineBoundaryRefinePatchStrategy
 CoarseFineBoundaryRefinePatchStrategy ()=default
 Constructor.
 
virtual ~CoarseFineBoundaryRefinePatchStrategy ()=default
 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)
 

Extension of SAMRAI::xfer::RefinePatchStrategy interface to support more

complex coarse-fine interface discretizations.

void setConsistentInterpolationScheme (bool consistent_type_2_bdry) override
 
void setPatchDataIndex (int patch_data_index) override
 Reset the patch data index operated upon by this class.
 
void setPatchDataIndices (const std::set< int > &patch_data_indices) override
 Reset the patch data indices operated upon by this class.
 
void setPatchDataIndices (const SAMRAI::hier::ComponentSelector &patch_data_indices) override
 Reset the patch data indices operated upon by this class.
 
void setPatchHierarchy (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy) override
 
void clearPatchHierarchy () override
 
void computeNormalExtension (SAMRAI::hier::Patch< NDIM > &patch, const SAMRAI::hier::IntVector< NDIM > &ratio, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill) override
 

Detailed Description

Class CartCellDoubleLinearCFInterpolation is a concrete SAMRAI::xfer::RefinePatchStrategy which sets coarse-fine interface ghost cell values for cell-centered double precision patch data via linear interpolation in the normal and tangential directions at coarse-fine interfaces.

Member Function Documentation

◆ clearPatchHierarchy()

void IBTK::CartCellDoubleLinearCFInterpolation::clearPatchHierarchy ( )
overridevirtual

Clear the patch hierarchy used in constructing coarse-fine interface boundary boxes.

Implements IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ computeNormalExtension()

void IBTK::CartCellDoubleLinearCFInterpolation::computeNormalExtension ( SAMRAI::hier::Patch< NDIM > &  patch,
const SAMRAI::hier::IntVector< NDIM > &  ratio,
const SAMRAI::hier::IntVector< NDIM > &  ghost_width_to_fill 
)
overridevirtual

Compute the normal extension of fine data at coarse-fine interfaces.

Implements IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ getRefineOpStencilWidth()

IntVector< NDIM > IBTK::CartCellDoubleLinearCFInterpolation::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 IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ postprocessRefine()

void IBTK::CartCellDoubleLinearCFInterpolation::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 postprocess 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 must refine 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 IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ preprocessRefine()

void IBTK::CartCellDoubleLinearCFInterpolation::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 must refine 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.

Presently, the implementation does nothing.

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 IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ setConsistentInterpolationScheme()

void IBTK::CartCellDoubleLinearCFInterpolation::setConsistentInterpolationScheme ( bool  consistent_type_2_bdry)
overridevirtual

Whether or not to employ a consistent interpolation scheme at "Type 2" coarse-fine interface ghost cells.

Implements IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ setPatchHierarchy()

void IBTK::CartCellDoubleLinearCFInterpolation::setPatchHierarchy ( SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >  hierarchy)
overridevirtual

Set the patch hierarchy used in constructing coarse-fine interface boundary boxes.

Implements IBTK::CoarseFineBoundaryRefinePatchStrategy.

◆ setPhysicalBoundaryConditions()

void IBTK::CartCellDoubleLinearCFInterpolation::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 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.

Presently, the implementation does nothing.

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 IBTK::CoarseFineBoundaryRefinePatchStrategy.


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