Intrepid2_RealSpaceTools.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), or
//                    Mauro Perego  (mperego@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef __INTREPID2_REALSPACETOOLS_HPP__
#define __INTREPID2_REALSPACETOOLS_HPP__

#include "Intrepid2_ConfigDefs.hpp"

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

#include "Kokkos_Core.hpp"

namespace Intrepid2 {
  
  template<typename DeviceType = void>
  class RealSpaceTools {
  public:

    struct Serial {
      template<typename inVecValueType, class ...inVecProperties>
      KOKKOS_INLINE_FUNCTION
      static inVecValueType
      vectorNorm( const Kokkos::DynRankView<inVecValueType,inVecProperties...> inVec, 
                  const ENorm normType );
      
      template<class MatrixViewType>
      KOKKOS_INLINE_FUNCTION
      static typename MatrixViewType::value_type
      det( const MatrixViewType inMat );

      template<typename inVec1ValueType, class ...inVec1Properties,
               typename inVec2ValueType, class ...inVec2Properties>
      KOKKOS_INLINE_FUNCTION
      static inVec1ValueType
      dot( const Kokkos::DynRankView<inVec1ValueType,inVec1Properties...> inVec1, 
           const Kokkos::DynRankView<inVec2ValueType,inVec2Properties...> inVec2 );
      
    };

    template<typename outputValueType, class ...outputProperties,
             typename inputValueType,  class ...inputProperties>
    static void
    extractScalarValues(       Kokkos::DynRankView<outputValueType,outputProperties...>  output,
                         const Kokkos::DynRankView<inputValueType, inputProperties...>   input );
      
    template<typename outputValueType, class ...outputProperties,
             typename inputValueType,  class ...inputProperties>
    static void
    clone(       Kokkos::DynRankView<outputValueType,outputProperties...> output,
           const Kokkos::DynRankView<inputValueType,inputProperties...>   input );

    template<typename absArrayValueType, class ...absArrayProperties, 
             typename inArrayValueType,  class ...inArrayProperties>
    static void 
    absval(       Kokkos::DynRankView<absArrayValueType,absArrayProperties...> absArray, 
            const Kokkos::DynRankView<inArrayValueType, inArrayProperties...>   inArray );


    template<typename inoutArrayValueType, class ...inoutArrayProperties>
    static void 
    absval( Kokkos::DynRankView<inoutArrayValueType,inoutArrayProperties...> inoutArray );


    template<typename normArrayValueType, class ...normArrayProperties,
             typename inVecValueType,     class ...inVecProperties> 
    static void 
    vectorNorm(       Kokkos::DynRankView<normArrayValueType,normArrayProperties...> normArray, 
                const Kokkos::DynRankView<inVecValueType,    inVecProperties...>     inVecs, 
                const ENorm normType );
    
    template<typename transposeMatValueType, class ...transposeMatProperties,
             typename inMatValueType,        class ...inMatProperties> 
    static void 
    transpose(       Kokkos::DynRankView<transposeMatValueType,transposeMatProperties...> transposeMats, 
               const Kokkos::DynRankView<inMatValueType,       inMatProperties...>        inMats );
    
    template<class InverseMatrixViewType, class MatrixViewType>
    static void 
    inverse( InverseMatrixViewType inverseMats, MatrixViewType inMats );

    template<class DeterminantArrayViewType, class MatrixViewType>
    static void 
    det( DeterminantArrayViewType detArray, const MatrixViewType inMats );
    
    template<typename sumArrayValueType, class ...sumArrayProperties,
             typename inArray1ValueType, class ...inArray1Properties,
             typename inArray2ValueType, class ...inArray2Properties>
    static void
    add(       Kokkos::DynRankView<sumArrayValueType,sumArrayProperties...> sumArray, 
         const Kokkos::DynRankView<inArray1ValueType,inArray1Properties...> inArray1, 
         const Kokkos::DynRankView<inArray2ValueType,inArray2Properties...> inArray2 );

    template<typename inoutSumArrayValueType, class ...inoutSumArrayProperties,
             typename inArrayValueType,       class ...inArrayProperties>
    static void
    add(       Kokkos::DynRankView<inoutSumArrayValueType,inoutSumArrayProperties...> inoutSumArray, 
         const Kokkos::DynRankView<inArrayValueType,      inArrayProperties...>       inArray );

    template<typename diffArrayValueType, class ...diffArrayProperties,
             typename inArray1ValueType,  class ...inArray1Properties,
             typename inArray2ValueType,  class ...inArray2Properties>
    static void
    subtract(       Kokkos::DynRankView<diffArrayValueType,diffArrayProperties...> diffArray, 
              const Kokkos::DynRankView<inArray1ValueType, inArray1Properties...>  inArray1, 
              const Kokkos::DynRankView<inArray2ValueType, inArray2Properties...>  inArray2 );

    template<typename inoutDiffArrayValueType, class ...inoutDiffArrayProperties,
             typename inArrayValueType,        class ...inArrayProperties>
    static void
    subtract(       Kokkos::DynRankView<inoutDiffArrayValueType,inoutDiffArrayProperties...> diffArray,
              const Kokkos::DynRankView<inArrayValueType,       inArrayProperties...>        inArray );

    template<typename ValueType,
             typename scaledArrayValueType, class ...scaledArrayProperties,
             typename inArrayValueType,     class ...inArrayProperties>
    static void
    scale(       Kokkos::DynRankView<scaledArrayValueType,scaledArrayProperties...> scaledArray,
           const Kokkos::DynRankView<inArrayValueType,    inArrayProperties...>     inArray,
           const ValueType alpha );

    template<typename ValueType,
             typename inoutScaledArrayValueType, class ...inoutScaledArrayProperties>
    static void
    scale(       Kokkos::DynRankView<inoutScaledArrayValueType,inoutScaledArrayProperties...> inoutScaledArray,
           const ValueType alpha );
    

    template<typename dotArrayValueType, class ...dotArrayProperties,
             typename inVec1ValueType,   class ...inVec1Properties,
             typename inVec2ValueType,   class ...inVec2Properties>
    static void
    dot(       Kokkos::DynRankView<dotArrayValueType,dotArrayProperties...> dotArray, 
         const Kokkos::DynRankView<inVec1ValueType,  inVec1Properties...>   inVecs1, 
         const Kokkos::DynRankView<inVec2ValueType,  inVec2Properties...>   inVecs2 );

    template<typename matVecValueType, class ...matVecProperties,
             typename inMatValueType,  class ...inMatProperties,
             typename inVecValueType,  class ...inVecProperties>
    static void
    matvec(       Kokkos::DynRankView<matVecValueType,matVecProperties...> matVecs,
            const Kokkos::DynRankView<inMatValueType, inMatProperties...>  inMats,
            const Kokkos::DynRankView<inVecValueType, inVecProperties...>  inVecs );
    
    template<typename outMatValueType, class ...outMatProperties,
             typename inMatValueType,  class ...inMatProperties>
    static void
    AtA(       Kokkos::DynRankView<outMatValueType,outMatProperties...> outMats,
         const Kokkos::DynRankView<inMatValueType, inMatProperties...>  inMats);

    template<typename vecProdValueType, class ...vecProdProperties,
             typename inLeftValueType,  class ...inLeftProperties,
             typename inRightValueType, class ...inRightProperties>
    static void
    vecprod(       Kokkos::DynRankView<vecProdValueType,vecProdProperties...> vecProd,
             const Kokkos::DynRankView<inLeftValueType, inLeftProperties...>  inLeft,
             const Kokkos::DynRankView<inRightValueType,inRightProperties...> inRight );
    
  }; // class RealSpaceTools

} // end namespace Intrepid2

// include templated definitions
#include "Intrepid2_RealSpaceToolsDef.hpp"

#endif