BinFab.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
//
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//

#ifndef _BINFAB_H_
#define _BINFAB_H_

#include "BaseFab.H"
#include "RealVect.H"
#include "FluxBox.H"
#include "List.H"
#include "Box.H"
#include "ProblemDomain.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,
         const ProblemDomain& a_probdomain);

  BinFab(const BinFab& a_binfab);

  virtual ~BinFab();

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

  virtual void reBin();

  virtual void addItem(const T& a_item);

  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 clear();


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

  // Linearization functions


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


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


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

  static int preAllocatable() { return 2; }

protected:
  RealVect m_origin;

  RealVect m_mesh_spacing;

  ProblemDomain m_probdomain;

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

// Implementation
#include "BinFabImplem.H"

#endif

---