AMRLevelMG.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, 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

---