---

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 <assert.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 ncomp = 1);



  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 ncomp = 1);


  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 ncomp=1);



  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 ncomp=1);

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


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


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


  void computeAMRResidual(Vector<LevelData<FArrayBox> *>& a_phiLevel,
                          const Vector<LevelData<FArrayBox> *>& a_rhsLevel,
                          LevelData<FArrayBox> & res,
                          int 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:
  //set data to default values.  not for external use
  void setDefaultValues();

  void clear();

  // error tolerance for error estimation
  Real m_errorTolerance;

  // solver tolerance
  Real m_tolerance;

  // tolerance on maxOperator
  Real m_operatorTolerance;


  // number of levels allowed
  int m_numLevels; 

  // Maximum number of working level is m_numLevels - 1
  int m_finestLevel; 

  // refinement ratio.  
  Vector<int> m_refRatio;

  // grid spacing.  
  Vector<Real> m_dxLevel;

  // grids.  
  Vector<DisjointBoxLayout> m_gridsLevel;

  // domains.  
  Vector<ProblemDomain> m_domainLevel;

  // maximum number of solver iterations
  int m_maxIter;

  // minimum number of solver iterations before "hung converence" criteria
  // is valid
  int m_minIter;

  // number of smoother iterations on up cycle
  int m_numSmoothUp;

  // number of VCycles for max iter of levelsolver
  int m_numVCyclesBottom;

  // number of smoother iterations on down cycle
  int m_numSmoothDown;

  // array of AMRLevelMGs containing data at each refinement level
  Vector<AMRLevelMG*> m_amrmgLevel;   

  bool m_isDefined;

  LevelSolver m_levelSolver;

  int m_lBase;

  int m_ncomp;

  //default is true
  bool m_verbose;

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


};
#endif

---