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

IVSFAB.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 _IVSFAB_H_
00053 #define _IVSFAB_H_
00054 
00055 #include <cmath>
00056 #include <cstdlib>
00057 #include "SPACE.H"
00058 #include "Vector.H"
00059 #include "IntVectSet.H"
00060 #include "IntVect.H"
00061 #include "BaseFab.H"
00062 
00064 
00068 template <class T>
00069 class IVSFAB
00070 {
00071 public:
00073 
00077   IVSFAB();
00078 
00080 
00082   IVSFAB(const IntVectSet& a_region,
00083             const int&        a_nvarin);
00084 
00086   ~IVSFAB();
00087 
00089 
00091   void define(const IntVectSet& a_region,
00092               const int&        a_nvarin);
00093 
00095 
00098   void setVal(const T& value);
00099 
00101   void copy(const Box& a_fromBox,
00102             const Interval& a_destInterval,
00103             const Box& a_toBox,
00104             const IVSFAB<T>& a_src,
00105             const Interval& a_srcInterval);
00106 
00108 
00112   static int preAllocatable()
00113   {
00114     return 1; // symmetric allocatable.
00115   }
00116 
00118   int size(const Box& R, const Interval& comps) const ;
00119 
00121   void linearOut(void* buf, const Box& R, const Interval& comps) const;
00122 
00124   void linearIn(void* buf, const Box& R, const Interval& comps);
00125 
00127 
00132   void clear();
00133 
00135 
00140   bool
00141   isDefined() const;
00142 
00144 
00147   int numIvs() const;
00148 
00150 
00153   int nComp() const;
00154 
00156 
00159   const IntVectSet& getIVS() const;
00160 
00162 
00168   T& operator() (const IntVect& a_iv,const int& varlocin);
00169   const T& operator() (const IntVect& a_iv,const int& varlocin) const;
00170 
00172 
00175   const T* dataPtr(const int& a_comp) const;
00176 
00178 
00181   T* dataPtr(const int& a_comp) ;
00182 
00184   IVSFAB(const Box& a_region, int a_nVar)
00185   {
00186     MayDay::Error("invalid constructor called ");
00187   }
00188 
00190 
00193   const int* loVect() const;
00194 
00196 
00199   const int* hiVect() const;
00200 
00202   static void setVerbose(bool a_verbose);
00203 private:
00204   void
00205   setDefaultValues();
00206 
00207 protected:
00208   //get index into dataPtr
00209   int getIndex(const IntVect& a_iv,const int& a_comp) const;
00210   //has to be a pointer because we are planning to ship
00211   //the damned  thing to fortran.
00212   T* m_dataPtr;
00213   int m_nComp;
00214   int m_nIvs;
00215   IntVect m_loVect;
00216   IntVect m_hiVect;
00217 
00218   //this is how we map from vof to vector of data.
00219   //grab the vof and its intvect tells you the vector<int>
00220   //the integer in the vof indexes into the vof.
00221   //that tells you the offset into m_dataPtr
00222   //you further have to account for the variable number.
00223   //the getIndex() function encapsulates the process
00224   BaseFab<int> m_ivmap;
00225   IntVectSet m_ivs;
00226   bool m_isDefined;
00227 
00228   static bool s_verbose;
00229 private:
00230   //disallowed for all the usual reasons
00231   IVSFAB<T>& operator= (const IVSFAB<T>&);
00232   IVSFAB (const IVSFAB<T>&);
00233 };
00234 
00235 #include "IVSFABI.H"
00236 
00237 #endif

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