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

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

#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);


  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);


  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);

  ~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 solveAMR(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
                const Vector<LevelData<FArrayBox> *>& a_rhsLevel,
                bool a_initializePhiToZero = true);


  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:
  void setDefaultValues();

  void clear();

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

  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;

  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

---