---

BaseIFFAB.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.
//
// DTG, ANAG, LBNL

#ifndef _BaseIFFAB_H_
#define _BaseIFFAB_H_

#include <cmath>
#include <cstdlib>
#include <cassert>
#include "Vector.H"
#include "IntVectSet.H"
#include "FaceIndex.H"
#include "BaseFab.H"
#include "EBGraph.H"


template <class T>
class BaseIFFAB
{
public:

  BaseIFFAB();



  BaseIFFAB(const IntVectSet& a_region, 
            const EBGraph& a_ebgraph,
            const int& a_direction,
            const int& a_nvarin);

  ~BaseIFFAB();


  void define(const IntVectSet& a_region, 
              const EBGraph& a_ebgraph,
              const int& a_direction,
              const int& a_nvarin);



  void setVal(const T& value);



  void copy(const Box& a_intBox, 
            const Interval& a_destInterval,
            const Box& a_toBox,
            const BaseIFFAB<T>& a_src, 
            const Interval& a_srcInterval);
            



  void clear();



  bool 
  isDefined() const;



  int numFaces() const; 


  int nComp() const;



  int direction() const;


  const IntVectSet& getIVS() const;



  T& operator() (const FaceIndex& a_face,const int& varlocin);
  const T& operator()(const FaceIndex& a_face,const int& varlocin) const;


  const T* dataPtr(const int& a_comp) const;


  T* dataPtr(const int& a_comp) ;


  const int* loVect() const;


  const int* hiVect() const;

  const EBGraph& getEBGraph() const;

  static int preAllocatable()
  {
    return 1; // symmetric allocatable.  
  }

  int size(const Box& R, const Interval& comps) const ;

  void linearOut(void* buf, const Box& R, const Interval& comps) const;

  void linearIn(void* buf, const Box& R, const Interval& comps);

private:
  void
  setDefaultValues();

protected:
  //get index vector<int> at the face location
  //using lexographic ordering of vof's indicies
  int getLocalVecIndex(const FaceIndex& a_face) const;
  //get index into dataPtr
  int getIndex(const FaceIndex& a_face,const int& a_comp) const;
  //has to be a pointer because we are planning to ship
  //the damned  thing to fortran.  
  T* m_dataPtr;
  int m_nComp;
  int m_nFaces;
  int m_direction;
  IntVect m_loVect;
  IntVect m_hiVect;
  // This is how we map from face to vector of data:
  // The low  intvect (by convention)
  // tells you the vector<int>
  // To index into the vector<int> use the lexigraphic
  // ordering of the cellindicies of the VoF (low, high).
  // That tells you the offset into m_dataPtr.
  // you further have to account for the variable number.
  // the getIndex() function encapsulates the process
  BaseFab<Vector<int> > m_ivmap;
  IntVectSet m_ivs;
  EBGraph m_ebgraph;
  bool m_isDefined;
private:
  BaseIFFAB<T>& operator= (const BaseIFFAB<T>&);
  BaseIFFAB (const BaseIFFAB<T>&);
};

#include "BaseIFFABI.H"

#endif

---