---

GenAMRLevelMG.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 _GENAMRLEVELMG_H_
#define _GENAMRLEVELMG_H_

#include <stdlib.h>
#include <iostream>
#include <assert.h>
#include <math.h>

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "LevelFluxRegister.H"
#include "BaseFab.H"
#include "Copier.H"
#include "CoarseAverage.H"

#include "GenMGInterp.H"
#include "GenAMRLevelMGOp.H"
#include "GenLevelMG.H"

template <class T> class GenAMRSolver;


template <class T> class GenAMRLevelMG
{
public:
  friend class GenAMRSolver<T>;

  GenAMRLevelMG();


  GenAMRLevelMG(const GenAMRSolver<T>* const    a_parent,
                int                             a_level,
                const GenAMRLevelMGOp<T>* const a_opin,
                int                             a_ncomp = 1);

  ~GenAMRLevelMG();

  bool isDefined() const;


  void define(const GenAMRSolver<T>* const    a_parent,
              int                             a_level,
              const GenAMRLevelMGOp<T>* const a_opin,
              int                             a_ncomp = 1);


  void setnumSmoothUp(int a_numSmoothUp);


  void setnumSmoothDown(int a_numSmoothDown);


  void applyAMROperator(Vector<T *>& a_phiLevel,
                        T&           a_LOfPhi);


  void applyAMROperatorHphys(Vector<T *>& a_phiLevel,
                             T&           a_LOfPhi);


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


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


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


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


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


  Vector<Real> computeResidualNorm(int a_normType) const;

  //
  GenAMRLevelMGOp<T>* levelOpPtr() const;

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

protected:
  // use short v-cycle or levelmg's smoother to reduce
  // high wave numbers of residual
  void smooth(T&       a_soln,
              const T& a_rhs);

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

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

  /*
    reflux enforces flux-matching from finer levels.
    Steps involved:
    a)initialize flux register with coarse flux
    b)increment flux register with sum of fine fluxes
    b)modify solution with flux diffrence
  */
  void reflux(Vector<T *>& a_phiLevel,
              T&           a_LOfPhi);

  /*
    Fill fluxregisters with coarse flux
  */
  void initFRCoarse(Vector<T *>& a_phiLevel);

  /*
    increment fluxregisters with fine flux
  */
  void incrementFRFine(Vector<T *>& a_phiLevel);

  // da boss
  const GenAMRSolver<T>* m_parent;

  // LevelMG level solver object to relax on this level
  GenLevelMG<T> m_levelMG;

  // for interpolation
  GenMGInterp<T> m_mginterp;

  // flux register with next coarser level
  LevelFluxRegister m_levfluxreg;

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

  DisjointBoxLayout m_coarsenedGrids;
  // residual
  T m_resid;

  // correction
  T m_corr;

  // the infamous correction to the correction
  T m_dcorr;

  // L(phi)
  T m_lofPhi;

  // extra copy of solution
  T m_phiSave;

  T m_resC;

  // Copier that operates for moving  coarsened residual to
  // coarse level grid space.
  Copier m_residualCopier;

  // Copier that's used for exchange on the fine grid data
  // before fine flux register data is incremented.
  Copier m_fineExchangeCopier;

  //
  int m_level;

  //
  GenAMRLevelMGOp<T>* m_levelopPtr;

  //
  CoarseAverage m_averageOp;

  bool m_arrayViewVerbose;

private:
  void setArrayViewVerbose(bool a_verbosity);

  GenAMRLevelMG<T>(const GenAMRLevelMG<T>&) {};
  void operator= (const GenAMRLevelMG<T>&) {};
};

#include "GenAMRLevelMGImplem.H"

#endif

---