---

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

// AMRNodeLevelMG.H
// adapted from AMRLevelMG by DTGraves, Tues, July 6, 1999
// petermc, Tues, Nov 28, 2000

#ifndef AMRNODELEVELMG_H
#define AMRNODELEVELMG_H

#include <stdlib.h>
#include <iostream>
#include <assert.h>
#include <math.h>
#include "REAL.H"
#include "IntVect.H"
#include "ProblemDomain.H"
#include "NodeFArrayBox.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "BaseFab.H"
#include "NodeLevelMG.H"
#include "NodeMGInterp.H"

// forward declaration of AMRNodeSolver
// C++ism:  don't need to #include AMRNodeSolver.H unless you have
// a data field that's an AMRNodeSolver
class AMRNodeSolver;

class AMRNodeLevelMG
{
public:    
  friend class AMRNodeSolver;



  AMRNodeLevelMG();


  AMRNodeLevelMG(const AMRNodeSolver* const a_parent, 
                 int a_level, 
                 const NodeMaskLevelOp* const a_opin);


  ~AMRNodeLevelMG();


  void define(const AMRNodeSolver* const a_parent, 
              int a_level, 
              const NodeMaskLevelOp* const a_opin);

              

  bool isDefined() const;


  Real computeResidualNorm(int a_normType) const;
  


  void setnumSmoothUp(int a_numSmoothUp);


  void setnumSmoothDown(int a_numSmoothDown);


  void setnumBottomGSRB(int a_numBottomGSRB);


  void setVerbose(bool a_verbose);



  void applyAMROperator(LevelData<NodeFArrayBox>& a_Lofphi,
                        Vector<LevelData<NodeFArrayBox> *>& a_phiLevel);
                        
  

  void computeAMRResidual(Vector<LevelData<NodeFArrayBox> *>& a_phiLevel,
                          const Vector<LevelData<NodeFArrayBox> *>& a_rhsLevel);


  void upSweep(Vector<LevelData<NodeFArrayBox> *>& a_phiLevel,
               const Vector<LevelData<NodeFArrayBox> *>& a_rhsLevel);


  void downSweep(Vector<LevelData<NodeFArrayBox> *>& a_phiLevel,
                 const Vector<LevelData<NodeFArrayBox> *>& a_rhsLevel);

protected:

  // returns normType norm of mfab 
  Real computeNorm(const LevelData<NodeFArrayBox>& a_mfinput, 
                   int a_normType) const;

  //use short V-cycle or NodeLevelMG's smoother to reduce
  //high wave numbers of residual
  void smooth(LevelData<NodeFArrayBox>& a_phi,
              const LevelData<NodeFArrayBox>& a_rhs);

  // project phiFine at coarse interior nodes to phi.
  void projectFineInterior(LevelData<NodeFArrayBox>& a_phi,
                           const LevelData<NodeFArrayBox>& a_phiFine);

  //delete internal memory and set pointers to null
  void clearMemory();

  //set default values.  does not deal with memory
  void setDefaultValues();

  // da boss
  const AMRNodeSolver* m_parent;

  // NodeLevelMG level solver object to relax on this level
  NodeLevelMG m_levelMG;

  // for interpolation
  NodeMGInterp m_mginterp;

  // has this AMRNodeLevelMG been defined yet?
  bool m_isDefined;

  bool m_verbose;

  // the grids at this level, coarsened
  DisjointBoxLayout m_coarsenedGrids;

  // residual
  LevelData<NodeFArrayBox> m_resid;

  // residual
  LevelData<NodeFArrayBox> m_residInterior;

  // correction
  LevelData<NodeFArrayBox> m_corr;

  // the infamous correction to the correction
  LevelData<NodeFArrayBox> m_dcorr;

  // L(phi)
  LevelData<NodeFArrayBox> m_LofPhi;

  // extra copy of solution
  LevelData<NodeFArrayBox> m_phiSave;

  // coarsened residual, on m_coarsenedGrids
  LevelData<NodeFArrayBox> m_residCoarsened;

  //
  int m_level;

  // mesh spacing
  Real m_dx;

  //
  NodeMaskLevelOp* m_levelOpPtr;

  //
  NodeMaskAverage m_averageOp;

  // physical domain at this level
  ProblemDomain m_domain;

  // the grids at the next finer level
  DisjointBoxLayout m_finerGrids;

  // the grids at the next finer level, coarsened
  DisjointBoxLayout m_coarsenedFineGrids;

  // zero on m_coarsenedFineGrids
  LevelData<NodeFArrayBox> m_zeroCoarsenedFiner;


  // interior boundary nodes of grids at this level
  LayoutData< Vector<IntVectSet> > m_IVSV;

  LayoutData< Vector<IntVectSet> > m_IVSVext;

  // interior boundary nodes of the coarsened grids at this level
  LayoutData< Vector<IntVectSet> > m_IVSVcoarsened;

  // interior boundary nodes of the coarsened grids at next finer level
  LayoutData< Vector<IntVectSet> > m_IVSVcoarsenedFine;

private:

  AMRNodeLevelMG& operator = (const AMRNodeLevelMG&);
  AMRNodeLevelMG(const AMRNodeLevelMG&);

};

#endif

---