class FineInterp

replaces fine level data with interpolation of coarse level data.

Inheritance:

FineInterp


public members:

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)

Documentation

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.

FineInterp ()
Default constructor. User must subsequently call define().

~FineInterp ()
Destructor.

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 (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.

void 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.---

void 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.---

bool 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.

void interpToFine (LevelData< FArrayBox >& a_fine_data, const LevelData< FArrayBox >& a_coarse_data)
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.

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.


this class has no child classes.

alphabetic index hierarchy of classes


Chombo

Copyright Notice

This software is copyright (C) by the Lawrence Berkeley National Laboratory. Permission is granted to reproduce this software for non-commercial purposes provided that this notice is left intact.

It is acknowledged that the U.S. Government has rights to this software under Contract DE-AC03-765F00098 between the U.S. Department of Energy and the University of California.

This software is provided as a professional and academic contribution for joint exchange. Thus it is experimental, is provided ``as is'', with no warranties of any kind whatsoever, no support, no promise of updates, or printed documentation. By using this software, you acknowledge that the Lawrence Berkeley National Laboratory and Regents of the University of California shall have no liability with respect to the infringement of other copyrights by any part of this software.