FineInterp Class Reference

replaces fine level data with interpolation of coarse level data. More...

#include <FineInterp.H>

Public Types
enum	BoundaryLimitType {   limitSlopes = 0, noSlopeLimiting, PCInterp, limitTangentialOnly,   NUM_LIMIT_TYPES }
	enumeration of the different ways we can handle interpolation near domain boundaries More...

Public Member Functions
	FineInterp ()
	~FineInterp ()
	FineInterp (const DisjointBoxLayout &a_fine_domain, const int &a_numcomps, const int &a_ref_ratio, const Box &a_fine_problem_domain)
	FineInterp (const DisjointBoxLayout &a_fine_domain, const int &a_numcomps, const int &a_ref_ratio, const ProblemDomain &a_fine_problem_domain)
void	define (const DisjointBoxLayout &a_fine_domain, const int &a_numcomps, const int &a_ref_ratio, const Box &a_fine_problem_domain)
void	define (const DisjointBoxLayout &a_fine_domain, const int &a_numcomps, const int &a_ref_ratio, const ProblemDomain &a_fine_problem_domain)
bool	isDefined () const
void	interpToFine (LevelData< FArrayBox > &a_fine_data, const LevelData< FArrayBox > &a_coarse_data, bool a_averageFromDest=false)
void	pwcinterpToFine (LevelData< FArrayBox > &a_fine_data, const LevelData< FArrayBox > &a_coarse_data, bool a_averageFromDest=false)
	Just do piecewise-constant interpolation. More...

Public Attributes
int	m_boundary_limit_type
	domain-boundary limiting behavior for this object More...

Static Public Attributes
static int	s_default_boundary_limit_type
	static variable to set default limiting behavior near domain boundaries More...

Protected Member Functions
void	interpGridData (BaseFab< Real > &a_fine, const BaseFab< Real > &a_coarse, const Box &a_coarsened_fine_box, int a_ref_ratio) const
void	pwcinterpGridData (BaseFab< Real > &a_fine, const BaseFab< Real > &a_coarse, const Box &a_coarsened_fine_box, int a_ref_ratio) const

Protected Attributes
bool	is_defined
int	m_ref_ratio
LevelData< FArrayBox >	m_coarsened_fine_data
ProblemDomain	m_coarse_problem_domain

Detailed Description

replaces fine level data with interpolation of coarse level data.

This class replaces data at a fine level of refinement with data interpolated from a coarser level of refinement. Interpolation is piecewise bi(tri)linear, with van Leer slopes if there is room for the stencil, with lower-order slopes if there isn't. See the design document.

Member Enumeration Documentation

BoundaryLimitType

enum FineInterp::BoundaryLimitType

enumeration of the different ways we can handle interpolation near domain boundaries

limitSlopes – turns on slope limiting in all directions near physical domain boundaries. This requires that ghost cell values be set to reasonable values noSlopeLimiting – turns off slope limiting near domain boundaries. This can produce new max/min values if you're unlucky. PCInterp – fall back to piecewise-constant interpolation near boundaries. This is safe, since you won't step out of bounds or create new max/min, but has lower accuracy limitTangentialOnly – limit slopes tangential to domain boundaries, fall back to Piecewise-constant interpolation (set slopes to 0) in the normal direction

Enumerator
limitSlopes
noSlopeLimiting
PCInterp
limitTangentialOnly
NUM_LIMIT_TYPES

Constructor & Destructor Documentation

FineInterp() [1/3]

FineInterp::FineInterp

(

)

Default constructor. User must subsequently call define().

~FineInterp()

FineInterp::~FineInterp

(

)

Destructor.

FineInterp() [2/3]

FineInterp::FineInterp	(	const DisjointBoxLayout &	a_fine_domain,
		const int &	a_numcomps,
		const int &	a_ref_ratio,
		const Box &	a_fine_problem_domain
	)

Defining constructor. Constructs a valid object. Equivalent to default construction followed by define().

{ Arguments:}\ a_fine_domain (not modified): the fine level domain.\ a_numcomps (not modified): the number of components.\ a_ref_ratio (not modified): the refinement ratio.\ a_fine_problem_domain (not modified): problem domain at the fine level.\

FineInterp() [3/3]

FineInterp::FineInterp	(	const DisjointBoxLayout &	a_fine_domain,
		const int &	a_numcomps,
		const int &	a_ref_ratio,
		const ProblemDomain &	a_fine_problem_domain
	)

Defining constructor. Constructs a valid object. Equivalent to default construction followed by define().

{ Arguments:}\ a_fine_domain (not modified): the fine level domain.\ a_numcomps (not modified): the number of components.\ a_ref_ratio (not modified): the refinement ratio.\ a_fine_problem_domain (not modified): problem domain at the fine level.\

Member Function Documentation

define() [1/2]

void FineInterp::define	(	const DisjointBoxLayout &	a_fine_domain,
		const int &	a_numcomps,
		const int &	a_ref_ratio,
		const Box &	a_fine_problem_domain
	)

Defines this object. Existing information is overriden.

{ Arguments:}\ a_fine_domain (not modified): the fine level domain.\ a_numcomps (not modified): the number of components.\ a_ref_ratio (not modified): the refinement ratio.\ a_fine_problem_domain (not modified): problem domain at the fine level.\

{ This:}\ —This object is modified.—

define() [2/2]

void FineInterp::define	(	const DisjointBoxLayout &	a_fine_domain,
		const int &	a_numcomps,
		const int &	a_ref_ratio,
		const ProblemDomain &	a_fine_problem_domain
	)

Defines this object. Existing information is overriden.

{ Arguments:}\ a_fine_domain (not modified): the fine level domain.\ a_numcomps (not modified): the number of components.\ a_ref_ratio (not modified): the refinement ratio.\ a_fine_problem_domain (not modified): problem domain at the fine level.\

{ This:}\ —This object is modified.—

isDefined()

bool FineInterp::isDefined

(

)

const

Returns true if this object was created with the defining constructor or if define() has been called.

{ This:}\ This object is not modified.

interpToFine()

void FineInterp::interpToFine	(	LevelData< FArrayBox > &	a_fine_data,
		const LevelData< FArrayBox > &	a_coarse_data,
		bool	a_averageFromDest = false
	)

Replaces a_fine_data with data interpolated from a_coarse_data. It is an error to call if not this->isDefined(). The domain of a_fine_data should be the same as the fine domain specified in the most recent call to define(). It is expected that the coarse and fine level's domains are properly nested. Both a_coarse_data and a_fine_data should have the same number of components specified in the most recent call to define().

{ Arguments:}\ a_fine_data (modified): fine data. \ a_coarse_data (not modified): coarse data. \ a_averageFromDest: if true, first average data from a_fine_data down to the resolution of a_coarse_data, then interp everything back up – necessary when the coarse grids don't cover the fine grid (i.e when flattening an AMR hierarchy to a single resolution). Default is false.

{ This:}\ Well, it's complicated. As far as the user is concerned, this object is not modified. See the design document if you care for details.

pwcinterpToFine()

void FineInterp::pwcinterpToFine	(	LevelData< FArrayBox > &	a_fine_data,
		const LevelData< FArrayBox > &	a_coarse_data,
		bool	a_averageFromDest = false
	)

Just do piecewise-constant interpolation.

interpGridData()

void FineInterp::interpGridData ( BaseFab< Real > &  a_fine, const BaseFab< Real > &  a_coarse, const Box &  a_coarsened_fine_box, int  a_ref_ratio  ) const

protected

pwcinterpGridData()

void FineInterp::pwcinterpGridData ( BaseFab< Real > &  a_fine, const BaseFab< Real > &  a_coarse, const Box &  a_coarsened_fine_box, int  a_ref_ratio  ) const

protected

Member Data Documentation

s_default_boundary_limit_type

int FineInterp::s_default_boundary_limit_type

static

static variable to set default limiting behavior near domain boundaries

This allows the user to define the default limiting behavior near domain boundaries. Near non-periodic domain boundaries, there are four options when computing interpolated values, corresponding to the four possible values in the BoundaryLimitType enum: limitSlopes – normal piecewise-linear interpolation, with the standard vanLeer limiting of slopes to prevent new maxima. This requires that ghost-cell values be set on the coarse data at domain boundaries. noSlopeLimiting – (default) piecewise-linear interpolation without limiting. This doesn't require coarse-level ghost cells be set, but may introduce new maxima/minima (or break positivity) for non-smooth functions. PCInterp – piecewise-constant interpolation. Safest bet, since it's max/min-preserving without requiring that ghost cells be set, but also least accurate.

limitTangentialOnly – limit slopes in the coordinate directions tangential to the boundary, while not limiting in the normal direction. This is useful when you don't have reasonable ghost-cell values but still need limiting.

The basic idea here is that the user can over-ride the default behavior in favor of what an application demands by resetting the static variable. The default behavior can then be over-ridden for an individual instantiation of the FineInterp class by modifying the member variable m_boundary_limit_type.

m_boundary_limit_type

int FineInterp::m_boundary_limit_type

domain-boundary limiting behavior for this object

default is to use whatever s_default_boundary_limit_type is at define time, but can be reset by the user at any time.

is_defined

bool FineInterp::is_defined

protected

m_ref_ratio

int FineInterp::m_ref_ratio

protected

m_coarsened_fine_data

LevelData<FArrayBox> FineInterp::m_coarsened_fine_data

protected

m_coarse_problem_domain

ProblemDomain FineInterp::m_coarse_problem_domain

protected

---

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

• FineInterp.H