Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

BiCGStabSmoother.H

Go to the documentation of this file.
00001 /*   _______              __
00002     / ___/ /  ___  __ _  / /  ___
00003    / /__/ _ \/ _ \/  V \/ _ \/ _ \
00004    \___/_//_/\___/_/_/_/_.__/\___/
00005 */
00006 // CHOMBO Copyright (c) 2000-2004, The Regents of the University of
00007 // California, through Lawrence Berkeley National Laboratory (subject to
00008 // receipt of any required approvals from U.S. Dept. of Energy).  All
00009 // rights reserved.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are met:
00013 //
00014 // (1) Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 // (2) Redistributions in binary form must reproduce the above copyright
00017 // notice, this list of conditions and the following disclaimer in the
00018 // documentation and/or other materials provided with the distribution.
00019 // (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
00020 // Dept. of Energy nor the names of its contributors may be used to endorse
00021 // or promote products derived from this software without specific prior
00022 // written permission.
00023 //
00024 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00025 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00026 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00027 // PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00028 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00029 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00030 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00031 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00032 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00033 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00034 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035 //
00036 // You are under no obligation whatsoever to provide any bug fixes,
00037 // patches, or upgrades to the features, functionality or performance of
00038 // the source code ("Enhancements") to anyone; however, if you choose to
00039 // make your Enhancements available either publicly, or directly to
00040 // Lawrence Berkeley National Laboratory, without imposing a separate
00041 // written license agreement for such Enhancements, then you hereby grant
00042 // the following license: a non-exclusive, royalty-free perpetual license
00043 // to install, use, modify, prepare derivative works, incorporate into
00044 // other computer software, distribute, and sublicense such Enhancements or
00045 // derivative works thereof, in binary and source code form.
00046 //
00047 // TRADEMARKS. Product and company names mentioned herein may be the
00048 // trademarks of their respective owners.  Any rights not expressly granted
00049 // herein are reserved.
00050 //
00051 
00052 // DFMartin, Sun, May 5, 2002
00053 
00054 #ifndef _BICGSTABSMOOTHER_H_
00055 #define _BICGSTABSMOOTHER_H_
00056 
00057 #include <iostream>
00058 #include <cmath>
00059 #include "SPACE.H"
00060 #include <cstdlib>
00061 
00062 #include "REAL.H"
00063 #include "IntVect.H"
00064 #include "Box.H"
00065 #include "DisjointBoxLayout.H"
00066 #include "LevelData.H"
00067 #include "FArrayBox.H"
00068 #include "ProblemDomain.H"
00069 
00070 #include "BaseBottomSmoother.H"
00071 
00073 
00077 class BiCGStabSmoother: public BaseBottomSmoother
00078 {
00079 public:
00081   BiCGStabSmoother();
00082 
00084   virtual ~BiCGStabSmoother();
00085 
00087 
00090   virtual BaseBottomSmoother* new_bottomSmoother() const;
00091 
00093   void setMaxIter(int a_maxIter);
00094 
00096 
00099   void setSolverTol(Real a_solverTol);
00100 
00102 
00107   void setEnableRestart(bool a_enableRestart);
00108 
00110 
00113   void setVerbose(bool a_verbose);
00114 
00116 
00121   virtual void doBottomSmooth(LevelData<FArrayBox>&       a_phi,
00122                               const LevelData<FArrayBox>& a_rhs,
00123                               LevelOp*                    a_levelopPtr);
00124 
00126   virtual void setConvergenceMetric(Real a_metric, int a_comp);
00127 
00128 protected:
00132   int m_maxIter;
00133 
00137   Vector<Real> m_convergenceMetrics;
00138 
00143   Real m_solverTol;
00144 
00148   Real m_small;
00149 
00153   Real m_convergeSmall;
00154 
00158   bool m_enableRestart;
00159 
00163   bool m_verbose;
00164 };
00165 
00166 #endif

Generated on Wed Oct 5 13:52:08 2005 for Chombo&AMRSelfGravity by  doxygen 1.4.1