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

LevelOp.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, Mon, July 26, 1999
00053 
00054 #ifndef _LEVELOP_H_
00055 #define _LEVELOP_H_
00056 
00057 #include <iostream>
00058 #include <cmath>
00059 #include <cassert>
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 "LoHiSide.H"
00069 #include "ProblemDomain.H"
00070 
00072 
00077 class LevelOp
00078 {
00079 public:
00081   LevelOp()
00082   {
00083   }
00084 
00086   virtual ~LevelOp()
00087   {
00088   }
00089 
00091 
00095   virtual void define(
00096                       const DisjointBoxLayout& a_grids,
00098                       const DisjointBoxLayout* a_baseBAPtr,
00100                       Real                     a_dxLevel,
00102                       int                      a_refRatio,
00104                       const ProblemDomain&     a_domain,
00106                       bool                     a_homogeneousOnly,
00108                       int                      a_ncomp = 1) = 0;
00109 
00111 
00115   virtual void define(const DisjointBoxLayout& a_grids,
00116                       const DisjointBoxLayout* a_baseBAPtr,
00117                       Real                     a_dxLevel,
00118                       int                      a_refRatio,
00119                       const Box&               a_domain,
00120                       bool                     a_homogeneousOnly,
00121                       int                      a_ncomp = 1) = 0;
00122 
00124 
00129   virtual void define(
00130                       const LevelOp* a_opfine,
00132                       int            a_reftoFine) = 0;
00133 
00135 
00139   virtual void CFInterp(
00140                         LevelData<FArrayBox>&       a_phif,
00142                         const LevelData<FArrayBox>& a_phic) = 0;
00143 
00145 
00147   virtual void homogeneousCFInterp(LevelData<FArrayBox>& a_phif) = 0;
00148 
00150 
00152   virtual LevelOp* new_levelop() const = 0;
00153 
00155   virtual bool isDefined() const = 0;
00156 
00158 
00163   virtual void smooth(
00164                       LevelData<FArrayBox>&       a_phi,
00166                       const LevelData<FArrayBox>& a_rhs) = 0;
00167 
00169 
00172   virtual void levelPreconditioner(LevelData<FArrayBox>&       a_phihat,
00173                                    const LevelData<FArrayBox>& a_rhshat) = 0;
00174 
00176 
00180   virtual void applyOpI(LevelData<FArrayBox>&       a_phi,
00181                         const LevelData<FArrayBox>* a_phicPtr,
00182                         LevelData<FArrayBox>&       a_lofPhi) = 0;
00183 
00185 
00189   virtual void applyOpIcfHphys(LevelData<FArrayBox>&       a_phi,
00190                                const LevelData<FArrayBox>* a_phicPtr,
00191                                LevelData<FArrayBox>&       a_lofPhi)  = 0;
00192 
00194 
00198   virtual void applyOpHcfIphys(LevelData<FArrayBox>& a_phi,
00199                                LevelData<FArrayBox>& a_lofPhi) = 0;
00200 
00202 
00206   virtual void applyOpH(LevelData<FArrayBox>& a_phi,
00207                         LevelData<FArrayBox>& a_lofPhi) = 0;
00208 
00210 
00212   virtual void bottomSmoother(LevelData<FArrayBox>&       a_phi,
00213                               const LevelData<FArrayBox>& a_rhs) = 0;
00214 
00216 
00221   virtual void getFlux(
00222                        FArrayBox&       a_fineFlux,
00224                        const FArrayBox& a_data,
00226                        const DataIndex& a_datInd,
00228                        int              a_dir) = 0;
00229 
00231 
00236   virtual void setConvergenceMetric(Real a_metric, int a_comp) = 0;
00237 };
00238 
00239 #endif

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