Intrepid2
Intrepid2_Orientation.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Intrepid2 Package
5 // Copyright (2007) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Kyungjoo Kim (kyukim@sandia.gov), or
38 // Mauro Perego (mperego@sandia.gov)
39 //
40 // ************************************************************************
41 // @HEADER
42 
48 #ifndef __INTREPID2_ORIENTATION_HPP__
49 #define __INTREPID2_ORIENTATION_HPP__
50 
51 #include "Intrepid2_ConfigDefs.hpp"
52 #include "Intrepid2_Types.hpp"
53 #include "Intrepid2_Utils.hpp"
54 
55 #include "Shards_CellTopology.hpp"
56 
57 namespace Intrepid2 {
58 
65  class Orientation {
66  private:
67  template<typename elemNodeViewType>
68  static void getElementNodeMap(typename elemNodeViewType::non_const_value_type *subCellVerts,
69  ordinal_type &numVerts,
70  const shards::CellTopology cellTopo,
71  const elemNodeViewType elemNodes,
72  const ordinal_type subCellDim,
73  const ordinal_type subCellOrd);
74 
75  // orientation is always computed on the right-handed coordinates
76  template<typename subCellVertType>
77  static ordinal_type getOrientation(const subCellVertType subCellVerts[],
78  const ordinal_type numVerts);
79 
80 
81  public:
82  template<typename elemNodeViewType>
83  static Orientation getOrientation(const shards::CellTopology cellTopo,
84  const elemNodeViewType elemNodes);
85 
86  static ordinal_type getEdgeOrdinalOfFace(const ordinal_type subsubcellOrd,
87  const ordinal_type subcellOrd,
88  const shards::CellTopology cellTopo);
89 
90 
91  /*
92  Function Removed. Use instead Impl::OrientationTools::getRefSubcellTangents
93  template<typename refTanViewType>
94  static void getReferenceEdgeTangent(const refTanViewType &tanE,
95  const ordinal_type subcellOrd,
96  const shards::CellTopology cellTopo,
97  const ordinal_type ort,
98  const bool is_normalize = true);
99  */
100 
101  /*
102  Function Removed. Use instead Impl::OrientationTools::getRefSubcellTangents
103  template<typename refTanViewType>
104  static void getReferenceFaceTangents(const refTanViewType &tanU,
105  const refTanViewType &tanV,
106  const ordinal_type subcellOrd,
107  const shards::CellTopology cellTopo,
108  const ordinal_type ort,
109  const bool is_normalize = true);
110  */
111 
112  /*
113  Function Removed. Use instead Impl::OrientationTools::getRefSideTangentsAndNormal
114  template<typename refNormalViewType>
115  static void getReferenceFaceNormal(const refNormalViewType &normalV,
116  const ordinal_type subcellOrd,
117  const shards::CellTopology cellTopo,
118  const ordinal_type ort,
119  const bool is_normalize = true);
120  */
121 
122 
123  private:
124  ordinal_type _edgeOrt, _faceOrt;
125 
126  public:
127  KOKKOS_INLINE_FUNCTION
128  Orientation();
129 
130  KOKKOS_DEFAULTED_FUNCTION
131  Orientation(const Orientation &b) = default;
132 
133  KOKKOS_INLINE_FUNCTION
134  bool isAlignedToReference() const;
135 
136  KOKKOS_INLINE_FUNCTION
137  void setEdgeOrientation(const ordinal_type numEdge, const ordinal_type edgeOrt[]);
138 
139  KOKKOS_INLINE_FUNCTION
140  void getEdgeOrientation(ordinal_type *edgeOrt, const ordinal_type numEdge) const;
141 
142  KOKKOS_INLINE_FUNCTION
143  void setFaceOrientation(const ordinal_type numFace, const ordinal_type faceOrt[]);
144 
145  KOKKOS_INLINE_FUNCTION
146  void getFaceOrientation(ordinal_type *faceOrt, const ordinal_type numFace) const;
147 
148  inline std::string to_string() const;
149  };
150 }
151 
152 inline std::ostream& operator<<(std::ostream& os, const ::Intrepid2::Orientation& orientation)
153 {
154  os << orientation.to_string();
155  return os;
156 }
157 
158 // include templated function definitions
160 
161 #endif
Definition file for the Intrepid2::Orientation class.
Header function for Intrepid2::Util class and other utility functions.
Orientation encoding and decoding.
Contains definitions of custom data types in Intrepid2.