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

LevelFluxRegister.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 #ifndef _LEVELFLUXREGISTER_H_
00053 #define _LEVELFLUXREGISTER_H_
00054 
00055 #include "REAL.H"
00056 #include "Vector.H"
00057 #include "FArrayBox.H"
00058 #include "IntVectSet.H"
00059 #include "CFStencil.H"
00060 #include "LoHiSide.H"
00061 #include "LevelData.H"
00062 #include "LayoutData.H"
00063 #include "ProblemDomain.H"
00064 
00066 
00075 class LevelFluxRegister
00076 {
00077 public:
00078 
00080 
00083   LevelFluxRegister();
00084 
00086 
00091   LevelFluxRegister(
00092                     const DisjointBoxLayout& a_dbl,
00093                     const DisjointBoxLayout& a_dblCoarse,
00094                     const Box& a_dProblem,
00095                     int a_nRefine,
00096                     int a_nComp);
00097 
00099 
00104   LevelFluxRegister(
00105                     const DisjointBoxLayout& a_dbl,
00106                     const DisjointBoxLayout& a_dblCoarse,
00107                     const ProblemDomain& a_dProblem,
00108                     int a_nRefine,
00109                     int a_nComp);
00110 
00112   ~LevelFluxRegister();
00113 
00115 
00120   void define(
00121               const DisjointBoxLayout& a_dbl,
00122               const DisjointBoxLayout& a_dblCoarse,
00123               const Box& a_dProblem,
00124               int a_nRefine,
00125               int a_nComp);
00126 
00128 
00133   void define(
00134               const DisjointBoxLayout& a_dbl,
00135               const DisjointBoxLayout& a_dblCoarse,
00136               const ProblemDomain& a_dProblem,
00137               int a_nRefine,
00138               int a_nComp);
00139 
00141 
00147   void
00148   undefine();
00149 
00151 
00154   void setToZero();
00155 
00157 
00166   void incrementCoarse(
00167                        FArrayBox& a_coarseFlux,
00168                        Real a_scale,
00169                        const DataIndex& a_coarseDataIndex,
00170                        const Interval& a_srcInterval,
00171                        const Interval& a_dstInterval,
00172                        int a_dir);
00173 
00175 
00178   void incrementCoarse(
00179                        FArrayBox& a_coarseFlux,
00180                        Real a_scale,
00181                        const DataIndex& a_coarseDataIndex,
00182                        const Interval& a_srcInterval,
00183                        const Interval& a_dstInterval,
00184                        int a_dir,
00185                        Side::LoHiSide a_sd);
00186 
00188 
00195   void incrementFine(
00196                      FArrayBox& a_fineFlux,
00197                      Real a_scale,
00198                      const DataIndex& a_fineDataIndex,
00199                      const Interval& a_srcInterval,
00200                      const Interval& a_dstInterval,
00201                      int a_dir,
00202                      Side::LoHiSide a_sd);
00203 
00205 
00215   void reflux(
00216               LevelData<FArrayBox>& a_uCoarse,
00217               Real a_scale);
00218 
00220 
00226   void reflux(
00227               LevelData<FArrayBox>& a_uCoarse,
00228               const Interval& a_coarse_interval,
00229               const Interval& a_flux_interval,
00230               Real a_scale);
00231 
00233 
00236   bool isDefined() const;
00237 
00239   void poutCoarseRegisters() const;
00240 
00242   void poutFineRegisters() const;
00243 protected:
00244 
00245   // both of these are defined in the coarse index space,
00246   // but, m_coarFlux uses the coarse grid layout, and
00247   // m_fineFlux uses the fine grid layout.
00248   LevelData<FArrayBox> m_coarFlux;
00249   LevelData<FArrayBox> m_fineFlux;
00250 
00251   //LayoutData<IntVectSet> m_coarseLocations[CH_SPACEDIM*2];
00252   LayoutData< Vector<Box> > m_coarseLocations[CH_SPACEDIM*2];
00253 
00254   ProblemDomain m_domain;
00255 
00256   bool m_isDefined;
00257 
00258   int m_nRefine;
00259 
00260   Copier m_reverseCopier;
00261 
00262 private:
00263 
00265   void operator= (const LevelFluxRegister&);
00267   LevelFluxRegister(const LevelFluxRegister&);
00268 };
00269 #endif

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