---

GenLevelSolver.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, Fri, July 23, 1999

#ifndef _GENLEVELSOLVER_H_
#define _GENLEVELSOLVER_H_

#include <cstdlib>
#include <iostream>
#include <assert.h>
#include <cmath>

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "ProblemDomain.H"

#include "GenLevelMGOp.H"
#include "GenLevelMG.H"


template <class T> class GenLevelSolver
{
public:

  GenLevelSolver();


  GenLevelSolver(const DisjointBoxLayout&     a_grids, 
                 const DisjointBoxLayout*     a_baseGrids, 
                 const Box&                   a_domain, 
                 Real                         a_dxLevel,  
                 int                          a_nRefCrse,
                 const GenLevelMGOp<T>* const a_opin,
                 int                          a_ncomp = 1);


  GenLevelSolver(const DisjointBoxLayout&     a_grids, 
                 const DisjointBoxLayout*     a_baseGrids, 
                 const ProblemDomain&         a_domain, 
                 Real                         a_dxLevel,  
                 int                          a_nRefCrse,
                 const GenLevelMGOp<T>* const a_opin,
                 int                          a_ncomp);

  virtual ~GenLevelSolver();

  bool isDefined() const;


  virtual void define(const DisjointBoxLayout&     a_grids, 
                      const DisjointBoxLayout*     a_baseGrids,
                      const Box&                   a_domain, 
                      Real                         a_dxLevel,
                      int                          a_nRefCrse,
                      const GenLevelMGOp<T>* const a_opin,
                      int                          a_ncomp = 1);


  virtual void define(const DisjointBoxLayout&     a_grids, 
                      const DisjointBoxLayout*     a_baseGrids,
                      const ProblemDomain&         a_domain, 
                      Real                         a_dxLevel,
                      int                          a_nRefCrse,
                      const GenLevelMGOp<T>* const a_opin,
                      int                          a_ncomp = 1);

  void clearMemory();

  void setDefaultValues();


  void levelSolveH(T&       a_phi, 
                   const T& a_rhs,
                   bool     a_initializePhiToZero = true);


  void levelSolve(T&       a_phi, 
                  const T* a_phic, 
                  const T& a_rhs,
                  bool     a_initializePhiToZero = true);

  void setTolerance(Real a_tolerance);


  void setOperatorTolerance(Real a_operatorTolerance);

  void setVerbose(bool a_verbose);

  void setMaxIter(int a_maxIter);


  // added by Dan M, (9/20/02)
  void setMinIter(int a_minIter);

protected:
  // GenLevelMG<T> level solver object to relax on this level
  GenLevelMG<T> m_levelMG;

  // GenLevelMGOp<T> object to define the operator on this level
  GenLevelMGOp<T>* m_levelOpPtr;

  // has this GenLevelSolver been defined yet?
  bool m_isDefined;

  // grids at this level
  DisjointBoxLayout m_grids;

  // problem domain at this level
  ProblemDomain m_domain;

  // residual
  T m_resid;

  // useful scratch space.
  T m_scratch;

  // correction
  T m_corr;

  //
  int m_nRefCrse;

  //
  Real m_dxLevel;

  //
  int m_maxIter;

  //
  int m_minIter;

  //
  Real m_tolerance;

  //
  Real m_operatorTolerance;

  //
  bool m_verbose;

private:
  GenLevelSolver<T>(const GenLevelSolver<T>&) {};
  void operator= (const GenLevelSolver<T>&) {};
};

#include "GenLevelSolverImplem.H"

#endif

---