---

AMRNodeSolver.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.
//

// AMRNodeSolver.H
// adapted from AMRSolver by DTGraves, Tues, July 6, 1999
// petermc, Wed, Nov 28, 2000

#ifndef AMRNODESOLVER_H
#define AMRNODESOLVER_H

#include <cstdlib>
#include <cmath>
#include <iostream>
#include <assert.h>
#include "REAL.H"
#include "IntVect.H"
#include "ProblemDomain.H"
#include "NodeFArrayBox.H"
#include "Vector.H"
#include "IntVectSet.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "AMRNodeLevelMG.H"
#include "LevelNodeSolver.H"


class AMRNodeSolver
{
public:

  friend class AMRNodeLevelMG;



  AMRNodeSolver();


  AMRNodeSolver(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 NodeMaskLevelOp* const     a_opin,
                int                              a_minLength = 1);

  AMRNodeSolver(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 NodeMaskLevelOp* const     a_opin,
                int                              a_minLength = 1);


  ~AMRNodeSolver();
  

  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 NodeMaskLevelOp* const     a_opin,
              int                              a_minLength = 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 NodeMaskLevelOp* const     a_opin,
              int                              a_minLength = 1);



  bool isDefined() const;



  void setNumSmoothUp(int a_numSmoothUp);
    

  void setNumSmoothDown(int a_numSmoothDown);


  void setNumBottomGSRB(int a_numBottomGSRB);


  void setTolerance(Real a_tolerance);


  void setBottomSmoothing(bool a_doBottomSmooth);


  void setBottomTolerance(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 setBottomMaxIter(int a_maxIter);


  void setVerbose(bool a_verbose);




  void solveAMR(Vector<LevelData<NodeFArrayBox> *>&       a_phiLevel, 
                const Vector<LevelData<NodeFArrayBox> *>& a_rhsLevel);


  void AMRVCycleMG(Vector<LevelData<NodeFArrayBox> *>&       a_phiLevel, 
                   const Vector<LevelData<NodeFArrayBox> *>& a_rhsLevel);


  Real computeResidualNorm(int a_normType);



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


  void applyAMROperator(LevelData<NodeFArrayBox>&           a_lofPhi,
                        Vector<LevelData<NodeFArrayBox> *>& a_phiLevel,
                        int                                 a_ilev);

protected:

  //set data to default values.  not for external use
  void setDefaultValues();
  
  void clear();

  // solver tolerance
  Real m_tolerance;

  // tolerance on maxOperator
  Real m_operatorTolerance;

  // index of coarsest level on which solution is to be computed.
  int m_lBase;

  // number of levels allowed.
  int m_numLevels; 

  // index of finest level used.  equal to m_numLevels-1.
  int m_finestLevel;

  // refinement ratio between levels.
  Vector<int> m_refRatio;

  // grid spacing at each level.
  Vector<Real> m_dxLevel;

  // grids, cell-centered (disjoint) at each level.
  Vector<DisjointBoxLayout> m_gridsLevel;

  // cell-centered domain at each level.
  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 smoother iterations on down cycle
  int m_numSmoothDown;

  // number of smoother iterations at bottom
  int m_numBottomGSRB;

  // data at each refinement level.
  Vector<AMRNodeLevelMG*> m_amrmgLevel;   
  
  bool m_isDefined;

  // multigrid solver for coarsest level.
  LevelNodeSolver m_levelSolver;

  // default is true:  messages are written.
  bool m_verbose;
  
private:
  AMRNodeSolver(const AMRNodeSolver&);
  AMRNodeSolver& operator=(const AMRNodeSolver&);


};
#endif

---