---

BinFab.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 _BINFAB_H_
#define _BINFAB_H_

#include "BaseFab.H"
#include "RealVect.H"
#include "FluxBox.H"
#include "List.H"
#include "Box.H"


template<class T>
class BinFab : public BaseFab<List<T> >
{
public:
  BinFab();

  BinFab(const Box&           a_domain,
         const RealVect&      a_mesh_spacing,
         const RealVect&      a_origin);

  BinFab(const BinFab& a_binfab);

  virtual ~BinFab();

  virtual void define(const Box&           a_domain,
                      const RealVect&      a_mesh_spacing,
                      const RealVect&      a_origin);


  virtual void reBin();


  virtual void reBin(List<T>& a_lost, const Box & a_valid = Box(), bool a_in = true);

  virtual void addItem(const T& a_item);

  virtual void addItem(const T& a_item, const IntVect& a_bin);

  virtual void addItems(const List<T>& a_list);

  virtual void addItemsDestructive(List<T>& a_list);

  virtual void addItemsDestructive(List<T>& a_list, const Box& a_valid, bool a_in = true);


  virtual void transfer(BinFab<T>&  a_src,
                        const Box&  a_srcBox,
                        const Box&  a_destBox);

//XXX  //XXX testing if copy() can be overloaded to handle transfer() <dbs>
//XXX  BinFab<T> & copy(BinFab<T>& a_src,
//XXX                   const Box& a_srcBox,
//XXX                   const Box& a_destBox);
//XXX

  virtual void clear();


  virtual int numItems(const Box& a_box = Box()) const;

  virtual RealVect meshSpacing() const;

  virtual void meshSpacing(const RealVect& a_mesh_spacing) ;

  RealVect origin() const;

  void origin(const RealVect& a_origin);

  // Linearization functions


  virtual int size(const Box& a_box, const Interval& a_comps = Interval(0,0)) const;


  virtual void linearOut(void* a_buf, const Box& a_box,
                         const Interval& a_comps) const;


  virtual void linearOutDestructive(void* buf, const Box& a_box,
                                    const Interval& a_comps = Interval(0,0));


  virtual void linearIn(void* a_buf, const Box& a_box,
                        const Interval& a_comps = Interval(0,0));

  static int preAllocatable()
  {
    return 2;
  }


  const int* size () const
  {
    return this->m_domain.size().getVect();
  }

protected:
  RealVect m_origin;

  RealVect m_mesh_spacing;

  inline IntVect locateBin(const T& a_item) const;
};

// Implementation
#include "BinFabImplem.H"

#endif

---