AMRLevelMG.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, Tues, July 6, 1999

#ifndef _AMRLEVELMG_H_
#define _AMRLEVELMG_H_

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "FArrayBox.H"
#include "LevelData.H"
#include "LevelFluxRegister.H"
#include "LevelMG.H"
#include "MGInterp.H"
#include "Copier.H"

// forward declaration of AMRSolver
class AMRSolver;


class AMRLevelMG
{
public:
  friend class AMRSolver;

  AMRLevelMG();

  ~AMRLevelMG();

  AMRLevelMG(const AMRSolver* const a_parent,
             int                    a_level,
             const LevelOp* const   a_opin,
             int                    a_ncomp=1);


  void define(const AMRSolver* const a_parent,
              int                    a_level,
              const LevelOp* const   a_opin,
              int                    a_ncomp=1);

  void setNumSmoothUp(int a_numSmoothUp);

  void setNumSmoothDown(int a_numSmoothDown);


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


  void applyAMROperatorHphys(Vector<LevelData<FArrayBox> *>& a_phiLevel,
                             LevelData<FArrayBox>&           a_LofPhi);

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


  void computeAMRResidualHphys(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
                               const Vector<LevelData<FArrayBox> *>& a_rhsLevel);

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

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

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

  Vector<Real> computeResidualNorm(int normType) const;

  LevelOp* levelOpPtr() const;

  bool isDefined() const;

  Vector<Real> computeNorm(const LevelData<FArrayBox>& a_mfinput,
                           int                         a_normType) const;


  void setConvergenceMetric(Real a_metric, int a_comp);

protected:

  void smooth(LevelData<FArrayBox>&       a_soln,
              const LevelData<FArrayBox>& a_rhs);


  void clearMemory();


  void setDefaultValues();


  void reflux(Vector<LevelData<FArrayBox> *>& a_phiLevel,
              LevelData<FArrayBox>&           a_Lofphi);


  void initFRCoarse(Vector<LevelData<FArrayBox> *>& a_phiLevel);


  void incrementFRFine(Vector<LevelData<FArrayBox> *>& a_phiLevel);


  const AMRSolver* m_parent;


  LevelMG m_levelMG;


  MGInterp m_mginterp;


  LevelFluxRegister m_levfluxreg;


  bool m_isDefined;


  DisjointBoxLayout m_coarsenedGrids;


  LevelData<FArrayBox> m_resid;


  LevelData<FArrayBox> m_corr;


  LevelData<FArrayBox> m_dcorr;


  LevelData<FArrayBox> m_lofPhi;


  LevelData<FArrayBox> m_phiSave;


  LevelData<FArrayBox> m_resC;


  Copier m_residualCopier;

  Copier m_fineExchangeCopier;


  int m_level;


  LevelOp* m_levelopPtr;

  CoarseAverage m_averageOp;

  bool m_arrayViewVerbose;

private:
  void  setArrayViewVerbose(bool a_verbosity);
  AMRLevelMG& operator = (const AMRLevelMG&);
  AMRLevelMG(const AMRLevelMG&);
};

#endif

---