LevelOp.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// 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.
//
// DTGraves, Mon, July 26, 1999

#ifndef _LEVELOP_H_
#define _LEVELOP_H_

#include <iostream>
#include <cmath>
#include <cassert>
#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

---