---

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

#ifndef _VolIndex_H_
#define _VolIndex_H_

#include "REAL.H"
#include "IntVect.H"
#include "SPMD.H"


class VolIndex
{
public:
  VolIndex();

  ~VolIndex();

  VolIndex& operator= (const VolIndex& a_vofin);

  bool operator== (const VolIndex& a_vofin) const;

  const IntVect& gridIndex() const;

  const int& cellIndex() const;

  bool isDefined() const;

  VolIndex(const VolIndex& a_vofin);

  void define(const VolIndex& a_vofin);

  VolIndex(const IntVect& a_ix,const  int& a_vofID);

  void define(const IntVect& a_ix,const  int& a_vofID);

  //  not for users
  static size_t iv_offset, index_offset;
  static int initializeOffsets();

private:


  //cell of the VolIndex
  IntVect m_iv;

  //which VoF in the cell (0 to nVoF-1)
  int m_cellIndex;

  bool m_isDefined;
};

std::ostream& operator<< (std::ostream&       os,
                          const VolIndex& iv);


#endif

---