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

LayoutIterator.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 _LAYOUTITERATOR_H_
00053 #define _LAYOUTITERATOR_H_
00054 
00055 #ifndef WRAPPER
00056 
00057 #include "DataIndex.H"
00058 #include "BoxLayout.H"
00059 
00060 #endif
00061 
00063 
00078 class LayoutIterator
00079 {
00080 public:
00082   LayoutIterator()
00083   {}
00084 
00085   LayoutIterator(const BoxLayout& a_layout)
00086   {
00087     *this = a_layout.layoutIterator();
00088   }
00089 
00090   // Default copy and null constructor should be fine.
00091   // Not useful to someone using the iterator.  Used by
00092   // other classes in Chombo.  Could make it private and
00093   // let BoxLayout have access....
00094 
00095   ~LayoutIterator()
00096   {}
00097 
00099   const LayoutIndex& operator () () const;
00100 
00102   LayoutIndex i() const
00103   {
00104     return this->operator()();
00105   }
00106 
00108   void operator ++ ();
00109 
00111   void incr()
00112   {
00113     ++(*this);
00114   }
00115 
00117   bool ok() const;
00118 
00120   void begin();
00121 
00123   void reset();
00124 
00126 
00127   void end();
00128 
00129 
00130 protected:
00131   friend class BoxLayout;
00132 
00133   LayoutIterator(const BoxLayout& a_boxlayout,
00134                  const int*       a_layoutID);
00135 
00136   BoxLayout    m_layout;
00137   unsigned int m_index;
00138 
00139   LayoutIndex  m_current;
00140 };
00141 
00142 #ifndef WRAPPER
00143 
00144 inline const LayoutIndex& LayoutIterator::operator () () const
00145 {
00146   assert(ok());
00147   return m_current;
00148 }
00149 
00150 inline void LayoutIterator::operator ++ ()
00151 {
00152   ++m_index;
00153 
00154   if (ok())
00155   {
00156     m_current.m_index = (*(m_layout.m_boxes))[m_index].index;
00157   }
00158 }
00159 
00160 inline bool LayoutIterator::ok() const
00161 {
00162   return m_index < m_layout.size();
00163 }
00164 
00165 inline void LayoutIterator::begin()
00166 {
00167   m_index = 0;
00168 
00169   if (ok())
00170   {
00171     m_current.m_index = (*(m_layout.m_boxes))[m_index].index;
00172   }
00173 }
00174 #endif /*WRAPPER*/
00175 
00176 #endif

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