Intrepid2_CellGeometry.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//                           Intrepid2 Package
//                 Copyright (2007) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact Kyungjoo Kim  (kyukim@sandia.gov),
//                    Mauro Perego  (mperego@sandia.gov), or
//                    Nate Roberts  (nvrober@sandia.gov),
//
// ************************************************************************
// @HEADER

#ifndef Intrepid2_CellGeometry_h
#define Intrepid2_CellGeometry_h

#include "Intrepid2_Basis.hpp"
#include "Intrepid2_CellTools.hpp"
#include "Intrepid2_Data.hpp"
#include "Intrepid2_NodalBasisFamily.hpp"
#include "Intrepid2_Orientation.hpp"
#include "Intrepid2_OrientationTools.hpp"
#include "Intrepid2_TensorData.hpp"
#include "Intrepid2_TensorPoints.hpp"
#include "Intrepid2_TransformedBasisValues.hpp"
#include "Intrepid2_Utils.hpp"
#include "Intrepid2_VectorData.hpp"

#include "Intrepid2_ScalarView.hpp"

namespace Intrepid2
{
  template<class PointScalar, int spaceDim, typename DeviceType>
  class CellGeometry
  {
    public:
    enum CellGeometryType {
        UNIFORM_GRID   
      , TENSOR_GRID    
      , EXTRUDED_GRID  
      , FIRST_ORDER    
      , HIGHER_ORDER   
    };
    
    enum SubdivisionStrategy
    {
        NO_SUBDIVISION      
      , TWO_TRIANGLES_RIGHT 
      , TWO_TRIANGLES_LEFT  
      , FOUR_TRIANGLES      
      , FIVE_TETRAHEDRA     
      , SIX_TETRAHEDRA      
      , SIX_PYRAMIDS        
    };
    
    enum HypercubeNodeOrdering
    {
        HYPERCUBE_NODE_ORDER_CLASSIC_SHARDS 
      , HYPERCUBE_NODE_ORDER_TENSOR         
    };
    
    KOKKOS_INLINE_FUNCTION
    int numCellsPerGridCell(SubdivisionStrategy subdivisionStrategy) const;
    
  public:
    Data<PointScalar,DeviceType> allocateJacobianDataPrivate(const ScalarView<PointScalar,DeviceType> &pointComponentView, const int &pointsPerCell, const int startCell, const int endCell) const;
    
    void setJacobianDataPrivate(Data<PointScalar,DeviceType> &jacobianData, const int &pointsPerCell, const Data<PointScalar,DeviceType> &refData, const int startCell, const int endCell) const;
  protected:
    HypercubeNodeOrdering nodeOrdering_;
    CellGeometryType    cellGeometryType_;
    SubdivisionStrategy subdivisionStrategy_ = NO_SUBDIVISION;
    bool affine_; // if true, each cell has constant Jacobian across the cell
    Data<Orientation, DeviceType> orientations_; // for grid types, this could have either a single entry or one matching numCellsPerGridCell().  For other types, it has as many entries as there are cells.
    
    // uniform grid data -- used for UNIFORM_GRID type
    Kokkos::Array<PointScalar,spaceDim> origin_;         // point specifying a corner of the mesh
    Kokkos::Array<PointScalar,spaceDim> domainExtents_;  // how far the domain extends in each dimension
    Kokkos::Array<int,spaceDim>         gridCellCounts_; // how many grid cells wide the mesh is in each dimension
    
    // tensor grid data -- only used for TENSOR_GRID type
    TensorPoints<PointScalar, DeviceType> tensorVertices_;
    
    // arbitrary cell node data, used for both higher-order and first-order
    // (here, nodes are understood as geometry degrees of freedom)
    ScalarView<int,DeviceType>         cellToNodes_; // (C,N) -- N is the number of nodes per cell; values are global node ordinals
    ScalarView<PointScalar,DeviceType> nodes_;       // (GN,D) or (C,N,D) -- GN is the number of global nodes; (C,N,D) used only if cellToNodes_ is empty.
    using BasisPtr = Teuchos::RCP< Basis<DeviceType,PointScalar,PointScalar> >;
    
    unsigned numCells_        = 0;
    unsigned numNodesPerCell_ = 0;
  public:
    CellGeometry(const Kokkos::Array<PointScalar,spaceDim> &origin,
                 const Kokkos::Array<PointScalar,spaceDim> &domainExtents,
                 const Kokkos::Array<int,spaceDim> &gridCellCounts,
                 SubdivisionStrategy subdivisionStrategy = NO_SUBDIVISION,
                 HypercubeNodeOrdering nodeOrdering = HYPERCUBE_NODE_ORDER_TENSOR);
    
    CellGeometry(const shards::CellTopology &cellTopo,
                 ScalarView<int,DeviceType> cellToNodes,
                 ScalarView<PointScalar,DeviceType> nodes,
                 const bool claimAffine = false,
                 const HypercubeNodeOrdering nodeOrdering = HYPERCUBE_NODE_ORDER_CLASSIC_SHARDS);

    CellGeometry(Teuchos::RCP<Intrepid2::Basis<DeviceType,PointScalar,PointScalar> > basisForNodes,
                 ScalarView<PointScalar,DeviceType> cellNodes);
    
    KOKKOS_INLINE_FUNCTION CellGeometry(const CellGeometry &cellGeometry);
    
    KOKKOS_INLINE_FUNCTION ~CellGeometry();
    
    KOKKOS_INLINE_FUNCTION
    bool affine() const;
    
    TensorData<PointScalar,DeviceType> allocateCellMeasure( const Data<PointScalar,DeviceType> & jacobianDet, const TensorData<PointScalar,DeviceType> & cubatureWeights ) const;
    
    void computeCellMeasure( TensorData<PointScalar,DeviceType> &cellMeasure, const Data<PointScalar,DeviceType> & jacobianDet, const TensorData<PointScalar,DeviceType> & cubatureWeights ) const;
    
    BasisPtr basisForNodes() const;
    
    const shards::CellTopology & cellTopology() const;
    
    KOKKOS_INLINE_FUNCTION
    ordinal_type cellToNode(ordinal_type cellIndex, ordinal_type cellNodeNumber) const;
    
    KOKKOS_INLINE_FUNCTION
    DataVariationType cellVariationType() const;
    
    KOKKOS_INLINE_FUNCTION
    int hypercubeComponentNodeNumber(int hypercubeNodeNumber, int d) const;
    
    void initializeOrientations();
    
    KOKKOS_INLINE_FUNCTION
    size_t extent(const int& r) const;
    
    template <typename iType>
    KOKKOS_INLINE_FUNCTION
    typename std::enable_if<std::is_integral<iType>::value, int>::type
    extent_int(const iType& r) const;
    
    KOKKOS_INLINE_FUNCTION
    HypercubeNodeOrdering nodeOrderingForHypercubes() const;
    
    KOKKOS_INLINE_FUNCTION
    int numCells() const;
    
    KOKKOS_INLINE_FUNCTION
    int numCellsInDimension(const int &dim) const;
    
    KOKKOS_INLINE_FUNCTION
    int numNodesPerCell() const;
    
    KOKKOS_INLINE_FUNCTION
    Orientation getOrientation(int &cellNumber) const;
    
    Data<Orientation,DeviceType> getOrientations();
    
    void orientations(ScalarView<Orientation,DeviceType> orientationsView, const int &startCell = 0, const int &endCell = -1);
    
    KOKKOS_INLINE_FUNCTION
    PointScalar gridCellCoordinate(const int &gridCellOrdinal, const int &localNodeNumber, const int &dim) const;
    
    KOKKOS_INLINE_FUNCTION
    unsigned rank() const;
    
    KOKKOS_INLINE_FUNCTION
    int gridCellNodeForSubdivisionNode(const int &gridCellOrdinal, const int &subdivisionOrdinal,
                                       const int &subdivisionNodeNumber) const;
    
    KOKKOS_INLINE_FUNCTION
    PointScalar subdivisionCoordinate(const int &gridCellOrdinal, const int &subdivisionOrdinal,
                                      const int &subdivisionNodeNumber, const int &d) const;
    
    KOKKOS_INLINE_FUNCTION
    PointScalar
    operator()(const int& cell, const int& node, const int& dim) const;
    
    KOKKOS_INLINE_FUNCTION
    int uniformJacobianModulus() const;
    
    Data<PointScalar,DeviceType> allocateJacobianData(const TensorPoints<PointScalar,DeviceType> &points, const int startCell=0, const int endCell=-1) const;
    
    Data<PointScalar,DeviceType> allocateJacobianData(const ScalarView<PointScalar,DeviceType> &points, const int startCell=0, const int endCell=-1) const;
    
    Data<PointScalar,DeviceType> allocateJacobianData(const int &numPoints, const int startCell=0, const int endCell=-1) const;
    
    Data<PointScalar,DeviceType> getJacobianRefData(const ScalarView<PointScalar,DeviceType> &points) const;
    
    Data<PointScalar,DeviceType> getJacobianRefData(const TensorPoints<PointScalar,DeviceType> &points) const;
    
    void setJacobian(Data<PointScalar,DeviceType> &jacobianData, const TensorPoints<PointScalar,DeviceType> &points, const Data<PointScalar,DeviceType> &refData,
                     const int startCell=0, const int endCell=-1) const;
    
    void setJacobian(Data<PointScalar,DeviceType> &jacobianData, const ScalarView<PointScalar,DeviceType> &points, const Data<PointScalar,DeviceType> &refData,
                     const int startCell=0, const int endCell=-1) const;
    
    void setJacobian(Data<PointScalar,DeviceType> &jacobianData, const int &numPoints, const int startCell=0, const int endCell=-1) const;
  };
} // namespace Intrepid2

#include <Intrepid2_CellGeometryDef.hpp>

#endif /* Intrepid2_CellGeometry_h */