LevelOp.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  V \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
// CHOMBO Copyright (c) 2000-2004, The Regents of the University of
// California, through Lawrence Berkeley National Laboratory (subject to
// receipt of any required approvals from U.S. Dept. of Energy).  All
// rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// (2) Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
// Dept. of Energy nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// You are under no obligation whatsoever to provide any bug fixes,
// patches, or upgrades to the features, functionality or performance of
// the source code ("Enhancements") to anyone; however, if you choose to
// make your Enhancements available either publicly, or directly to
// Lawrence Berkeley National Laboratory, without imposing a separate
// written license agreement for such Enhancements, then you hereby grant
// the following license: a non-exclusive, royalty-free perpetual license
// to install, use, modify, prepare derivative works, incorporate into
// other computer software, distribute, and sublicense such Enhancements or
// derivative works thereof, in binary and source code form.
//
// TRADEMARKS. Product and company names mentioned herein may be the
// trademarks of their respective owners.  Any rights not expressly granted
// herein are reserved.
//

// DTGraves, Mon, July 26, 1999

#ifndef _LEVELOP_H_
#define _LEVELOP_H_

#include <iostream>
#include <cmath>
#include "SPACE.H"
#include <cstdlib>

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "FArrayBox.H"
#include "LoHiSide.H"
#include "ProblemDomain.H"


class LevelOp
{
public:
  LevelOp()
  {
  }

  virtual ~LevelOp()
  {
  }


  virtual void define(
                      const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_baseBAPtr,
                      Real                     a_dxLevel,
                      int                      a_refRatio,
                      const ProblemDomain&     a_domain,
                      bool                     a_homogeneousOnly,
                      int                      a_ncomp = 1) = 0;


  virtual void define(const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_baseBAPtr,
                      Real                     a_dxLevel,
                      int                      a_refRatio,
                      const Box&               a_domain,
                      bool                     a_homogeneousOnly,
                      int                      a_ncomp = 1) = 0;


  virtual void define(
                      const LevelOp* a_opfine,
                      int            a_reftoFine) = 0;


  virtual void CFInterp(
                        LevelData<FArrayBox>&       a_phif,
                        const LevelData<FArrayBox>& a_phic) = 0;


  virtual void homogeneousCFInterp(LevelData<FArrayBox>& a_phif) = 0;


  virtual LevelOp* new_levelop() const = 0;

  virtual bool isDefined() const = 0;


  virtual void smooth(
                      LevelData<FArrayBox>&       a_phi,
                      const LevelData<FArrayBox>& a_rhs) = 0;


  virtual void levelPreconditioner(LevelData<FArrayBox>&       a_phihat,
                                   const LevelData<FArrayBox>& a_rhshat) = 0;


  virtual void applyOpI(LevelData<FArrayBox>&       a_phi,
                        const LevelData<FArrayBox>* a_phicPtr,
                        LevelData<FArrayBox>&       a_lofPhi) = 0;


  virtual void applyOpIcfHphys(LevelData<FArrayBox>&       a_phi,
                               const LevelData<FArrayBox>* a_phicPtr,
                               LevelData<FArrayBox>&       a_lofPhi)  = 0;


  virtual void applyOpHcfIphys(LevelData<FArrayBox>& a_phi,
                               LevelData<FArrayBox>& a_lofPhi) = 0;


  virtual void applyOpH(LevelData<FArrayBox>& a_phi,
                        LevelData<FArrayBox>& a_lofPhi) = 0;


  virtual void bottomSmoother(LevelData<FArrayBox>&       a_phi,
                              const LevelData<FArrayBox>& a_rhs) = 0;


  virtual void getFlux(
                       FArrayBox&       a_fineFlux,
                       const FArrayBox& a_data,
                       const DataIndex& a_datInd,
                       int              a_dir) = 0;


  virtual void setConvergenceMetric(Real a_metric, int a_comp) = 0;
};

#endif

---