LevelMG.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  V \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
// CHOMBO Copyright (c) 2000-2004, The Regents of the University of
// California, through Lawrence Berkeley National Laboratory (subject to
// receipt of any required approvals from U.S. Dept. of Energy).  All
// rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// (2) Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
// Dept. of Energy nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// You are under no obligation whatsoever to provide any bug fixes,
// patches, or upgrades to the features, functionality or performance of
// the source code ("Enhancements") to anyone; however, if you choose to
// make your Enhancements available either publicly, or directly to
// Lawrence Berkeley National Laboratory, without imposing a separate
// written license agreement for such Enhancements, then you hereby grant
// the following license: a non-exclusive, royalty-free perpetual license
// to install, use, modify, prepare derivative works, incorporate into
// other computer software, distribute, and sublicense such Enhancements or
// derivative works thereof, in binary and source code form.
//
// TRADEMARKS. Product and company names mentioned herein may be the
// trademarks of their respective owners.  Any rights not expressly granted
// herein are reserved.
//

// DTGraves, Fri, July 16, 1999

#ifndef _LEVELMG_H_
#define _LEVELMG_H_

#include <iostream>
#include <cmath>
#include "SPACE.H"
#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

---