LevelSolver.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  V \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
// CHOMBO Copyright (c) 2000-2004, The Regents of the University of
// California, through Lawrence Berkeley National Laboratory (subject to
// receipt of any required approvals from U.S. Dept. of Energy).  All
// rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// (2) Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
// Dept. of Energy nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// You are under no obligation whatsoever to provide any bug fixes,
// patches, or upgrades to the features, functionality or performance of
// the source code ("Enhancements") to anyone; however, if you choose to
// make your Enhancements available either publicly, or directly to
// Lawrence Berkeley National Laboratory, without imposing a separate
// written license agreement for such Enhancements, then you hereby grant
// the following license: a non-exclusive, royalty-free perpetual license
// to install, use, modify, prepare derivative works, incorporate into
// other computer software, distribute, and sublicense such Enhancements or
// derivative works thereof, in binary and source code form.
//
// TRADEMARKS. Product and company names mentioned herein may be the
// trademarks of their respective owners.  Any rights not expressly granted
// herein are reserved.
//

// DTGraves, Fri, July 23, 1999

#ifndef _LEVELSOLVER_H_
#define _LEVELSOLVER_H_

#include <cstdlib>
#include <iostream>
#include "SPACE.H"
#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();

  void setNormType(int a_normType);

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;

  int m_normType;

  Vector<Real> m_convergenceMetrics;

  Real m_operatorTolerance;

  bool m_verbose;

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

  LevelSolver(const LevelSolver&)
  {
  }
};

#endif

---