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

QuadCFStencil.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 _QUADCFSTENCIL_H_
00053 #define _QUADCFSTENCIL_H_
00054 
00055 #include <iostream>
00056 #include <math.h>
00057 #include "SPACE.H"
00058 #include <stdlib.h>
00059 #include "REAL.H"
00060 #include "IntVect.H"
00061 #include "Box.H"
00062 #include "DisjointBoxLayout.H"
00063 #include "FArrayBox.H"
00064 #include "IntVectSet.H"
00065 #include "CFStencil.H"
00066 #include "DerivStencil.H"
00067 
00069 
00074 class QuadCFStencil
00075 {
00076 
00077 public:
00079 
00081 
00089   Real computeSecondDerivative(
00090                                const BaseFab<Real> & a_phic,
00091                                int a_derivdir,
00092                                int a_ivar,
00093                                const IntVect& a_ivin,
00094                                Real a_dx) const;
00095 
00097 
00105   Real computeFirstDerivative(
00106                               const BaseFab<Real> & a_phic,
00107                               int a_derivdir,
00108                               int a_ivar,
00109                               const IntVect& a_ivin,
00110                               Real a_dx) const;
00111 
00113 
00123   Real computeMixedDerivative(
00124                               const BaseFab<Real> & a_phic,
00125                               int a_ivar,
00126                               const IntVect& a_ivin,
00127                               Real a_dx) const;
00128 
00130   QuadCFStencil();
00131 
00133   ~QuadCFStencil();
00134 
00136   QuadCFStencil(
00137                 const Box& a_fine_domain,
00138                 const Box& a_grid,
00139                 const DisjointBoxLayout& a_fineBoxes,
00140                 const DisjointBoxLayout& a_coarBoxes,
00141                 int a_refRatio,
00142                 int a_direction,
00143                 Side::LoHiSide a_hiorlo);
00144 
00146   QuadCFStencil(
00147                 const ProblemDomain& a_fine_domain,
00148                 const Box& a_grid,
00149                 const DisjointBoxLayout& a_fineBoxes,
00150                 const DisjointBoxLayout& a_coarBoxes,
00151                 int a_refRatio,
00152                 int a_direction,
00153                 Side::LoHiSide a_hiorlo);
00154 
00156   void   define(
00157                 const Box& a_fine_domain,
00158                 const Box& a_grid,
00159                 const DisjointBoxLayout& a_fineBoxes,
00160                 const DisjointBoxLayout& a_coarBoxes,
00161                 int a_refRatio,
00162                 int a_direction,
00163                 Side::LoHiSide a_hiorlo);
00164 
00166   void   define(
00167                 const ProblemDomain& a_fine_domain,
00168                 const Box& a_grid,
00169                 const DisjointBoxLayout& a_fineBoxes,
00170                 const DisjointBoxLayout& a_coarBoxes,
00171                 int a_refRatio,
00172                 int a_direction,
00173                 Side::LoHiSide a_hiorlo);
00174 
00176 
00178 
00181   bool isDefined() const;
00182 
00184 
00187   bool isEmpty() const
00188   {
00189     CH_assert(m_baseCFS.isDefined());
00190     return m_baseCFS.isEmpty();
00191   }
00192 
00194 
00196   const IntVectSet& getFineIVS() const
00197   {
00198     CH_assert(m_baseCFS.isDefined());
00199     return m_baseCFS.getFineIVS();
00200   }
00201 
00203 
00205   const IntVectSet& getCoarIVS() const
00206   {
00207     CH_assert(m_baseCFS.isDefined());
00208     return m_baseCFS.getCoarIVS();
00209   }
00210 
00211 
00212 protected:
00213 
00214   //has define fcn been called?
00215   bool m_isDefined;
00216 
00217   //direction of face
00218   int m_direction;
00219 
00221 
00227   IntVectSet m_ivsStandard;
00228 
00230 
00234   IntVectSet m_ivsQuadd;
00235 
00242 
00243 
00247   BaseFab<DerivStencil> m_mixedSten;
00248 
00250 
00254   BaseFab<DerivStencil> m_second[SpaceDim];
00255 
00257 
00261   BaseFab<DerivStencil> m_firstD[SpaceDim];
00262 
00264 
00268   BaseFab<bool> m_dropOrd;
00269 
00271   CFStencil m_baseCFS;
00272 
00273 
00274 private:
00275   // internally useful but not for public consumption
00276 
00277   //
00278   void  setDefaultValues();
00279 
00280   /*
00281     add fab to the stencil.  For internal use only.
00282   */
00283   void addFabToSten(const BaseFab<Real> & fabin_a,
00284                     DerivStencil&  sten_a);
00285 
00286   // there is no assignment operator for this class
00287   void operator= (const QuadCFStencil& cfs_in)
00288   {
00289   }
00290 
00291   // there is no copy constructor for this class
00292   QuadCFStencil(const QuadCFStencil& cfs_in)
00293   {
00294   }
00295 
00296 };
00297 
00298 #endif

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