DTK_STKMeshEntityIterator.hpp

//---------------------------------------------------------------------------//
/*
  Copyright (c) 2012, Stuart R. Slattery
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:

  *: Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

  *: 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.

  *: Neither the name of the University of Wisconsin - Madison nor the
  names of its contributors may be used to endorse or promote products
  derived from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "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 THE COPYRIGHT
  HOLDER OR 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.
*/
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//

#ifndef DTK_STKMESHENTITYITERATOR_HPP
#define DTK_STKMESHENTITYITERATOR_HPP

#include <functional>
#include <vector>

#include "DTK_Entity.hpp"
#include "DTK_EntityIterator.hpp"
#include "DTK_STKMeshEntityIteratorRange.hpp"

#include <Teuchos_Ptr.hpp>
#include <Teuchos_RCP.hpp>

#include <stk_mesh/base/BulkData.hpp>
#include <stk_mesh/base/Entity.hpp>

namespace DataTransferKit
{
//---------------------------------------------------------------------------//
//---------------------------------------------------------------------------//
class STKMeshEntityIterator : public EntityIterator
{
  public:
    STKMeshEntityIterator();

    STKMeshEntityIterator(
        const Teuchos::RCP<STKMeshEntityIteratorRange> &entity_range,
        const Teuchos::Ptr<stk::mesh::BulkData> &bulk_data,
        const PredicateFunction &predicate );

    STKMeshEntityIterator( const STKMeshEntityIterator &rhs );

    STKMeshEntityIterator &operator=( const STKMeshEntityIterator &rhs );

    // Pre-increment operator.
    EntityIterator &operator++() override;

    // Dereference operator.
    Entity &operator*(void)override;

    // Dereference operator.
    Entity *operator->(void)override;

    // Equal comparison operator.
    bool operator==( const EntityIterator &rhs ) const override;

    // Not equal comparison operator.
    bool operator!=( const EntityIterator &rhs ) const override;

    // An iterator assigned to the first valid element in the iterator.
    EntityIterator begin() const override;

    // An iterator assigned to the end of all elements under the iterator.
    EntityIterator end() const override;

    // Create a clone of the iterator. We need this for the copy constructor
    // and assignment operator to pass along the underlying implementation.
    std::unique_ptr<EntityIterator> clone() const override;

  private:
    // Range of entities over which the iterator is defined.
    Teuchos::RCP<STKMeshEntityIteratorRange> d_entity_range;

    // Iterator over the entities.
    std::vector<stk::mesh::Entity>::const_iterator d_stk_entity_it;

    // The bulk data owning the entities.
    Teuchos::Ptr<stk::mesh::BulkData> d_bulk_data;

    // Current entity.
    Entity d_current_entity;
};

//---------------------------------------------------------------------------//

} // end namespace DataTransferKit

#endif // end DTK_STKMESHENTITYITERATOR_HPP

//---------------------------------------------------------------------------//
// end DTK_STKMeshEntityIterator.hpp
//---------------------------------------------------------------------------//