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

CFIVS.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 _CFIVS_H_
00053 #define _CFIVS_H_
00054 
00055 #include <iostream>
00056 #include <cmath>
00057 #include "SPACE.H"
00058 #include <cstdlib>
00059 
00060 #include "REAL.H"
00061 #include "IntVect.H"
00062 #include "Box.H"
00063 #include "LoHiSide.H"
00064 #include "DisjointBoxLayout.H"
00065 #include "IntVectSet.H"
00066 #include "ProblemDomain.H"
00067 
00069 
00075 class CFIVS
00076 {
00077 public:
00079   CFIVS();
00080 
00082   ~CFIVS();
00083 
00085 
00088   CFIVS(const Box&               a_domain,
00089         const Box&               a_boxIn,
00090         const DisjointBoxLayout& a_fineBoxes,
00091         int                      a_direction,
00092         Side::LoHiSide           a_hiorlo);
00093 
00095 
00098   CFIVS(const ProblemDomain&     a_domain,
00099         const Box&               a_boxIn,
00100         const DisjointBoxLayout& a_fineBoxes,
00101         int                      a_direction,
00102         Side::LoHiSide           a_hiorlo);
00103 
00105 
00108   void define(const Box&               a_domain,
00109               const Box&               a_boxIn,
00110               const DisjointBoxLayout& a_fineBoxes,
00111               int                      a_direction,
00112               Side::LoHiSide           a_hiorlo);
00113 
00115 
00117   void define (const ProblemDomain&     a_domain,    
00118                const Box&               a_boxIn,     
00119                const DisjointBoxLayout& a_fineBoxes, 
00120                int                      a_direction, 
00121                Side::LoHiSide           a_hiorlo);   
00122 
00124   bool isDefined() const;
00125 
00127 
00132   bool isPacked() const;
00133 
00135 
00138   const Box& packedBox() const;
00139 
00141 
00144   const IntVectSet& getFineIVS() const ;
00145 
00146   static long long m_packCount, m_sparseCount;
00147 
00148 
00149 protected:
00150   // For internal use
00151   void  setDefaultValues();
00152 
00153   // The following variables are mainly for self-identification
00154 
00158   IntVectSet m_fiinterpIVS;
00159 
00163   bool m_packed;
00164 
00169   Box  m_packedBox;
00170 
00174   bool m_isDefined;
00175 
00176 private:
00177   void operator= (const CFIVS& a_levcfsIn)
00178   {
00179   }
00180 
00181   CFIVS(const CFIVS& a_levcfsIn)
00182   {
00183   }
00184 };
00185 
00186 inline bool CFIVS::isPacked() const
00187 {
00188   return m_packed;
00189 }
00190 
00191 inline const Box& CFIVS::packedBox() const
00192 {
00193   return m_packedBox;
00194 }
00195 
00196 #endif

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