DataTransferKit - Multiphysics Solution Transfer Services  2.0
DTK_STKMeshEntityLocalMap.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_STKMESHENTITYLOCALMAP_HPP
42 #define DTK_STKMESHENTITYLOCALMAP_HPP
43 
44 #include "DTK_EntityLocalMap.hpp"
45 #include "DTK_IntrepidCell.hpp"
46 
47 #include <Teuchos_ArrayView.hpp>
48 #include <Teuchos_ParameterList.hpp>
49 #include <Teuchos_RCP.hpp>
50 
51 #include <Shards_CellTopology.hpp>
52 
53 #include <Intrepid_FieldContainer.hpp>
54 
55 #include <stk_mesh/base/BulkData.hpp>
56 
57 namespace DataTransferKit
58 {
59 //---------------------------------------------------------------------------//
64 //---------------------------------------------------------------------------//
66 {
67  public:
71  STKMeshEntityLocalMap( const Teuchos::RCP<stk::mesh::BulkData> &bulk_data );
72 
73  /*
74  * \brief Set parameters for mapping.
75  * \param parameters Parameters for mapping.
76  */
77  void setParameters( const Teuchos::ParameterList &parameters ) override;
78 
85  double measure( const Entity &entity ) const override;
86 
92  void centroid( const Entity &entity,
93  const Teuchos::ArrayView<double> &centroid ) const override;
94 
106  const Entity &entity,
107  const Teuchos::ArrayView<const double> &physical_point ) const override;
108 
120  bool mapToReferenceFrame(
121  const Entity &entity,
122  const Teuchos::ArrayView<const double> &physical_point,
123  const Teuchos::ArrayView<double> &reference_point ) const override;
124 
134  bool checkPointInclusion( const Entity &entity,
135  const Teuchos::ArrayView<const double>
136  &reference_point ) const override;
137 
147  void mapToPhysicalFrame(
148  const Entity &entity,
149  const Teuchos::ArrayView<const double> &reference_point,
150  const Teuchos::ArrayView<double> &physical_point ) const override;
151 
165  const Entity &entity, const Entity &parent_entity,
166  const Teuchos::ArrayView<const double> &reference_point,
167  const Teuchos::ArrayView<double> &normal ) const override;
168 
169  private:
170  // Bulk data.
171  Teuchos::RCP<stk::mesh::BulkData> d_bulk_data;
172 
173  // Point inclusion tolerance.
174  double d_inclusion_tol;
175 };
176 
177 //---------------------------------------------------------------------------//
178 
179 } // end namespace DataTransferKit
180 
181 #endif // end DTK_STKMESHENTITYLOCALMAP_HPP
182 
183 //---------------------------------------------------------------------------//
184 // end DTK_STKMeshEntityLocalMap.hpp
185 //---------------------------------------------------------------------------//
Geometric entity interface definition.
Definition: DTK_Entity.hpp:61
Entity forward and reverse local map interface definition.
STK mesh forward and reverse local map implementation.
void mapToPhysicalFrame(const Entity &entity, const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &physical_point) const override
(Forward Map) Map a reference point to the physical space of an entity.
bool checkPointInclusion(const Entity &entity, const Teuchos::ArrayView< const double > &reference_point) const override
Determine if a reference point is in the parameterized space of an entity.
bool isSafeToMapToReferenceFrame(const Entity &entity, const Teuchos::ArrayView< const double > &physical_point) const override
(Safeguard the reverse map) Perform a safeguard check for mapping a point to the reference space of a...
double measure(const Entity &entity) const override
Return the entity measure with respect to the parameteric dimension (volume for a 3D entity...
void centroid(const Entity &entity, const Teuchos::ArrayView< double > &centroid) const override
Return the centroid of the entity.
void normalAtReferencePoint(const Entity &entity, const Entity &parent_entity, const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &normal) const override
Compute the normal on a face (3D) or edge (2D) at a given reference point. A default implementation i...
Manager for Intrepid cell-level operations.
STKMeshEntityLocalMap(const Teuchos::RCP< stk::mesh::BulkData > &bulk_data)
Constructor.
DTK_BasicEntitySet.cpp.
bool mapToReferenceFrame(const Entity &entity, const Teuchos::ArrayView< const double > &physical_point, const Teuchos::ArrayView< double > &reference_point) const override
(Reverse Map) Map a point to the reference space of an entity. Return the parameterized point...