AMRSolver.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 _AMRSOLVER_H_
#define _AMRSOLVER_H_

#include <cstdlib>
#include <cmath>
#include <iostream>
#include "SPACE.H"

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "FArrayBox.H"
#include "Vector.H"
#include "IntVectSet.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "AMRLevelMG.H"
#include "LevelSolver.H"
#include "ProblemDomain.H"


class AMRSolver
{
public:
  friend class AMRLevelMG;


  AMRSolver();


  AMRSolver(const Vector<DisjointBoxLayout>& a_gridsLevel,
            const Vector<Box>&               a_domainLevel,
            const Vector<Real>&              a_dxLevel,
            const Vector<int>&               a_refRatio,
            int                              a_numLevels,
            int                              a_lBase,
            const LevelOp* const             a_opin,
            int                              a_ncomp = 1,
            bool                             a_limitCoarsening = false);


  AMRSolver(const Vector<DisjointBoxLayout>& a_gridsLevel,
            const Vector<ProblemDomain>&     a_domainLevel,
            const Vector<Real>&              a_dxLevel,
            const Vector<int>&               a_refRatio,
            int                              a_numLevels,
            int                              a_lBase,
            const LevelOp* const             a_opin,
            int                              a_ncomp = 1,
            bool                             a_limitCoarsening = false);


  virtual void define(const Vector<DisjointBoxLayout>& a_gridsLevel,
                      const Vector<Box>&                    a_domainLevel,
                      const Vector<Real>&                   a_dxLevel,
                      const Vector<int>&                    a_refRatio,
                      int                                   a_numLevels,
                      int                                   a_lBase,
                      const LevelOp* const                  a_opin,
                      int                                   a_ncomp=1,
                      bool                                  a_limitCoarsening = false);


  virtual void
  define(const Vector<DisjointBoxLayout>& a_gridsLevel,
         const Vector<ProblemDomain>&     a_domainLevel,
         const Vector<Real>&              a_dxLevel,
         const Vector<int>&               a_refRatio,
         int                              a_numLevels,
         int                              a_lBase,
         const LevelOp* const             a_opin,
         int                              a_ncomp=1,
         bool                             a_limitCoarsening = false);

  virtual ~AMRSolver();

  bool isDefined() const;

  void setNumSmoothUp(int a_numSmoothUp);

  void setNumSmoothDown(int a_numSmoothDown);

  void setTolerance(Real a_tolerance);


  void setOperatorTolerance(Real a_operatorTolerance);

  void setMaxIter(int a_maxIter);


  // added by Dan M, 3/24/2000
  void setMinIter(int a_minIter);


  void setNumVCyclesBottom(int a_numVCycleBottom);


  void setConvergenceMetric(Real a_metric, int a_comp);

  void setNormType(int a_normType);


  void solveAMR(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
                const Vector<LevelData<FArrayBox> *>& a_rhsLevel,
                bool a_initializePhiToZero = true);


  virtual void AMRVCycleMG(Vector<LevelData<FArrayBox> *>&       a_corrLevel,
                           const Vector<LevelData<FArrayBox> *>& a_residLevel);


  Vector<Real> computeResidualNorm(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
                                   const Vector<LevelData<FArrayBox> *>& a_rhsLevel,
                                   int                                   a_normType);


  Vector<Real> computeResidualNorm(Vector<LevelData<FArrayBox> *>&       a_residLevel,
                                   Vector<LevelData<FArrayBox> *>&       a_phiLevel,
                                   const Vector<LevelData<FArrayBox> *>& a_rhsLevel,
                                   int                                   a_normType);

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


  void applyAMROperator(Vector<LevelData<FArrayBox> *>& a_phiLevel,
                        LevelData<FArrayBox>&           a_LofPhi,
                        int                             a_ilev);


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

  void setVerbose(bool a_verbose);

protected:
  virtual void setDefaultValues();

  virtual void clear();

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

  // accessor for  the residual in AMRMGLevel
  LevelData<FArrayBox>& getResid(int a_level);

  // accessor for correction in AmrMGLevel
  LevelData<FArrayBox>& getCorr(int a_level);

  Real m_errorTolerance;

  Real m_tolerance;

  Vector<Real> m_convergenceMetrics;

  Real m_operatorTolerance;

  int m_numLevels;

  int m_finestLevel;

  Vector<int> m_refRatio;

  Vector<Real> m_dxLevel;

  Vector<DisjointBoxLayout> m_gridsLevel;

  Vector<ProblemDomain> m_domainLevel;

  int m_maxIter;

  int m_minIter;

  int m_numSmoothUp;

  int m_numVCyclesBottom;

  int m_numSmoothDown;

  int m_normType;

  Vector<AMRLevelMG*> m_amrmgLevel;

  bool m_isDefined;

  LevelSolver m_levelSolver;

  int m_lBase;

  int m_ncomp;

  bool m_verbose;

private:
  AMRSolver(const AMRSolver&);
  AMRSolver& operator=(const AMRSolver&);
};

#endif

---