---

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

// LevelNodeSolver.H
// adapted from LevelSolver by DTGraves, Fri, July 23, 1999
// petermc, 12 Apr 2001

#ifndef LEVELNODESOLVER_H
#define LEVELNODESOLVER_H

#include <cstdlib>
#include <iostream>
#include <assert.h>
#include <cmath>
#include "REAL.H"
#include "IntVectSet.H"
#include "ProblemDomain.H"
#include "NodeFArrayBox.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "NodeLevelMG.H"
#include "NodeLevelOp.H"

class LevelNodeSolver
{

public:



  LevelNodeSolver();


  LevelNodeSolver(const DisjointBoxLayout& a_grids, 
                  const DisjointBoxLayout* a_gridsCoarsePtr,
                  const ProblemDomain&     a_domain, 
                  Real                     a_dx,  
                  int                      a_refToCoarse,
                  const NodeLevelOp* const a_opin,
                  int                      a_minLength = 1);

  LevelNodeSolver(const DisjointBoxLayout& a_grids, 
                  const DisjointBoxLayout* a_gridsCoarsePtr,
                  const Box&               a_domain, 
                  Real                     a_dx,
                  int                      a_refToCoarse,
                  const NodeLevelOp* const a_opin,
                  int                      a_minLength = 1);


  virtual ~LevelNodeSolver();



  virtual void define(const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_gridsCoarsePtr,
                      const ProblemDomain&     a_domain,
                      Real                     a_dx,
                      int                      a_refToCoarse,
                      const NodeLevelOp* const a_opin,
                      int                      a_minLength = 1);

  virtual void define(const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_gridsCoarsePtr,
                      const Box&               a_domain,
                      Real                     a_dx,
                      int                      a_refToCoarse,
                      const NodeLevelOp* const a_opin,
                      int                      a_minLength = 1);



  bool isDefined() const;




  void setnumBottomGSRB(int a_numBottomGSRB);


  void setnumSmoothUp(int a_numSmoothUp);


  void setnumSmoothDown(int a_numSmoothDown);


  void setBottomSmoothing(bool a_bottomSolveFlag);


  void setTolerance(Real a_tolerance);


  void setOperatorTolerance(Real a_operatorTolerance);


  void setVerbose(bool a_verbose);


  void setMaxIter(int a_maxIter);


  void setMinIter(int a_minIter);


  void clearMemory();

  void setDefaultValues();


  void levelSolveH(LevelData<NodeFArrayBox>&       a_phi,
                   const LevelData<NodeFArrayBox>& a_rhs,
                   bool                            a_initializePhiToZero = true);


  void levelSolve(LevelData<NodeFArrayBox>&       a_phi,
                  const LevelData<NodeFArrayBox>* a_phiCoarse, 
                  const LevelData<NodeFArrayBox>& a_rhs,
                  bool                            a_initializePhiToZero = true);
  
protected:

  // LevelMG level solver object to relax on this level
  NodeLevelMG m_levelMG;

  // pointer to operator
  NodeLevelOp* m_levelOpPtr;
  
  // has this LevelNodeSolver been defined yet?
  bool m_isDefined;

  // grids at this level
  DisjointBoxLayout m_grids;

  // problem domain at this level
  ProblemDomain m_domain;

  // residual
  LevelData<NodeFArrayBox> m_resid;

  // useful scratch space
  LevelData<NodeFArrayBox> m_scratch;

  // correction
  LevelData<NodeFArrayBox> m_corr;

  // refinement ratio to next coarser level
  int m_refToCoarse;

  // mesh spacing at this level
  Real m_dx;

  // maximum number of iterations
  int m_maxIter;

  //
  int m_minIter;

  //
  Real m_tolerance;

  //
  Real m_operatorTolerance;

  // 
  bool m_bottomSolveFlag;

  //
  bool m_verbose;

  // interior boundary nodes
  LayoutData< Vector<IntVectSet> > m_IVSV;

  // exterior boundary nodes
  LayoutData< Vector<IntVectSet> > m_IVSVext;

private:

  int countCoarserLevels(int a_minLength);

  void operator = (const LevelNodeSolver&){;}
  LevelNodeSolver(const LevelNodeSolver&){;}

};

#endif

---