BaseFab.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

#ifndef _BASEFAB_H_
#define _BASEFAB_H_

#include <cstdlib>
#include "SPACE.H"
#include <string>
#include <typeinfo>
#include <cmath>

#include "Box.H"
#include "Arena.H"
#include "Interval.H"
#include "REAL.H"
#include "NamespaceHeader.H"

class SliceSpec;

extern Real BaseFabRealSetVal;

template <class T> class BaseFab
{
public:

  BaseFab ();


  BaseFab(const Box& a_bx,
          int        a_n,
          T*         a_alias = NULL);

  BaseFab(const Interval& a_comps,
          BaseFab<T>&     a_original);


  virtual ~BaseFab();

  void resize(const Box& a_b,
              int        a_n = 1,
              T*         a_alias=NULL);

  virtual void define(const Box& a_box,
                      int        a_comps,
                      T*         a_alias = NULL)
  {
    resize(a_box, a_comps, a_alias);
  }

  virtual void define(const Interval& a_comps,
                      BaseFab<T>&     a_original);

  void clear();



  int nComp() const;


  const Box& box() const;

  IntVect size() const;

  const IntVect& smallEnd() const;

  const IntVect& bigEnd() const;


  Interval interval() const
  {
    return Interval(0, m_nvar-1);
  }

  T& operator () (const IntVect& a_p,
                  int            a_N);

  T& operator () (const IntVect& a_p);

  const T& operator () (const IntVect& p,
                        int            N) const;

  const T& operator () (const IntVect& p) const;

  void getVal(T*             a_data,
              const IntVect& a_pos,
              int            a_N,
              int            a_numcomp) const;

  void getVal(T*             a_data,
              const IntVect& a_pos) const;


  const int* loVect() const;

  const int* hiVect() const;

  const int* nCompPtr() const;

  T* dataPtr(int a_n = 0);

  const T* dataPtr(int a_n = 0) const;


  bool contains(const BaseFab<T>& a_fab) const;

  bool contains(const Box& a_bx) const;


  void setVal(T          a_x,
              const Box& a_bx,
              int        a_nstart,
              int        a_numcomp);


  void setVal(T          a_x,
              const Box& a_bx,
              int        a_n);


  void setVal(T   a_x,
              int a_n);


  void setVal(T a_x);

  BaseFab<T>& copy(const BaseFab<T>& a_src,
                   const Box&        a_srcbox,
                   int               a_srccomp,
                   const Box&        a_destbox,
                   int               a_destcomp,
                   int               a_numcomp);

  BaseFab<T>& copy(const BaseFab<T>& a_src,
                   int               a_srccomp,
                   int               a_destcomp,
                   int               a_numcomp = 1);

  BaseFab<T>& copy(const BaseFab<T>& a_src,
                   const Box&        a_destbox);

  BaseFab<T>& copy(const BaseFab<T>& a_src);


  void copy(const Box&        a_RegionFrom,
            const Interval&   a_Cdest,
            const Box&        a_RegionTo,
            const BaseFab<T>& a_src,
            const Interval&   a_Csrc);



  BaseFab<T>& shift(const IntVect& a_v);


  BaseFab<T>& shift(int a_idir,
                    int a_ncells);


  BaseFab<T>& shiftHalf(int a_dir,
                        int a_numHalfs);


  BaseFab<T>& shiftHalf(const IntVect& a_v);



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


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

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

  static int preAllocatable()
  {
    return 0; // static preAllocatable
  }

  void degenerate(BaseFab<T>& a_slice, const SliceSpec& a_sliceSpec) const;


  bool isAliased() const;

protected:
  //
  // Allocates memory for the `BaseFab<T>'.
  //
  void define();

  //
  // Deallocates memory for the `BaseFab<T>'.
  //
  void undefine();

  static std::string name();

  //
  // The function called by BaseFab copy operations.
  //
  virtual void performCopy(const BaseFab<T>& a_src,
                           const Box&        a_srcbox,
                           int               a_srccomp,
                           const Box&        a_destbox,
                           int               a_destcomp,
                           int               a_numcomp);

  //
  // This function is called by the `BaseFab' setVal operations.
  //
  void performSetVal(T          a_x,
                     const Box& a_bx,
                     int        a_nstart,
                     int        a_numcomp);

  //
  // template class static data member.  not sure if this will
  // work with all compilers.  It has been in the draft standard
  // for some time
  //
  static Arena* s_Arena;

  Box  m_domain;   // My index space.
  int  m_nvar;     // Number components.
  long m_numpts;   // Cached number of points in FAB.
  long m_truesize; // m_nvar * m_numpts that was allocated on heap
                   //   (only if m_aliased == false).
  T*   m_dptr;     // The data pointer.
  bool m_aliased;  // The BaseFab is not allocated memory, but is an alias. bvs

private:
  //
  // These functions are made private to prevent use of the default
  // functions provided by the C++ compiler.
  //
  BaseFab<T>& operator= (const BaseFab<T>&);
  BaseFab (const BaseFab<T>&);
};

#include "NamespaceFooter.H"

#include "BaseFabImplem.H"

#endif

---