Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
amrex::InterpFaceRegister Class Reference

InterpFaceRegister is a coarse/fine boundary register for interpolation of face data at the coarse/fine boundary. More...

#include <AMReX_InterpFaceRegister.H>

Public Member Functions

 InterpFaceRegister ()=default
 InterpFaceRegister (BoxArray const &fba, DistributionMapping const &fdm, Geometry const &fgeom, IntVect const &ref_ratio)
 InterpFaceRegister Constructor.
void define (BoxArray const &fba, DistributionMapping const &fdm, Geometry const &fgeom, IntVect const &ref_ratio)
 Defines an InterpFaceRegister object.
iMultiFab const & mask (Orientation face) const
 Returns a coarse/fine boundary mask for a given face.
void interp (Array< MultiFab *, 3 > const &fine, Array< MultiFab const *, 3 > const &crse, int scomp, int ncomp)
 Interpolates from coarse to fine data at coarse/fine boundaries.

Detailed Description

InterpFaceRegister is a coarse/fine boundary register for interpolation of face data at the coarse/fine boundary.

Constructor & Destructor Documentation

◆ InterpFaceRegister() [1/2]

amrex::InterpFaceRegister::InterpFaceRegister ( )
default

◆ InterpFaceRegister() [2/2]

amrex::InterpFaceRegister::InterpFaceRegister ( BoxArray const & fba,
DistributionMapping const & fdm,
Geometry const & fgeom,
IntVect const & ref_ratio )

InterpFaceRegister Constructor.

Parameters
fbaThe fine level BoxArray
fdmThe fine level DistributionMapping
fgeomThe fine level Geometry
ref_ratioThe refinement ratio

Member Function Documentation

◆ define()

void amrex::InterpFaceRegister::define ( BoxArray const & fba,
DistributionMapping const & fdm,
Geometry const & fgeom,
IntVect const & ref_ratio )

Defines an InterpFaceRegister object.

Parameters
fbaThe fine level BoxArray
fdmThe fine level DistributionMapping
fgeomThe fine level Geometry
ref_ratioThe refinement ratio

◆ interp()

void amrex::InterpFaceRegister::interp ( Array< MultiFab *, 3 > const & fine,
Array< MultiFab const *, 3 > const & crse,
int scomp,
int ncomp )

Interpolates from coarse to fine data at coarse/fine boundaries.

Parameters
fineArray of pointers to the fine data.
crseArray of const pointers to the coarse data.
scompStarting component
ncompNumber of components

◆ mask()

iMultiFab const & amrex::InterpFaceRegister::mask ( Orientation face) const

Returns a coarse/fine boundary mask for a given face.

This returns an iMultiFab at the coarse/fine boundary of a given face. The data are only defined on one face of each box in the fine level BoxArray passed to the InterpFaceRegister constructor. It has two possible values: 1 for coarse/fine boundary and 0 for fine/fine boundary including non-periodic physical domain face.

Parameters
faceThe face

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