---

NodeMaskLevelOp.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.
//

// adapted from LevelOp by DTGraves, Mon, July 26, 1999
// NodeLevelOp by petermc, Tue, Nov 28, 2000
// petermc, 22 Jun 2001 for mask

#ifndef NODEMASKLEVELOP_H
#define NODEMASKLEVELOP_H

#include <iostream>
#include <math.h>
#include <assert.h>
#include <stdlib.h>
#include "REAL.H"
#include "ProblemDomain.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "NodeFArrayBox.H"
#include "IntVectSet.H"


class NodeMaskLevelOp
{

public:



  NodeMaskLevelOp() {};


  // "= 0" is a C++ism meaning that this is a _pure_ virtual function.
  virtual NodeMaskLevelOp* new_levelop() const = 0;
    

  virtual ~NodeMaskLevelOp(){};


  virtual void define(
                      const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_gridsCoarsePtr,
                      Real                     a_dx,
                      int                      a_refToCoarse,
                      const ProblemDomain&     a_domain,
                      bool                     a_homogeneousOnly = false,
                      int                      a_ncomp = 1
                      ) = 0;
  
  virtual void define(
                      const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_gridsCoarsePtr,
                      Real                     a_dx,
                      int                      a_refToCoarse,
                      const Box&               a_domain,
                      bool                     a_homogeneousOnly = false,
                      int                      a_ncomp = 1
                      ) = 0;
  


  virtual void define(
                      const NodeMaskLevelOp* a_opfine,
                      int                    a_refToFine
                      ) = 0;

              


  virtual bool isDefined() const = 0;



  virtual void CFInterp(LevelData<NodeFArrayBox>&       a_phi,
                        const LevelData<NodeFArrayBox>& a_phiCoarse,
                        bool                            a_inhomogeneous
                        ) = 0;


  virtual void homogeneousCFInterp(
                                   LevelData<NodeFArrayBox>& a_phi
                                   ) = 0;
  

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

  virtual void residualI(LevelData<NodeFArrayBox>&       a_resid,
                         LevelData<NodeFArrayBox>&       a_phi,
                         const LevelData<NodeFArrayBox>* a_phiCoarsePtr,
                         const LevelData<NodeFArrayBox>& a_rhs) = 0;


  virtual void residualH(LevelData<NodeFArrayBox>&       a_resid,
                         LevelData<NodeFArrayBox>&       a_phi,
                         const LevelData<NodeFArrayBox>& a_rhs) = 0;


  virtual void residualIcfHphys(LevelData<NodeFArrayBox>&       a_resid,
                                LevelData<NodeFArrayBox>&       a_phi,
                                const LevelData<NodeFArrayBox>* a_phiCoarsePtr,
                                const LevelData<NodeFArrayBox>& a_rhs) = 0;


  virtual void residualHcfIphys(LevelData<NodeFArrayBox>&       a_resid,
                                LevelData<NodeFArrayBox>&       a_phi,
                                const LevelData<NodeFArrayBox>& a_rhs) = 0;


  virtual void applyOpI(
                        LevelData<NodeFArrayBox>&       a_LofPhi,
                        LevelData<NodeFArrayBox>&       a_phi,
                        const LevelData<NodeFArrayBox>* a_phiCoarsePtr
                        ) = 0;


  virtual void applyOpH(
                        LevelData<NodeFArrayBox>& a_LofPhi,
                        LevelData<NodeFArrayBox>& a_phi
                        ) = 0;


  virtual void applyOpIcfHphys(
                               LevelData<NodeFArrayBox>&       a_LofPhi,
                               LevelData<NodeFArrayBox>&       a_phi,
                               const LevelData<NodeFArrayBox>* a_phiCoarsePtr
                               )  = 0;


  virtual void applyOpHcfIphys(LevelData<NodeFArrayBox>& a_LofPhi,
                               LevelData<NodeFArrayBox>& a_phi
                               ) = 0;
  

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



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

  // these have to be public because smoother needs them for norms

  // physical domain of current level
  ProblemDomain m_domain;

  // exterior boundary nodes
  LayoutData< Vector<IntVectSet> > m_IVSVext;
};

#endif

---