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

LayoutData.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 _LAYOUTDATA_H_
00053 #define _LAYOUTDATA_H_
00054 
00055 #include "BoxLayout.H"
00056 #include "DataIterator.H"
00057 
00058 //class ArrayViewData;
00059 
00061 
00084 template<class T> class LayoutData
00085 {
00086 public:
00087   friend class ArrayViewData;
00088 
00090   LayoutData();
00091 
00093 
00097   LayoutData(const BoxLayout& a_dp);
00098 
00100   virtual ~LayoutData();
00101 
00103 
00108   virtual void define(const BoxLayout& a_dp);
00109 
00110   // this approach, of using the iterator itself for indexing is my own
00111   // brilliance.  This way you don't need all the crappy [Const][Dependent]
00112   // Iterators.  It also forces all data access to be done through the
00113   // DataIterator, which will know how to talk to KeLP (or other parallel
00114   // architectures, like multithreading, etc).
00115 
00117   DataIterator dataIterator() const;
00118 
00120   const T& operator [] (const DataIndex& a_index) const;
00121 
00123 
00127   const T& operator [] (const DataIterator& a_iterator) const;
00128 
00130   T& operator [] (const DataIndex& a_index);
00131 
00133   T& operator [] (const DataIterator& a_iterator);
00134 
00136   Box box(const DataIndex& a_index) const;
00137 
00138   Box box(const DataIterator& a_iterator) const;
00139 
00140   // not really a protection mechanism, since a user can always
00141   // perform a shallow copy of the BoxLayout, and be free to manipulate
00142   // the data in the object.  If you wish to have an actual copy
00143   // of the BoxLayout, then you need to invoke the clone() method.
00144 
00146   const BoxLayout& boxLayout() const
00147   {
00148     return m_boxLayout;
00149   }
00150 
00151 
00152 protected:
00153 
00154   BoxLayout m_boxLayout;
00155 
00156   // this used to be std::vector<T>, and I could let vector handle
00157   // destruction for me, but vector.resize() absolutely demands that
00158   // I provide a copy constructor for T.  People get uncomfortable when
00159   // I make them provide me with copy constructors.
00160   Vector<T*> m_vector;
00161 
00162   // thinking about making this class self-documenting to a greater degree
00163   // and having the component names also be kept in the class and carried
00164   // around through various transformations.....
00165   //  vector<string> m_componentNames;
00166 
00167   bool m_callDelete;
00168 
00169 
00170 private:
00171   // disallow copy constructors and assignment operators
00172   // to avoid very hard-to-find performance problems
00173   LayoutData<T>& operator= (const LayoutData<T>& a_rhs);
00174   LayoutData(const LayoutData& a_rhs);
00175 
00176   // handy usage function, tied to the implementation of this class
00177   // as a vector<T*>.  Assumes that m_comps and m_boxLayout have already
00178   // been initialized correctly.  Sets the correct size for the data
00179   // vector, deletes the extra T objects if m_vector is to shorten, and
00180   // performs either construction or define on the remaining T objects.
00181   void allocate();
00182 };
00183 
00184 //====================== inline functions ===========================
00185 // not literally a .H file, but just an experiment in having useable,
00186 // readable headers, while having the dependeny system work properly.
00187 // Since LayoutData.H now depends on LayoutDataI.H, then changing either
00188 // should cause all code that includes LayoutData.H to be recompiled.
00189 // This way people can just read the interface in this file.
00190 // Implementation is put in the *I.H file.
00191 
00192 #include "LayoutDataI.H"
00193 
00194 #endif

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