Intrepid2_Orientation.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Intrepid2 Package
//
// Copyright 2007 NTESS and the Intrepid2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __INTREPID2_ORIENTATION_HPP__
#define __INTREPID2_ORIENTATION_HPP__

#include "Intrepid2_ConfigDefs.hpp"
#include "Intrepid2_Types.hpp"
#include "Intrepid2_Utils.hpp"

#include "Shards_CellTopology.hpp"

namespace Intrepid2 {

  class Orientation {
  private:
    template<typename cellVertViewType>
    static void getCellVertexMap(typename cellVertViewType::non_const_value_type *subCellVerts,
                                  ordinal_type &numVerts,
                                  const shards::CellTopology cellTopo,
                                  const cellVertViewType cellVerts,
                                  const ordinal_type subCellDim,
                                  const ordinal_type subCellOrd);
    
    // orientation is always computed on the right-handed coordinates
    template<typename subCellVertType>
    static ordinal_type getOrientation(const subCellVertType subCellVerts[],
                                       const ordinal_type numVerts);


  public:

    template<typename cellVertViewType>
    static Orientation getOrientation(const shards::CellTopology cellTopo,
                                      const cellVertViewType cellVerts,
                                      bool isSide = false);
    
    static ordinal_type getEdgeOrdinalOfFace(const ordinal_type subsubcellOrd,
                                             const ordinal_type subcellOrd,
                                             const shards::CellTopology cellTopo);


    /*
    Function Removed. Use instead Impl::OrientationTools::getRefSubcellTangents
    template<typename refTanViewType>
    static void getReferenceEdgeTangent(const refTanViewType &tanE,
                                        const ordinal_type subcellOrd,
                                        const shards::CellTopology cellTopo,
                                        const ordinal_type ort,
                                        const bool is_normalize = true);
    */
    
    /*
    Function Removed. Use instead Impl::OrientationTools::getRefSubcellTangents
    template<typename refTanViewType>
    static void getReferenceFaceTangents(const refTanViewType &tanU,
                                         const refTanViewType &tanV,
                                         const ordinal_type subcellOrd,
                                         const shards::CellTopology cellTopo,
                                         const ordinal_type ort,
                                         const bool is_normalize = true);
    */

    /*
    Function Removed. Use instead Impl::OrientationTools::getRefSideTangentsAndNormal
    template<typename refNormalViewType>
    static void getReferenceFaceNormal(const refNormalViewType &normalV,
                                       const ordinal_type subcellOrd,
                                       const shards::CellTopology cellTopo,
                                       const ordinal_type ort,
                                       const bool is_normalize = true);
    */

      
  private:
    ordinal_type _edgeOrt, _faceOrt;
    
  public:
    KOKKOS_INLINE_FUNCTION
    Orientation();

    KOKKOS_DEFAULTED_FUNCTION
    Orientation(const Orientation &b) = default;

    KOKKOS_INLINE_FUNCTION
    bool isAlignedToReference() const;

    KOKKOS_INLINE_FUNCTION
    void setEdgeOrientation(const ordinal_type numEdge, const ordinal_type edgeOrt[]);

    KOKKOS_INLINE_FUNCTION
    void getEdgeOrientation(ordinal_type *edgeOrt, const ordinal_type numEdge) const;

    KOKKOS_INLINE_FUNCTION
    void setFaceOrientation(const ordinal_type numFace, const ordinal_type faceOrt[]);

    KOKKOS_INLINE_FUNCTION
    void getFaceOrientation(ordinal_type *faceOrt, const ordinal_type numFace) const;
    
    inline std::string to_string() const;
  };
}

inline std::ostream& operator<<(std::ostream& os, const ::Intrepid2::Orientation& orientation)
{
  os << orientation.to_string();
  return os;
}

// include templated function definitions
#include "Intrepid2_OrientationDef.hpp"

#endif