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

AMRLevelMG.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 // DTGraves, Tues, July 6, 1999
00053 
00054 #ifndef _AMRLEVELMG_H_
00055 #define _AMRLEVELMG_H_
00056 
00057 #include "REAL.H"
00058 #include "IntVect.H"
00059 #include "Box.H"
00060 #include "FArrayBox.H"
00061 #include "LevelData.H"
00062 #include "LevelFluxRegister.H"
00063 #include "LevelMG.H"
00064 #include "MGInterp.H"
00065 #include "Copier.H"
00066 
00067 // forward declaration of AMRSolver
00068 class AMRSolver;
00069 
00071 
00077 class AMRLevelMG
00078 {
00079 public:
00080   friend class AMRSolver;
00081 
00083   AMRLevelMG();
00084 
00086   ~AMRLevelMG();
00087 
00089   AMRLevelMG(const AMRSolver* const a_parent,
00090              int                    a_level,
00091              const LevelOp* const   a_opin,
00092              int                    a_ncomp=1);
00093 
00095 
00099   void define(const AMRSolver* const a_parent,
00100               int                    a_level,
00101               const LevelOp* const   a_opin,
00102               int                    a_ncomp=1);
00103 
00105   void setNumSmoothUp(int a_numSmoothUp);
00106 
00108   void setNumSmoothDown(int a_numSmoothDown);
00109 
00111 
00117   void applyAMROperator(Vector<LevelData<FArrayBox> *>& a_phiLevel,
00118                         LevelData<FArrayBox>&           a_Lofphi);
00119 
00121 
00125   void applyAMROperatorHphys(Vector<LevelData<FArrayBox> *>& a_phiLevel,
00126                              LevelData<FArrayBox>&           a_LofPhi);
00127 
00129   void computeAMRResidual(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
00130                           const Vector<LevelData<FArrayBox> *>& a_rhsLevel);
00131 
00133 
00137   void computeAMRResidualHphys(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
00138                                const Vector<LevelData<FArrayBox> *>& a_rhsLevel);
00139 
00141   void computeAMRResidual(LevelData<FArrayBox>&                 a_resid,
00142                           Vector<LevelData<FArrayBox>* >&       a_phiLevel,
00143                           const Vector<LevelData<FArrayBox>* >& a_rhsLevel);
00144 
00146   void upSweep(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
00147                const Vector<LevelData<FArrayBox> *>& a_rhsLevel);
00148 
00150   void downSweep(Vector<LevelData<FArrayBox> *>&       a_phiLevel,
00151                  const Vector<LevelData<FArrayBox> *>& a_rhsLevel);
00152 
00154   Vector<Real> computeResidualNorm(int normType) const;
00155 
00157   LevelOp* levelOpPtr() const;
00158 
00160   bool isDefined() const;
00161 
00163   Vector<Real> computeNorm(const LevelData<FArrayBox>& a_mfinput,
00164                            int                         a_normType) const;
00165 
00167 
00172   void setConvergenceMetric(Real a_metric, int a_comp);
00173 
00174 protected:
00176 
00179   void smooth(LevelData<FArrayBox>&       a_soln,
00180               const LevelData<FArrayBox>& a_rhs);
00181 
00183 
00186   void clearMemory();
00187 
00189 
00192   void setDefaultValues();
00193 
00195 
00202   void reflux(Vector<LevelData<FArrayBox> *>& a_phiLevel,
00203               LevelData<FArrayBox>&           a_Lofphi);
00204 
00206 
00209   void initFRCoarse(Vector<LevelData<FArrayBox> *>& a_phiLevel);
00210 
00212 
00215   void incrementFRFine(Vector<LevelData<FArrayBox> *>& a_phiLevel);
00216 
00218 
00221   const AMRSolver* m_parent;
00222 
00224 
00227   LevelMG m_levelMG;
00228 
00230 
00233   MGInterp m_mginterp;
00234 
00236 
00239   LevelFluxRegister m_levfluxreg;
00240 
00242 
00245   bool m_isDefined;
00246 
00248 
00251   DisjointBoxLayout m_coarsenedGrids;
00252 
00254 
00257   LevelData<FArrayBox> m_resid;
00258 
00260 
00263   LevelData<FArrayBox> m_corr;
00264 
00266 
00269   LevelData<FArrayBox> m_dcorr;
00270 
00272 
00275   LevelData<FArrayBox> m_lofPhi;
00276 
00278 
00281   LevelData<FArrayBox> m_phiSave;
00282 
00284 
00287   LevelData<FArrayBox> m_resC;
00288 
00290 
00294   Copier m_residualCopier;
00295 
00300   Copier m_fineExchangeCopier;
00301 
00303 
00306   int m_level;
00307 
00309 
00313   LevelOp* m_levelopPtr;
00314 
00318   CoarseAverage m_averageOp;
00319 
00323   bool m_arrayViewVerbose;
00324 
00325 private:
00326   void  setArrayViewVerbose(bool a_verbosity);
00327   AMRLevelMG& operator = (const AMRLevelMG&);
00328   AMRLevelMG(const AMRLevelMG&);
00329 };
00330 
00331 #endif

Generated on Wed Jan 19 17:51:21 2005 for Chombo&INSwithParticles by doxygen1.2.16