SundanceExplicitCellIterator.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                             Sundance
//                 Copyright 2011 Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */

#ifndef SUNDANCE_EXPLICITCELLITERATOR_H
#define SUNDANCE_EXPLICITCELLITERATOR_H


#include "SundanceDefs.hpp"
#include "SundanceSet.hpp"
#include "SundanceMap.hpp"
#include "SundanceCellType.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "SundanceMesh.hpp"

namespace Sundance
{
/**
 *
 */
class ExplicitCellIterator
{
public:
  /** */
  ExplicitCellIterator(const Set<int>::const_iterator& iter);
      
  /** Dereferencing operator */
  const int& operator*() const {return *iter_;}
      
  /** Postfix increment: advances iterator and returns previous value  */
  CellIterator operator++(int) 
    {
      CellIterator old = *this;
      iter_++;
      return old;
    }
      

  /** Prefix increment: advances iterator, returning new value */
  CellIterator& operator++()
    {
      iter_++;
      return *this;
    }

  /** */
  bool operator==(const CellIterator& other) const 
    {
      return iter_ == other.iter_;
    }

  /** */
  bool operator!=(const CellIterator& other) const 
    {
      return currentLID_ == other.currentLID_;
    }

      
private:

  /** The LID to which this iterator is currently pointing. */
  int currentLID_;

  /** Unmanaged pointer to the cell set through which this iterator
   * is iterating */
  CellSetBase* cellSet_;

      
      
};

}



#endif