LevelSolver.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 _LEVELSOLVER_H_
#define _LEVELSOLVER_H_

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

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "FArrayBox.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "LevelMG.H"
#include "ProblemDomain.H"


class LevelSolver
{
public:

  LevelSolver();

  virtual ~LevelSolver();


  LevelSolver(const DisjointBoxLayout& a_grids,
              const DisjointBoxLayout* a_baseGrids,
              const ProblemDomain&     a_domain,
              Real                     a_dxLevel,
              int                      a_nRefCrse,
              const LevelOp* const     a_opin,
              int                      a_ncomp,
              bool                     a_limitCoarsening = false);


  LevelSolver(const DisjointBoxLayout& a_grids,
              const DisjointBoxLayout* a_baseGrids,
              const Box&               a_domain,
              Real                     a_dxLevel,
              int                      a_nRefCrse,
              const LevelOp* const     a_opin,
              int                      a_ncomp = 1,
              bool                     a_limitCoarsening = false);


  virtual void define(const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_baseGrids,
                      const ProblemDomain&     a_domain,
                      Real                     a_dxLevel,
                      int                      a_nRefCrse,
                      const LevelOp* const     a_opin,
                      int                      a_ncomp = 1,
                      bool                     a_limitCoarsening = false);


  virtual void define(const DisjointBoxLayout& a_grids,
                      const DisjointBoxLayout* a_baseGrids,
                      const Box&               a_domain,
                      Real                     a_dxLevel,
                      int                      a_nRefCrse,
                      const LevelOp* const     a_opin,
                      int                      a_ncomp=1,
                      bool                     a_limitCoarsening = false);

  bool isDefined() const;

  void clearMemory();

  void setDefaultValues();


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


  void levelSolve(
                  LevelData<FArrayBox>&       a_phi,
                  const LevelData<FArrayBox>* a_phic,
                  const LevelData<FArrayBox>& a_rhs,
                  bool                        a_initializePhiToZero=true);

  void setNumSmoothUp(int a_numSmoothUp);
  
  void setNumSmoothDown(int a_numSmoothDown);

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

  virtual void setConvergenceMetric(Real a_metric, int a_comp);


  virtual void resetConvergenceMetrics();

protected:
  LevelMG m_levelMG;

  LevelOp* m_levelOpPtr;

  bool m_isDefined;

  DisjointBoxLayout  m_grids;

  ProblemDomain m_domain;

  LevelData<FArrayBox> m_resid;

  LevelData<FArrayBox> m_scratch;

  LevelData<FArrayBox> m_corr;

  int m_nRefCrse;

  Real m_dxLevel;

  int m_maxIter;

  int m_minIter;

  int m_numSmoothUp;

  int m_numSmoothDown;

  Real m_tolerance;

  Vector<Real> m_convergenceMetrics;

  Real m_operatorTolerance;

  bool m_verbose;

private:
  void operator = (const LevelSolver&){;}
  LevelSolver(const LevelSolver&){;}
};

#endif

---