LevelMG.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, Fri, July 16, 1999

#ifndef _LEVELMG_H_
#define _LEVELMG_H_  

#include <iostream>
#include <cmath>
#include <cassert>
#include <cstdlib>

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "FArrayBox.H"
#include "LevelData.H"
#include "CoarseAverage.H"
#include "LevelOp.H"
#include "ProblemDomain.H"


class LevelMG 
{
public:
  bool isDefined() const;

  LevelMG();

  LevelMG(const DisjointBoxLayout& a_ba,
          const DisjointBoxLayout* a_baseBaPtr, 
          Real                     a_dxLevel, 
          int                      a_refRatio,
          const  Box&              a_domain,
          int                      a_nCoarserLevels, 
          const LevelOp* const     a_opin,
          int                      a_ncomp=1);

  LevelMG(const DisjointBoxLayout& a_ba,
          const DisjointBoxLayout* a_baseBaPtr, 
          Real                     a_dxLevel, 
          int                      a_refRatio,
          const ProblemDomain&     a_domain,
          int                      a_nCoarserLevels, 
          const LevelOp* const     a_opin,
          int                      a_ncomp=1);

  void define(const DisjointBoxLayout& a_ba,
              const DisjointBoxLayout* a_baseBaPtr, 
              Real                     a_dxLevel,
              int                      a_refRatio,
              const Box&               a_domain,
              int                      a_nCoarserLevels, 
              const LevelOp* const     a_opin,
              int                      a_ncomp=1);

  void define(
              const DisjointBoxLayout& a_ba,
              const DisjointBoxLayout* a_baseBaPtr, 
              Real                     a_dxLevel, 
              int                      a_refRatio,
              const ProblemDomain&     a_domain,
              int                      a_nCoarserLevels, 
              const LevelOp* const     a_opin,
              int                      a_ncomp);

  void define(const LevelMG&       a_level,
              int                  a_refCoarse,
              const LevelOp* const a_opin);

  LevelMG(const LevelMG& a_level,
          int            a_refCoarse,
          const LevelOp* a_opin);

  ~LevelMG();


  void mgRelax(LevelData<FArrayBox> & a_soln,
               const LevelData<FArrayBox> & a_rhs,
               bool bottomsolveflag);

  void setNumBottomGSRB(int a_numBottomGSRB)
  {
    m_numBottomGSRB = a_numBottomGSRB;
  }

  void setNumSmoothUp(int a_numSmoothUp);

  
  void setNumSmoothDown(int a_numSmoothDown);

  LevelOp* levelOpPtr();

  LevelMG* lCoarsePtr();

  void setConvergenceMetric(Real a_metric, int a_comp);

protected:
  void setDefaultValues();
  void clearMemory();

  bool m_isDefined;

  //
  LevelData<FArrayBox>  m_resid;

  //
  LevelData<FArrayBox>  m_crseResid;

  //
  LevelData<FArrayBox>  m_crseCorr;

  //
  DisjointBoxLayout m_ba;

  //
  DisjointBoxLayout m_baCoarsened;

  //
  const DisjointBoxLayout* m_baseBaPtr;

  //
  Real m_dxLevel;

  //
  ProblemDomain m_domain;

  //
  int m_nCoarserLevels;

  //
  LevelMG* m_lCoarsePtr;

  //
  LevelOp* m_levelopPtr;

  //
  int m_numBottomGSRB;

  //
  int m_numSmoothUp;

  //
  int m_numSmoothDown;

  //
  int m_refToCoar;

  //
  CoarseAverage m_averageOp;

private:
  void crseCorrect(LevelData<FArrayBox>&       a_fine,
                   const LevelData<FArrayBox>& a_crse,
                   int                         a_refRat);

  void operator=(const LevelMG& a_levmgin){};
  LevelMG(const LevelMG& a_levmgin) {};
};

#endif

---