LayoutData.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  V \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
// CHOMBO Copyright (c) 2000-2004, The Regents of the University of
// California, through Lawrence Berkeley National Laboratory (subject to
// receipt of any required approvals from U.S. Dept. of Energy).  All
// rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// (2) Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
// Dept. of Energy nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// You are under no obligation whatsoever to provide any bug fixes,
// patches, or upgrades to the features, functionality or performance of
// the source code ("Enhancements") to anyone; however, if you choose to
// make your Enhancements available either publicly, or directly to
// Lawrence Berkeley National Laboratory, without imposing a separate
// written license agreement for such Enhancements, then you hereby grant
// the following license: a non-exclusive, royalty-free perpetual license
// to install, use, modify, prepare derivative works, incorporate into
// other computer software, distribute, and sublicense such Enhancements or
// derivative works thereof, in binary and source code form.
//
// TRADEMARKS. Product and company names mentioned herein may be the
// trademarks of their respective owners.  Any rights not expressly granted
// herein are reserved.
//

#ifndef _LAYOUTDATA_H_
#define _LAYOUTDATA_H_

#include "BoxLayout.H"
#include "DataIterator.H"

//class ArrayViewData;


template<class T> class LayoutData
{
public:
  friend class ArrayViewData;

  LayoutData();


  LayoutData(const BoxLayout& a_dp);

  virtual ~LayoutData();


  virtual void define(const BoxLayout& a_dp);

  // this approach, of using the iterator itself for indexing is my own
  // brilliance.  This way you don't need all the crappy [Const][Dependent]
  // Iterators.  It also forces all data access to be done through the
  // DataIterator, which will know how to talk to KeLP (or other parallel
  // architectures, like multithreading, etc).

  DataIterator dataIterator() const;

  const T& operator [] (const DataIndex& a_index) const;


  const T& operator [] (const DataIterator& a_iterator) const;

  T& operator [] (const DataIndex& a_index);

  T& operator [] (const DataIterator& a_iterator);

  Box box(const DataIndex& a_index) const;

  Box box(const DataIterator& a_iterator) const;

  // not really a protection mechanism, since a user can always
  // perform a shallow copy of the BoxLayout, and be free to manipulate
  // the data in the object.  If you wish to have an actual copy
  // of the BoxLayout, then you need to invoke the clone() method.

  const BoxLayout& boxLayout() const
  {
    return m_boxLayout;
  }


protected:

  BoxLayout m_boxLayout;

  // this used to be std::vector<T>, and I could let vector handle
  // destruction for me, but vector.resize() absolutely demands that
  // I provide a copy constructor for T.  People get uncomfortable when
  // I make them provide me with copy constructors.
  Vector<T*> m_vector;

  // thinking about making this class self-documenting to a greater degree
  // and having the component names also be kept in the class and carried
  // around through various transformations.....
  //  vector<string> m_componentNames;

  bool m_callDelete;


private:
  // disallow copy constructors and assignment operators
  // to avoid very hard-to-find performance problems
  LayoutData<T>& operator= (const LayoutData<T>& a_rhs);
  LayoutData(const LayoutData& a_rhs);

  // handy usage function, tied to the implementation of this class
  // as a vector<T*>.  Assumes that m_comps and m_boxLayout have already
  // been initialized correctly.  Sets the correct size for the data
  // vector, deletes the extra T objects if m_vector is to shorten, and
  // performs either construction or define on the remaining T objects.
  void allocate();
};

//====================== inline functions ===========================
// not literally a .H file, but just an experiment in having useable,
// readable headers, while having the dependeny system work properly.
// Since LayoutData.H now depends on LayoutDataI.H, then changing either
// should cause all code that includes LayoutData.H to be recompiled.
// This way people can just read the interface in this file.
// Implementation is put in the *I.H file.

#include "LayoutDataI.H"

#endif

---