DataTransferKit - Multiphysics Solution Transfer Services  2.0
DTK_STKMeshEntitySet.hpp
1 //---------------------------------------------------------------------------//
2 /*
3  Copyright (c) 2012, Stuart R. Slattery
4  All rights reserved.
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are
8  met:
9 
10  *: Redistributions of source code must retain the above copyright
11  notice, this list of conditions and the following disclaimer.
12 
13  *: Redistributions in binary form must reproduce the above copyright
14  notice, this list of conditions and the following disclaimer in the
15  documentation and/or other materials provided with the distribution.
16 
17  *: Neither the name of the University of Wisconsin - Madison nor the
18  names of its contributors may be used to endorse or promote products
19  derived from this software without specific prior written permission.
20 
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33 //---------------------------------------------------------------------------//
39 //---------------------------------------------------------------------------//
40 
41 #ifndef DTK_STKMESHENTITYSET_HPP
42 #define DTK_STKMESHENTITYSET_HPP
43 
44 #include <functional>
45 
46 #include "DTK_Entity.hpp"
47 #include "DTK_EntityIterator.hpp"
48 #include "DTK_EntitySet.hpp"
49 #include "DTK_Types.hpp"
50 
51 #include <Teuchos_Array.hpp>
52 #include <Teuchos_Comm.hpp>
53 #include <Teuchos_RCP.hpp>
54 #include <Teuchos_Tuple.hpp>
55 
56 #include <stk_mesh/base/BulkData.hpp>
57 
58 namespace DataTransferKit
59 {
60 //---------------------------------------------------------------------------//
67 //---------------------------------------------------------------------------//
69 {
70  public:
74  STKMeshEntitySet( const Teuchos::RCP<stk::mesh::BulkData> &bulk_data );
75 
77 
82  Teuchos::RCP<const Teuchos::Comm<int>> communicator() const override;
84 
86 
92  int physicalDimension() const override;
94 
96 
104  void getEntity( const EntityId entity_id, const int topological_dimension,
105  Entity &entity ) const override;
106 
116  entityIterator( const int topological_dimension,
117  const PredicateFunction &predicate ) const override;
118 
123  void getAdjacentEntities(
124  const Entity &entity, const int adjacent_dimension,
125  Teuchos::Array<Entity> &adjacent_entities ) const override;
127 
128  private:
129  // Mesh bulk data.
130  Teuchos::RCP<stk::mesh::BulkData> d_bulk_data;
131 };
132 
133 //---------------------------------------------------------------------------//
134 
135 } // end namespace DataTransferKit
136 
137 #endif // end DTK_STKMESHENTITYSET_HPP
138 
139 //---------------------------------------------------------------------------//
140 // end DTK_STKMeshEntitySet.hpp
141 //---------------------------------------------------------------------------//
Geometric entity interface definition.
Definition: DTK_Entity.hpp:61
Entity iterator interface.
void getEntity(const EntityId entity_id, const int topological_dimension, Entity &entity) const override
Entity access functions.
STKMeshEntitySet(const Teuchos::RCP< stk::mesh::BulkData > &bulk_data)
Constructor.
EntityIterator entityIterator(const int topological_dimension, const PredicateFunction &predicate) const override
Get a iterator of the given entity type that satisfy the given predicate.
void getAdjacentEntities(const Entity &entity, const int adjacent_dimension, Teuchos::Array< Entity > &adjacent_entities) const override
Given an entity, get the entities of the given topological dimension that are adjacent to it...
Geometric entity set interface definition.
std::function< bool(Entity)> PredicateFunction
Predicate function typedef.
Definition: DTK_Types.hpp:64
unsigned long int EntityId
Entity id type.
Definition: DTK_Types.hpp:50
int physicalDimension() const override
Geometric data functions.
Teuchos::RCP< const Teuchos::Comm< int > > communicator() const override
Parallel functions.
DTK_BasicEntitySet.cpp.