Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

NodeMaskBiCGStabSmoother.H

Go to the documentation of this file.
00001 /*  _______              __
00002    / ___/ /  ___  __ _  / /  ___
00003   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
00004   \___/_//_/\___/_/_/_/_.__/\___/ 
00005 */
00006 //
00007 // This software is copyright (C) by the Lawrence Berkeley
00008 // National Laboratory.  Permission is granted to reproduce
00009 // this software for non-commercial purposes provided that
00010 // this notice is left intact.
00011 // 
00012 // It is acknowledged that the U.S. Government has rights to
00013 // this software under Contract DE-AC03-765F00098 between
00014 // the U.S.  Department of Energy and the University of
00015 // California.
00016 //
00017 // This software is provided as a professional and academic
00018 // contribution for joint exchange. Thus it is experimental,
00019 // is provided ``as is'', with no warranties of any kind
00020 // whatsoever, no support, no promise of updates, or printed
00021 // documentation. By using this software, you acknowledge
00022 // that the Lawrence Berkeley National Laboratory and
00023 // Regents of the University of California shall have no
00024 // liability with respect to the infringement of other
00025 // copyrights by any part of this software.
00026 //
00027 
00028 // NodeMaskBiCGStabSmoother.H
00029 // adapted from BiCGStabSmoother by DFMartin, Sun, May 5, 2002
00030 // petermc, 5 June 2002
00031 
00032 #ifndef NODEMASKBICGSTABSMOOTHER_H
00033 #define NODEMASKBICGSTABSMOOTHER_H
00034 
00035 #include <iostream>
00036 #include <math.h>
00037 #include <assert.h>
00038 #include <stdlib.h>
00039 #include "REAL.H"
00040 #include "IntVect.H"
00041 #include "Box.H"
00042 #include "DisjointBoxLayout.H"
00043 #include "LevelData.H"
00044 #include "NodeFArrayBox.H"
00045 #include "ProblemDomain.H"
00046 #include "NodeMaskBaseBottomSmoother.H"
00047 
00049 
00052 class NodeMaskBiCGStabSmoother : public NodeMaskBaseBottomSmoother
00053 {
00054 
00055 public:
00056 
00058 
00060 
00062   NodeMaskBiCGStabSmoother();
00063 
00065 
00067   virtual ~NodeMaskBiCGStabSmoother();
00068 
00070 
00072   virtual NodeMaskBaseBottomSmoother* new_bottomSmoother() const;
00073 
00075 
00077 
00079   void setMaxIter(int a_max_iter);
00080 
00082 
00084   void setSolverTol(Real a_solverTol);
00085   
00087 
00089   void setVerbose(bool a_verbose);
00090 
00092 
00103   virtual void doBottomSmooth(LevelData<NodeFArrayBox>& a_phi,
00104                               const LevelData<NodeFArrayBox>& a_rhs,
00105                               const BoxLayoutData< BaseFab<int> >& a_mask,
00106                               NodeMaskLevelOp* a_levelopPtr);
00107 
00108 protected:
00109 
00110   // max number of iterations
00111   int m_maxIter;
00112 
00113   // solver tolerance
00114   Real m_solverTol;
00115   
00116   // small parameter to check for division by zero
00117   Real m_small;
00118 
00119   // parameter to check for hanging
00120   Real m_converge_small;
00121 
00122   // default is false
00123   bool m_verbose;
00124 };
00125 
00126 #endif

Generated on Tue Apr 15 18:31:55 2003 for AMRNodeElliptic by doxygen1.2.16