IProductWRTDerivBase.cpp

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: IProductWRTDerivBase.cpp
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: IProductWRTDerivBase operator implementations
//
///////////////////////////////////////////////////////////////////////////////
 
#include <boost/core/ignore_unused.hpp>
 
#include <MatrixFreeOps/Operator.hpp>
 
#include <Collections/Collection.h>
#include <Collections/IProduct.h>
#include <Collections/MatrixFreeBase.h>
#include <Collections/Operator.h>
 
using namespace std;
 
namespace Nektar
{
namespace Collections
{
 
using LibUtilities::eHexahedron;
using LibUtilities::ePrism;
using LibUtilities::ePyramid;
using LibUtilities::eQuadrilateral;
using LibUtilities::eSegment;
using LibUtilities::eTetrahedron;
using LibUtilities::eTriangle;
 
/**
 * @brief Inner product WRT deriv base operator using standard matrix approach
 */
class IProductWRTDerivBase_StdMat final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_StdMat)
 
    ~IProductWRTDerivBase_StdMat() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        int nPhys  = m_stdExp->GetTotPoints();
        int ntot   = m_numElmt * nPhys;
        int nmodes = m_stdExp->GetNcoeffs();
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output;
        Array<OneD, Array<OneD, NekDouble>> tmp(3);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = (m_coordim == 3) ? entry3 : (m_coordim == 2) ? entry2 : entry1;
 
        for (int i = 0; i < m_dim; ++i)
        {
            tmp[i] = wsp + i * ntot;
        }
 
        // calculate Iproduct WRT Std Deriv
 
        // First component
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
            for (int i = 0; i < m_dim; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < m_coordim; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + j * m_dim], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
 
            Vmath::Vmul(ntot, m_jac, 1, tmp[0], 1, tmp[0], 1);
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
                for (int i = 0; i < m_dim; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < m_coordim; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + j * m_dim][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
 
                Vmath::Smul(m_nqe, m_jac[e], tmp[0] + e * m_nqe, 1,
                            t = tmp[0] + e * m_nqe, 1);
            }
        }
 
        Blas::Dgemm('N', 'N', m_iProdWRTStdDBase[0]->GetRows(), m_numElmt,
                    m_iProdWRTStdDBase[0]->GetColumns(), 1.0,
                    m_iProdWRTStdDBase[0]->GetRawPtr(),
                    m_iProdWRTStdDBase[0]->GetRows(), tmp[0].get(), nPhys, 0.0,
                    output.get(), nmodes);
 
        // Other components
        for (int i = 1; i < m_dim; ++i)
        {
            if (m_isDeformed)
            {
                Vmath::Vmul(ntot, m_jac, 1, tmp[i], 1, tmp[i], 1);
            }
            else
            {
                Array<OneD, NekDouble> t;
                for (int e = 0; e < m_numElmt; ++e)
                {
                    Vmath::Smul(m_nqe, m_jac[e], tmp[i] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                }
            }
            Blas::Dgemm('N', 'N', m_iProdWRTStdDBase[i]->GetRows(), m_numElmt,
                        m_iProdWRTStdDBase[i]->GetColumns(), 1.0,
                        m_iProdWRTStdDBase[i]->GetRawPtr(),
                        m_iProdWRTStdDBase[i]->GetRows(), tmp[i].get(), nPhys,
                        1.0, output.get(), nmodes);
        }
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    Array<OneD, DNekMatSharedPtr> m_iProdWRTStdDBase;
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, const NekDouble> m_jac;
    int m_dim;
    int m_coordim;
 
private:
    IProductWRTDerivBase_StdMat(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors)
    {
        LibUtilities::PointsKeyVector PtsKey = m_stdExp->GetPointsKeys();
        m_dim                                = PtsKey.size();
        m_coordim                            = pCollExp[0]->GetCoordim();
 
        m_nqe      = m_stdExp->GetTotPoints();
        int nmodes = m_stdExp->GetNcoeffs();
 
        // set up a IProductWRTDerivBase StdMat.
        m_iProdWRTStdDBase = Array<OneD, DNekMatSharedPtr>(m_dim);
        for (int i = 0; i < m_dim; ++i)
        {
            Array<OneD, NekDouble> tmp(m_nqe), tmp1(nmodes);
            m_iProdWRTStdDBase[i] =
                MemoryManager<DNekMat>::AllocateSharedPtr(nmodes, m_nqe);
            for (int j = 0; j < m_nqe; ++j)
            {
                Vmath::Zero(m_nqe, tmp, 1);
                tmp[j] = 1.0;
                m_stdExp->IProductWRTDerivBase(i, tmp, tmp1);
                Vmath::Vcopy(nmodes, &tmp1[0], 1,
                             &(m_iProdWRTStdDBase[i]->GetPtr())[0] + j * nmodes,
                             1);
            }
        }
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
        m_jac      = pGeomData->GetJac(pCollExp);
        m_wspSize  = m_dim * m_nqe * m_numElmt;
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_StdMat operators
OperatorKey IProductWRTDerivBase_StdMat::m_typeArr[] = {
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eSegment, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create, "IProductWRTDerivBase_StdMat_Seg"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create, "IProductWRTDerivBase_StdMat_Tri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eStdMat, true),
        IProductWRTDerivBase_StdMat::create,
        "IProductWRTDerivBase_StdMat_NodalTri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eQuadrilateral, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create,
        "IProductWRTDerivBase_StdMat_Quad"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create, "IProductWRTDerivBase_StdMat_Tet"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eStdMat, true),
        IProductWRTDerivBase_StdMat::create,
        "IProductWRTDerivBase_StdMat_NodalTet"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePyramid, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create, "IProductWRTDerivBase_StdMat_Pyr"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create,
        "IProductWRTDerivBase_StdMat_Prism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eStdMat, true),
        IProductWRTDerivBase_StdMat::create,
        "IProductWRTDerivBase_StdMat_NodalPrism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eHexahedron, eIProductWRTDerivBase, eStdMat, false),
        IProductWRTDerivBase_StdMat::create, "IProductWRTDerivBase_StdMat_Hex"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePyramid, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_StdMat::create,
        "IProductWRTDerivBase_SumFac_Pyr")};
 
/**
 * @brief Inner product operator using operator using matrix free operators.
 */
class IProductWRTDerivBase_MatrixFree final : public Operator,
                                              MatrixFreeMultiInOneOut
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_MatrixFree)
 
    ~IProductWRTDerivBase_MatrixFree() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(wsp);
 
        Array<OneD, NekDouble> output;
 
        if (m_isPadded)
        {
            // copy into padded vector
            switch (m_coordim)
            {
                case 1:
                    output = entry1;
                    Vmath::Vcopy(m_nIn, entry0, 1, m_input[0], 1);
                    break;
                case 2:
                    output = entry2;
                    Vmath::Vcopy(m_nIn, entry0, 1, m_input[0], 1);
                    Vmath::Vcopy(m_nIn, entry1, 1, m_input[1], 1);
                    break;
                case 3:
                    output = entry3;
                    Vmath::Vcopy(m_nIn, entry0, 1, m_input[0], 1);
                    Vmath::Vcopy(m_nIn, entry1, 1, m_input[1], 1);
                    Vmath::Vcopy(m_nIn, entry2, 1, m_input[2], 1);
                    break;
                default:
                    NEKERROR(ErrorUtil::efatal, "m_coordim value not valid");
                    break;
            }
 
            // call op
            (*m_oper)(m_input, m_output);
            // copy out of padded vector
            Vmath::Vcopy(m_nOut, m_output, 1, output, 1);
        }
        else
        {
            Array<OneD, Array<OneD, NekDouble>> input{m_coordim};
 
            // copy into padded vector
            switch (m_coordim)
            {
                case 1:
                    output   = entry1;
                    input[0] = entry0;
                    break;
                case 2:
                    output   = entry2;
                    input[0] = entry0;
                    input[1] = entry1;
                    break;
                case 3:
                    output   = entry3;
                    input[0] = entry0;
                    input[1] = entry1;
                    input[2] = entry2;
                    break;
                default:
                    NEKERROR(ErrorUtil::efatal, "coordim not valid");
                    break;
            }
 
            (*m_oper)(input, output);
        }
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
private:
    std::shared_ptr<MatrixFree::IProductWRTDerivBase> m_oper;
 
    IProductWRTDerivBase_MatrixFree(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          MatrixFreeMultiInOneOut(pCollExp[0]->GetCoordim(),
                                  pCollExp[0]->GetStdExp()->GetTotPoints(),
                                  pCollExp[0]->GetStdExp()->GetNcoeffs(),
                                  pCollExp.size())
    {
        // Check if deformed
        const auto dim = pCollExp[0]->GetStdExp()->GetShapeDimension();
 
        // Basis vector
        std::vector<LibUtilities::BasisSharedPtr> basis(dim);
        for (unsigned int i = 0; i < dim; ++i)
        {
            basis[i] = pCollExp[0]->GetBasis(i);
        }
 
        // Get shape type
        auto shapeType = pCollExp[0]->GetStdExp()->DetShapeType();
 
        // Generate operator string and create operator.
        std::string op_string = "IProductWRTDerivBase";
        op_string += MatrixFree::GetOpstring(shapeType, m_isDeformed);
        auto oper = MatrixFree::GetOperatorFactory().CreateInstance(
            op_string, basis, m_nElmtPad);
 
        // Set Jacobian
        oper->SetJac(pGeomData->GetJacInterLeave(pCollExp, m_nElmtPad));
 
        // Set derivative factors
        oper->SetDF(pGeomData->GetDerivFactorsInterLeave(pCollExp, m_nElmtPad));
 
        m_oper =
            std::dynamic_pointer_cast<MatrixFree::IProductWRTDerivBase>(oper);
        ASSERTL0(m_oper, "Failed to cast pointer.");
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_MatrixFree operators
OperatorKey IProductWRTDerivBase_MatrixFree::m_typeArr[] = {
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eSegment, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Seg"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eQuadrilateral, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Quad"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Tri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eHexahedron, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Hex"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Prism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePyramid, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Pyr"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eMatrixFree, false),
        IProductWRTDerivBase_MatrixFree::create,
        "IProductWRTDerivBase_MatrixFree_Tet")};
 
/**
 * @brief Inner product WRT deriv base operator using element-wise operation
 */
class IProductWRTDerivBase_IterPerExp final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_IterPerExp)
 
    ~IProductWRTDerivBase_IterPerExp() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, tmp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(3);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = (m_coordim == 3) ? entry3 : (m_coordim == 2) ? entry2 : entry1;
 
        for (int i = 0; i < m_dim; ++i)
        {
            tmp[i] = wsp + i * nmax;
        }
 
        // calculate Iproduct WRT Std Deriv
        // first component
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[2] + dz/dxi in[3]
            for (int i = 0; i < m_dim; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < m_coordim; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + j * m_dim], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
 
            Vmath::Vmul(ntot, m_jac, 1, tmp[0], 1, tmp[0], 1);
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
                for (int i = 0; i < m_dim; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < m_coordim; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + j * m_dim][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
 
                Vmath::Smul(m_nqe, m_jac[e], tmp[0] + e * m_nqe, 1,
                            t = tmp[0] + e * m_nqe, 1);
            }
        }
 
        for (int n = 0; n < m_numElmt; ++n)
        {
            m_stdExp->IProductWRTDerivBase(0, tmp[0] + n * nPhys,
                                           tmp1 = output + n * nmodes);
        }
 
        // other components
        for (int i = 1; i < m_dim; ++i)
        {
            // multiply by Jacobian
            if (m_isDeformed)
            {
                Vmath::Vmul(ntot, m_jac, 1, tmp[i], 1, tmp[i], 1);
            }
            else
            {
                Array<OneD, NekDouble> t;
                for (int e = 0; e < m_numElmt; ++e)
                {
                    Vmath::Smul(m_nqe, m_jac[e], tmp[i] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                }
            }
 
            for (int n = 0; n < m_numElmt; ++n)
            {
                m_stdExp->IProductWRTDerivBase(i, tmp[i] + n * nPhys, tmp[0]);
                Vmath::Vadd(nmodes, tmp[0], 1, output + n * nmodes, 1,
                            tmp1 = output + n * nmodes, 1);
            }
        }
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, const NekDouble> m_jac;
    int m_dim;
    int m_coordim;
 
private:
    IProductWRTDerivBase_IterPerExp(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors)
    {
        LibUtilities::PointsKeyVector PtsKey = m_stdExp->GetPointsKeys();
        m_dim                                = PtsKey.size();
        m_coordim                            = pCollExp[0]->GetCoordim();
 
        m_nqe = m_stdExp->GetTotPoints();
 
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
        m_jac      = pGeomData->GetJac(pCollExp);
        m_wspSize  = m_dim * m_nqe * m_numElmt;
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_IterPerExp operators
OperatorKey IProductWRTDerivBase_IterPerExp::m_typeArr[] = {
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eSegment, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Seg"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Tri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eIterPerExp, true),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_NodalTri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eQuadrilateral, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Quad"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Tet"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eIterPerExp, true),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_NodalTet"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePyramid, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Pyr"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Prism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eIterPerExp, true),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_NodalPrism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eHexahedron, eIProductWRTDerivBase, eIterPerExp, false),
        IProductWRTDerivBase_IterPerExp::create,
        "IProductWRTDerivBase_IterPerExp_Hex")};
 
/**
 * @brief Inner product WRT deriv base operator using LocalRegions
 * implementation.
 */
class IProductWRTDerivBase_NoCollection final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_NoCollection)
 
    ~IProductWRTDerivBase_NoCollection() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(wsp);
 
        unsigned int nmodes = m_expList[0]->GetNcoeffs();
        unsigned int nPhys  = m_expList[0]->GetTotPoints();
        Array<OneD, NekDouble> tmp(nmodes), tmp1;
 
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output;
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = (m_coordim == 3) ? entry3 : (m_coordim == 2) ? entry2 : entry1;
 
        for (int n = 0; n < m_numElmt; ++n)
        {
            m_expList[n]->IProductWRTDerivBase(0, in[0] + n * nPhys,
                                               tmp1 = output + n * nmodes);
        }
 
        for (int i = 1; i < m_dim; ++i)
        {
            for (int n = 0; n < m_numElmt; ++n)
            {
                m_expList[n]->IProductWRTDerivBase(i, in[i] + n * nPhys, tmp);
 
                Vmath::Vadd(nmodes, tmp, 1, output + n * nmodes, 1,
                            tmp1 = output + n * nmodes, 1);
            }
        }
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    int m_dim;
    int m_coordim;
    vector<StdRegions::StdExpansionSharedPtr> m_expList;
 
private:
    IProductWRTDerivBase_NoCollection(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors)
    {
        m_expList = pCollExp;
        m_dim     = pCollExp[0]->GetNumBases();
        m_coordim = pCollExp[0]->GetCoordim();
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_NoCollection operators
OperatorKey IProductWRTDerivBase_NoCollection::m_typeArr[] = {
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eSegment, eIProductWRTDerivBase, eNoCollection, false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Seg"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eNoCollection, false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Tri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eNoCollection, true),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_NodalTri"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eQuadrilateral, eIProductWRTDerivBase, eNoCollection,
                    false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Quad"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eNoCollection, false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Tet"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eNoCollection, true),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_NodalTet"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePyramid, eIProductWRTDerivBase, eNoCollection, false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Pyr"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eNoCollection, false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Prism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eNoCollection, true),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_NodalPrism"),
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eHexahedron, eIProductWRTDerivBase, eNoCollection, false),
        IProductWRTDerivBase_NoCollection::create,
        "IProductWRTDerivBase_NoCollection_Hex")};
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation
 * (Segment)
 */
class IProductWRTDerivBase_SumFac_Seg final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Seg)
 
    ~IProductWRTDerivBase_SumFac_Seg() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output;
 
        output = (m_coordim == 3) ? entry3 : (m_coordim == 2) ? entry2 : entry1;
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
        if (m_isDeformed)
        {
            Vmath::Vmul(m_wspSize, m_derivFac[0], 1, in[0], 1, wsp, 1);
            for (int i = 1; i < m_coordim; ++i)
            {
                Vmath::Vvtvp(m_wspSize, m_derivFac[i], 1, in[i], 1, wsp, 1, wsp,
                             1);
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                Vmath::Smul(m_nquad0, m_derivFac[0][e], in[0] + e * m_nquad0, 1,
                            t = wsp + e * m_nquad0, 1);
            }
 
            for (int i = 1; i < m_coordim; ++i)
            {
                for (int e = 0; e < m_numElmt; ++e)
                {
                    Vmath::Svtvp(m_nquad0, m_derivFac[i][e],
                                 in[i] + e * m_nquad0, 1, wsp + e * m_nquad0, 1,
                                 t = wsp + e * m_nquad0, 1);
                }
            }
        }
 
        Vmath::Vmul(m_wspSize, m_jacWStdW, 1, wsp, 1, wsp, 1);
 
        // out = B0*in;
        Blas::Dgemm('T', 'N', m_nmodes0, m_numElmt, m_nquad0, 1.0,
                    m_derbase0.get(), m_nquad0, &wsp[0], m_nquad0, 0.0,
                    &output[0], m_nmodes0);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nmodes0;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_derbase0;
    Array<TwoD, const NekDouble> m_derivFac;
    int m_coordim;
 
private:
    IProductWRTDerivBase_SumFac_Seg(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata())
    {
        m_coordim  = pCollExp[0]->GetCoordim();
        m_wspSize  = m_numElmt * m_nquad0;
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Seg operator
OperatorKey IProductWRTDerivBase_SumFac_Seg::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eSegment, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Seg::create,
        "IProductWRTDerivBase_SumFac_Seg");
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation (Quad)
 */
class IProductWRTDerivBase_SumFac_Quad final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Quad)
 
    ~IProductWRTDerivBase_SumFac_Quad() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, wsp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(2);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = (m_coordim == 2) ? entry2 : entry3;
 
        tmp[0] = wsp;
        tmp[1] = wsp + nmax;
        wsp1   = wsp + 2 * nmax;
 
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[1]
            for (int i = 0; i < 2; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < m_coordim; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + 2 * j], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1]
                for (int i = 0; i < 2; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < m_coordim; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + 2 * j][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
            }
        }
        // Iproduct wrt derivative of base 1
        QuadIProduct(false, m_colldir1, m_numElmt, m_nquad0, m_nquad1,
                     m_nmodes0, m_nmodes1, m_derbase0, m_base1, m_jacWStdW,
                     tmp[0], output, wsp1);
 
        // Iproduct wrt derivative of base 1
        QuadIProduct(m_colldir0, false, m_numElmt, m_nquad0, m_nquad1,
                     m_nmodes0, m_nmodes1, m_base0, m_derbase1, m_jacWStdW,
                     tmp[1], tmp[0], wsp1);
 
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nquad1;
    const int m_nmodes0;
    const int m_nmodes1;
    const bool m_colldir0;
    const bool m_colldir1;
    int m_coordim;
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_base0;
    Array<OneD, const NekDouble> m_base1;
    Array<OneD, const NekDouble> m_derbase0;
    Array<OneD, const NekDouble> m_derbase1;
 
private:
    IProductWRTDerivBase_SumFac_Quad(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nquad1(m_stdExp->GetNumPoints(1)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_nmodes1(m_stdExp->GetBasisNumModes(1)),
          m_colldir0(m_stdExp->GetBasis(0)->Collocation()),
          m_colldir1(m_stdExp->GetBasis(1)->Collocation()),
          m_base0(m_stdExp->GetBasis(0)->GetBdata()),
          m_base1(m_stdExp->GetBasis(1)->GetBdata()),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
          m_derbase1(m_stdExp->GetBasis(1)->GetDbdata())
    {
        LibUtilities::PointsKeyVector PtsKey = m_stdExp->GetPointsKeys();
        m_coordim                            = pCollExp[0]->GetCoordim();
 
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
        m_wspSize =
            4 * m_numElmt * (max(m_nquad0 * m_nquad1, m_nmodes0 * m_nmodes1));
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Quad operator
OperatorKey IProductWRTDerivBase_SumFac_Quad::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eQuadrilateral, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Quad::create,
        "IProductWRTDerivBase_IterPerExp_Quad");
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation (Tri)
 */
class IProductWRTDerivBase_SumFac_Tri final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Tri)
 
    ~IProductWRTDerivBase_SumFac_Tri() final
    {
    }
 
    /**
     * This method calculates:
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1])  \f]
     *
     * which can be represented in terms of local cartesian
     * derivaties as:
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dx +
     *       d\phi/d\xi_1\, d\xi_1/dx),in[0]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dy +
     *       d\phi/d\xi_1\, d\xi_1/dy),in[1]) + \f]
     *
     * where we note that
     *
     * \f[ d\phi/d\xi_0 =  d\phi/d\eta_0\, d\eta_0/d\xi_0 =
     *        d\phi/d\eta_0 2/(1-\eta_1) \f]
     *
     * \f[ d\phi/d\xi_1  = d\phi/d\eta_1\, d\eta_1/d\xi_1 +
     *   d\phi/d\eta_1\, d\eta_1/d\xi_1 = d\phi/d\eta_0 (1+\eta_0)/(1-\eta_1)
     *   + d\phi/d\eta_1 \f]
     *
     *  and so the full inner products are
     *
     * \f[ (d\phi/dx,in[0]) + (dphi/dy,in[1]) =
     *   (d\phi/d\eta_0, ((2/(1-\eta_1) (d\xi_0/dx in[0] + d\xi_0/dy in[1])
     *    + (1-\eta_0)/(1-\eta_1) (d\xi_1/dx in[0]+d\xi_1/dy in[1]))
     *    + (d\phi/d\eta_1, (d\xi_1/dx in[0] + d\xi_1/dy in[1])) \f]
     *
     */
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, wsp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(2);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = (m_coordim == 2) ? entry2 : entry3;
 
        tmp[0] = wsp;
        tmp[1] = wsp + nmax;
        wsp1   = wsp + 2 * nmax;
 
        if (m_isDeformed)
        {
            for (int i = 0; i < 2; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < m_coordim; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + 2 * j], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1]
                for (int i = 0; i < 2; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < m_coordim; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + 2 * j][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
            }
        }
 
        // Multiply by factor: 2/(1-z1)
        for (int i = 0; i < m_numElmt; ++i)
        {
            // scale tmp[0] by geometric factor: 2/(1-z1)
            Vmath::Vmul(nPhys, &m_fac0[0], 1, tmp[0].get() + i * nPhys, 1,
                        tmp[0].get() + i * nPhys, 1);
 
            // scale tmp[1] by geometric factor (1+z0)/(1-z1)
            Vmath::Vvtvp(nPhys, &m_fac1[0], 1, tmp[1].get() + i * nPhys, 1,
                         tmp[0].get() + i * nPhys, 1, tmp[0].get() + i * nPhys,
                         1);
        }
 
        // Iproduct wrt derivative of base 0
        TriIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nmodes0,
                    m_nmodes1, m_derbase0, m_base1, m_jacWStdW, tmp[0], output,
                    wsp1);
 
        // Iproduct wrt derivative of base 1
        TriIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nmodes0,
                    m_nmodes1, m_base0, m_derbase1, m_jacWStdW, tmp[1], tmp[0],
                    wsp1);
 
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nquad1;
    const int m_nmodes0;
    const int m_nmodes1;
    const bool m_colldir0;
    const bool m_colldir1;
    int m_coordim;
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_base0;
    Array<OneD, const NekDouble> m_base1;
    Array<OneD, const NekDouble> m_derbase0;
    Array<OneD, const NekDouble> m_derbase1;
    Array<OneD, NekDouble> m_fac0;
    Array<OneD, NekDouble> m_fac1;
    bool m_sortTopVertex;
 
private:
    IProductWRTDerivBase_SumFac_Tri(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nquad1(m_stdExp->GetNumPoints(1)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_nmodes1(m_stdExp->GetBasisNumModes(1)),
          m_colldir0(m_stdExp->GetBasis(0)->Collocation()),
          m_colldir1(m_stdExp->GetBasis(1)->Collocation()),
          m_base0(m_stdExp->GetBasis(0)->GetBdata()),
          m_base1(m_stdExp->GetBasis(1)->GetBdata()),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
          m_derbase1(m_stdExp->GetBasis(1)->GetDbdata())
    {
        LibUtilities::PointsKeyVector PtsKey = m_stdExp->GetPointsKeys();
        m_coordim                            = pCollExp[0]->GetCoordim();
 
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
        m_wspSize =
            4 * m_numElmt * (max(m_nquad0 * m_nquad1, m_nmodes0 * m_nmodes1));
 
        if (m_stdExp->GetBasis(0)->GetBasisType() == LibUtilities::eModified_A)
        {
            m_sortTopVertex = true;
        }
        else
        {
            m_sortTopVertex = false;
        }
 
        const Array<OneD, const NekDouble> &z0 = m_stdExp->GetBasis(0)->GetZ();
        const Array<OneD, const NekDouble> &z1 = m_stdExp->GetBasis(1)->GetZ();
 
        m_fac0 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1);
        // set up geometric factor: 2/(1-z1)
        for (int i = 0; i < m_nquad0; ++i)
        {
            for (int j = 0; j < m_nquad1; ++j)
            {
                m_fac0[i + j * m_nquad0] = 2.0 / (1 - z1[j]);
            }
        }
 
        m_fac1 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1);
        // set up geometric factor: (1+z0)/(1-z1)
        for (int i = 0; i < m_nquad0; ++i)
        {
            for (int j = 0; j < m_nquad1; ++j)
            {
                m_fac1[i + j * m_nquad0] = (1 + z0[i]) / (1 - z1[j]);
            }
        }
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Tri operator
OperatorKey IProductWRTDerivBase_SumFac_Tri::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTriangle, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Tri::create,
        "IProductWRTDerivBase_IterPerExp_Tri");
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation (Hex)
 */
class IProductWRTDerivBase_SumFac_Hex final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Hex)
 
    ~IProductWRTDerivBase_SumFac_Hex() final
    {
    }
 
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, wsp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(3);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = entry3;
 
        for (int i = 0; i < 3; ++i)
        {
            tmp[i] = wsp + i * nmax;
        }
 
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
            for (int i = 0; i < 3; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < 3; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + 3 * j], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
                for (int i = 0; i < 3; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < 3; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + 3 * j][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
            }
        }
 
        wsp1 = wsp + 3 * nmax;
 
        // calculate Iproduct WRT Std Deriv
        HexIProduct(false, m_colldir1, m_colldir2, m_numElmt, m_nquad0,
                    m_nquad1, m_nquad2, m_nmodes0, m_nmodes1, m_nmodes2,
                    m_derbase0, m_base1, m_base2, m_jacWStdW, tmp[0], output,
                    wsp1);
 
        HexIProduct(m_colldir0, false, m_colldir2, m_numElmt, m_nquad0,
                    m_nquad1, m_nquad2, m_nmodes0, m_nmodes1, m_nmodes2,
                    m_base0, m_derbase1, m_base2, m_jacWStdW, tmp[1], tmp[0],
                    wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
 
        HexIProduct(m_colldir0, m_colldir1, false, m_numElmt, m_nquad0,
                    m_nquad1, m_nquad2, m_nmodes0, m_nmodes1, m_nmodes2,
                    m_base0, m_base1, m_derbase2, m_jacWStdW, tmp[2], tmp[0],
                    wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nquad1;
    const int m_nquad2;
    const int m_nmodes0;
    const int m_nmodes1;
    const int m_nmodes2;
    const bool m_colldir0;
    const bool m_colldir1;
    const bool m_colldir2;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_base0;
    Array<OneD, const NekDouble> m_base1;
    Array<OneD, const NekDouble> m_base2;
    Array<OneD, const NekDouble> m_derbase0;
    Array<OneD, const NekDouble> m_derbase1;
    Array<OneD, const NekDouble> m_derbase2;
    Array<TwoD, const NekDouble> m_derivFac;
 
private:
    IProductWRTDerivBase_SumFac_Hex(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nquad1(m_stdExp->GetNumPoints(1)),
          m_nquad2(m_stdExp->GetNumPoints(2)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_nmodes1(m_stdExp->GetBasisNumModes(1)),
          m_nmodes2(m_stdExp->GetBasisNumModes(2)),
          m_colldir0(m_stdExp->GetBasis(0)->Collocation()),
          m_colldir1(m_stdExp->GetBasis(1)->Collocation()),
          m_colldir2(m_stdExp->GetBasis(2)->Collocation()),
          m_base0(m_stdExp->GetBasis(0)->GetBdata()),
          m_base1(m_stdExp->GetBasis(1)->GetBdata()),
          m_base2(m_stdExp->GetBasis(2)->GetBdata()),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
          m_derbase1(m_stdExp->GetBasis(1)->GetDbdata()),
          m_derbase2(m_stdExp->GetBasis(2)->GetDbdata())
 
    {
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
        m_wspSize  = 6 * m_numElmt *
                    (max(m_nquad0 * m_nquad1 * m_nquad2,
                         m_nmodes0 * m_nmodes1 * m_nmodes2));
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Hex operator
OperatorKey IProductWRTDerivBase_SumFac_Hex::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eHexahedron, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Hex::create,
        "IProductWRTDerivBase_SumFac_Hex");
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation (Tet)
 */
class IProductWRTDerivBase_SumFac_Tet : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Tet)
 
    /**
     * This method calculates:
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) \f]
     *
     * which can be represented in terms of local cartesian
     * derivaties as:
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dx +
     *       d\phi/d\xi_1\, d\xi_1/dx +
     *       d\phi/d\xi_2\, d\xi_2/dx),in[0]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dy +
     *       d\phi/d\xi_1\, d\xi_1/dy +
     *       d\phi/d\xi_2\, d\xi_2/dy),in[1]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dz +
     *       d\phi/d\xi_1\, d\xi_1/dz +
     *       d\phi/d\xi_2\, d\xi_2/dz),in[2]) \, \f]
     *
     * where we note that
     *
     * \f[ d\phi/d\xi_0 = d\phi/d\eta_0 4/((1-\eta_1)(1-\eta_2)) \f]
     *
     * \f[ d\phi/d\xi_1 =  d\phi/d\eta_0 2(1+\eta_0)/((1-\eta_1)(1-\eta_2))
     *       +  d\phi/d\eta_1 2/(1-\eta_2) \f]
     *
     * \f[ d\phi/d\xi_2  = d\phi/d\eta_0 2(1+\eta_0)/((1-\eta_1)(1-\eta_2))
     *      +   d\phi/d\eta_1 (1+\eta_1)/(1-\eta_2)  + d\phi/d\eta_2 \f]
     *
     *  and so the full inner products are
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) = \f]
     *
     * \f[ (d\phi/d\eta_0, fac0 (tmp0 + fac1(tmp1 + tmp2)))
     *      + (d\phi/d\eta_1, fac2 (tmp1 + fac3 tmp2))
     *      + (d\phi/d\eta_2, tmp2) \f]
     *
     *  where
     *
     * \f[ \begin{array}{lcl}
     *    tmp0 &=& (d\xi_0/dx in[0] + d\xi_0/dy in[1] + d\xi_0/dz in[2]) \\
     *    tmp1 &=& (d\xi_1/dx in[0] + d\xi_1/dy in[1] + d\xi_1/dz in[2]) \\
     *    tmp2 &=& (d\xi_2/dx in[0] + d\xi_2/dy in[1] + d\xi_2/dz in[2])
     *   \end{array} \f]
     *
     * \f[  \begin{array}{lcl}
     *    fac0 &= & 4/((1-\eta_1)(1-\eta_2)) \\
     *    fac1 &= & (1+\eta_0)/2 \\
     *    fac2 &= & 2/(1-\eta_2) \\
     *    fac3 &= & (1+\eta_1)/2  \end{array} \f]
     *
     */
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, wsp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(3);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = entry3;
 
        for (int i = 0; i < 3; ++i)
        {
            tmp[i] = wsp + i * nmax;
        }
 
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
            for (int i = 0; i < 3; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < 3; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + 3 * j], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
                for (int i = 0; i < 3; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < 3; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + 3 * j][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
            }
        }
 
        wsp1 = wsp + 3 * nmax;
 
        // Sort into eta factors
        for (int i = 0; i < m_numElmt; ++i)
        {
            // add tmp[1] + tmp[2]
            Vmath::Vadd(nPhys, tmp[1].get() + i * nPhys, 1,
                        tmp[2].get() + i * nPhys, 1, wsp1.get(), 1);
 
            // scale wsp1 by fac1 and add to tmp0
            Vmath::Vvtvp(nPhys, &m_fac1[0], 1, wsp1.get(), 1,
                         tmp[0].get() + i * nPhys, 1, tmp[0].get() + i * nPhys,
                         1);
 
            // scale tmp[0] by fac0
            Vmath::Vmul(nPhys, &m_fac0[0], 1, tmp[0].get() + i * nPhys, 1,
                        tmp[0].get() + i * nPhys, 1);
 
            // scale tmp[2] by fac3 and add to tmp1
            Vmath::Vvtvp(nPhys, &m_fac3[0], 1, tmp[2].get() + i * nPhys, 1,
                         tmp[1].get() + i * nPhys, 1, tmp[1].get() + i * nPhys,
                         1);
 
            // scale tmp[1] by fac2
            Vmath::Vmul(nPhys, &m_fac2[0], 1, tmp[1].get() + i * nPhys, 1,
                        tmp[1].get() + i * nPhys, 1);
        }
 
        // calculate Iproduct WRT Std Deriv
        TetIProduct(m_sortTopEdge, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                    m_nmodes0, m_nmodes1, m_nmodes2, m_derbase0, m_base1,
                    m_base2, m_jacWStdW, tmp[0], output, wsp1);
 
        TetIProduct(m_sortTopEdge, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                    m_nmodes0, m_nmodes1, m_nmodes2, m_base0, m_derbase1,
                    m_base2, m_jacWStdW, tmp[1], tmp[0], wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
 
        TetIProduct(m_sortTopEdge, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                    m_nmodes0, m_nmodes1, m_nmodes2, m_base0, m_base1,
                    m_derbase2, m_jacWStdW, tmp[2], tmp[0], wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nquad1;
    const int m_nquad2;
    const int m_nmodes0;
    const int m_nmodes1;
    const int m_nmodes2;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_base0;
    Array<OneD, const NekDouble> m_base1;
    Array<OneD, const NekDouble> m_base2;
    Array<OneD, const NekDouble> m_derbase0;
    Array<OneD, const NekDouble> m_derbase1;
    Array<OneD, const NekDouble> m_derbase2;
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, NekDouble> m_fac0;
    Array<OneD, NekDouble> m_fac1;
    Array<OneD, NekDouble> m_fac2;
    Array<OneD, NekDouble> m_fac3;
    bool m_sortTopEdge;
 
private:
    IProductWRTDerivBase_SumFac_Tet(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nquad1(m_stdExp->GetNumPoints(1)),
          m_nquad2(m_stdExp->GetNumPoints(2)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_nmodes1(m_stdExp->GetBasisNumModes(1)),
          m_nmodes2(m_stdExp->GetBasisNumModes(2)),
          m_base0(m_stdExp->GetBasis(0)->GetBdata()),
          m_base1(m_stdExp->GetBasis(1)->GetBdata()),
          m_base2(m_stdExp->GetBasis(2)->GetBdata()),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
          m_derbase1(m_stdExp->GetBasis(1)->GetDbdata()),
          m_derbase2(m_stdExp->GetBasis(2)->GetDbdata())
 
    {
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
        m_wspSize  = 6 * m_numElmt *
                    (max(m_nquad0 * m_nquad1 * m_nquad2,
                         m_nmodes0 * m_nmodes1 * m_nmodes2));
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
 
        const Array<OneD, const NekDouble> &z0 = m_stdExp->GetBasis(0)->GetZ();
        const Array<OneD, const NekDouble> &z1 = m_stdExp->GetBasis(1)->GetZ();
        const Array<OneD, const NekDouble> &z2 = m_stdExp->GetBasis(2)->GetZ();
 
        m_fac0 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        m_fac1 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        m_fac2 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        m_fac3 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        // calculate 2.0/((1-eta_1)(1-eta_2))
        for (int i = 0; i < m_nquad0; ++i)
        {
            for (int j = 0; j < m_nquad1; ++j)
            {
                for (int k = 0; k < m_nquad2; ++k)
                {
 
                    m_fac0[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        4.0 / ((1 - z1[j]) * (1 - z2[k]));
                    m_fac1[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        (1 + z0[i]) * 0.5;
                    m_fac2[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        2.0 / (1 - z2[k]);
                    m_fac3[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        (1 + z1[j]) * 0.5;
                }
            }
        }
 
        if (m_stdExp->GetBasis(0)->GetBasisType() == LibUtilities::eModified_A)
        {
            m_sortTopEdge = true;
        }
        else
        {
            m_sortTopEdge = false;
        }
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Tet operator
OperatorKey IProductWRTDerivBase_SumFac_Tet::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(eTetrahedron, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Tet::create,
        "IProductWRTDerivBase_SumFac_Tet");
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation (Prism)
 */
class IProductWRTDerivBase_SumFac_Prism final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Prism)
 
    ~IProductWRTDerivBase_SumFac_Prism() final
    {
    }
 
    /**
     * This method calculates:
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) \f]
     *
     * which can be represented in terms of local cartesian
     * derivaties as:
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dx +
     *       d\phi/d\xi_1\, d\xi_1/dx +
     *       d\phi/d\xi_2\, d\xi_2/dx),in[0]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dy +
     *       d\phi/d\xi_1\, d\xi_1/dy +
     *       d\phi/d\xi_2\, d\xi_2/dy),in[1]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dz +
     *       d\phi/d\xi_1\, d\xi_1/dz +
     *       d\phi/d\xi_2\, d\xi_2/dz),in[2]) \, \f]
     *
     * where we note that
     *
     *  \f[ d\phi/d\xi_0  =
     *            d\phi/d\eta_0 d\eta_0/d\xi_0 = d\phi/d\eta_0 2/(1-\eta_2) \f]
     *
     *  \f[ d\phi/d\xi_2  =
     *            d\phi/d\eta_0 d\eta_0/d\xi_2 + d\phi/d\eta_2 d\eta_2/d\xi_2 =
     *            d\phi/d\eta_0 (1+\eta_0)/(1-\eta_2) + d\phi/d\eta_2 \f]
     *
     *
     *  and so the full inner products are
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) = \f]
     *
     * \f[ (d\phi/d\eta_0, ((2/(1-\eta_2) (d\xi_0/dx in[0] + d\xi_0/dy in[1]
     *              + d\xi_0/dz in[2])
     *              + (1-\eta_0)/(1-\eta_2) (d\xi_2/dx in[0] + d\xi_2/dy in[1]
     *              + d\xi_2/dz in[2] )) +  \f]
     *
     * \f[ (d\phi/d\eta_1, (d\xi_1/dx in[0] + d\xi_1/dy in[1]
     *                + d\xi_1/dz in[2])) +  \f]
     *
     * \f[ (d\phi/d\eta_2, (d\xi_2/dx in[0] + d\xi_2/dy in[1]
     *               + d\xi_2/dz in[2])) \f]
     *
     */
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
 
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, wsp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(3);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = entry3;
 
        for (int i = 0; i < 3; ++i)
        {
            tmp[i] = wsp + i * nmax;
        }
 
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
            for (int i = 0; i < 3; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < 3; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + 3 * j], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
                for (int i = 0; i < 3; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < 3; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + 3 * j][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
            }
        }
 
        wsp1 = wsp + 3 * nmax;
 
        // Sort into eta factors
        for (int i = 0; i < m_numElmt; ++i)
        {
            // scale tmp[0] by fac0
            Vmath::Vmul(nPhys, &m_fac0[0], 1, tmp[0].get() + i * nPhys, 1,
                        tmp[0].get() + i * nPhys, 1);
 
            // scale tmp[2] by fac1 and add to tmp0
            Vmath::Vvtvp(nPhys, &m_fac1[0], 1, tmp[2].get() + i * nPhys, 1,
                         tmp[0].get() + i * nPhys, 1, tmp[0].get() + i * nPhys,
                         1);
        }
 
        // calculate Iproduct WRT Std Deriv
        PrismIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                      m_nmodes0, m_nmodes1, m_nmodes2, m_derbase0, m_base1,
                      m_base2, m_jacWStdW, tmp[0], output, wsp1);
 
        PrismIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                      m_nmodes0, m_nmodes1, m_nmodes2, m_base0, m_derbase1,
                      m_base2, m_jacWStdW, tmp[1], tmp[0], wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
 
        PrismIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                      m_nmodes0, m_nmodes1, m_nmodes2, m_base0, m_base1,
                      m_derbase2, m_jacWStdW, tmp[2], tmp[0], wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nquad1;
    const int m_nquad2;
    const int m_nmodes0;
    const int m_nmodes1;
    const int m_nmodes2;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_base0;
    Array<OneD, const NekDouble> m_base1;
    Array<OneD, const NekDouble> m_base2;
    Array<OneD, const NekDouble> m_derbase0;
    Array<OneD, const NekDouble> m_derbase1;
    Array<OneD, const NekDouble> m_derbase2;
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, NekDouble> m_fac0;
    Array<OneD, NekDouble> m_fac1;
    bool m_sortTopVertex;
 
private:
    IProductWRTDerivBase_SumFac_Prism(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nquad1(m_stdExp->GetNumPoints(1)),
          m_nquad2(m_stdExp->GetNumPoints(2)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_nmodes1(m_stdExp->GetBasisNumModes(1)),
          m_nmodes2(m_stdExp->GetBasisNumModes(2)),
          m_base0(m_stdExp->GetBasis(0)->GetBdata()),
          m_base1(m_stdExp->GetBasis(1)->GetBdata()),
          m_base2(m_stdExp->GetBasis(2)->GetBdata()),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
          m_derbase1(m_stdExp->GetBasis(1)->GetDbdata()),
          m_derbase2(m_stdExp->GetBasis(2)->GetDbdata())
 
    {
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
        m_wspSize  = 6 * m_numElmt *
                    (max(m_nquad0 * m_nquad1 * m_nquad2,
                         m_nmodes0 * m_nmodes1 * m_nmodes2));
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
 
        if (m_stdExp->GetBasis(0)->GetBasisType() == LibUtilities::eModified_A)
        {
            m_sortTopVertex = true;
        }
        else
        {
            m_sortTopVertex = false;
        }
 
        const Array<OneD, const NekDouble> &z0 = m_stdExp->GetBasis(0)->GetZ();
        const Array<OneD, const NekDouble> &z2 = m_stdExp->GetBasis(2)->GetZ();
 
        m_fac0 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        m_fac1 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
 
        for (int i = 0; i < m_nquad0; ++i)
        {
            for (int j = 0; j < m_nquad1; ++j)
            {
                for (int k = 0; k < m_nquad2; ++k)
                {
                    // set up geometric factor: 2/(1-z1)
                    m_fac0[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        2.0 / (1 - z2[k]);
                    // set up geometric factor: (1+z0)/(1-z1)
                    m_fac1[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        (1 + z0[i]) / (1 - z2[k]);
                }
            }
        }
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Prism operator
OperatorKey IProductWRTDerivBase_SumFac_Prism::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePrism, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Prism::create,
        "IProductWRTDerivBase_SumFac_Prism");
 
/**
 * @brief Inner product WRT deriv base operator using sum-factorisation (Pyr)
 */
class IProductWRTDerivBase_SumFac_Pyr final : public Operator
{
public:
    OPERATOR_CREATE(IProductWRTDerivBase_SumFac_Pyr)
 
    ~IProductWRTDerivBase_SumFac_Pyr() final
    {
    }
 
    /**
     * This method calculates:
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) \f]
     *
     * which can be represented in terms of local cartesian
     * derivaties as:
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dx +
     *       d\phi/d\xi_1\, d\xi_1/dx +
     *       d\phi/d\xi_2\, d\xi_2/dx),in[0]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dy +
     *       d\phi/d\xi_1\, d\xi_1/dy +
     *       d\phi/d\xi_2\, d\xi_2/dy),in[1]) + \f]
     *
     * \f[ ((d\phi/d\xi_0\, d\xi_0/dz +
     *       d\phi/d\xi_1\, d\xi_1/dz +
     *       d\phi/d\xi_2\, d\xi_2/dz),in[2]) \, \f]
     *
     * where we note that
     *
     * \f[ d\phi/d\xi_0  =
     *            d\phi/d\eta_0\, d\eta_0/d\xi_0 =
     *            d\phi/d\eta_0\, 2/(1-\eta_2). \f]
     *
     *  \f[ d\phi/d\xi_1  =
     *            d\phi/d\eta_1\, d\eta_1/d\xi_1 =
     *            d\phi/d\eta_1\, 2/(1-\eta_2) \f]
     *
     *  \f[ d\phi/d\xi_2  =
     *          d\phi/d\eta_0\, d\eta_0/d\xi_2 +
     *          d\phi/d\eta_1\, d\eta_1/d\xi_2 +
     *          d\phi/d\eta_2\, d\eta_2/d\xi_2 =
     *          d\phi/d\eta_0 (1+\eta_0)/(1-\eta_2) +
     *          d\phi/d\eta_1 (1+\eta_1)/(1-\eta_2) + d\phi/d\eta_2 \f]
     *
     *  and so the full inner products are
     *
     * \f[ (d\phi/dx,in[0]) + (d\phi/dy,in[1]) + (d\phi/dz,in[2]) = \f]
     *
     * \f[ (d\phi/d\eta_0, ((2/(1-\eta_2) (d\xi_0/dx in[0] +
     *      d\xi_0/dy in[1] +
     *     (1-\eta_0)/(1-\eta_2) (d\xi_2/dx in[0] + d\xi_2/dy in[1]
     *                               + d\xi_2/dz in[2] )) + \f]
     * \f[ (d\phi/d\eta_1, ((2/(1-\eta_2) (d\xi_1/dx in[0] +
     *      d\xi_0/dy in[1] + d\xi_0/dz in[2]) +
     *      (1-\eta_1)/(1-\eta_2) (d\xi_2/dx in[0] + d\xi_2/dy in[1] +
     *      d\xi_2/dz in[2] )) \f]
     *
     * \f[ (d\phi/d\eta_2, (d\xi_2/dx in[0] + d\xi_2/dy in[1] +
     *      d\xi_2/dz in[2])) \f]
     */
    void operator()(const Array<OneD, const NekDouble> &entry0,
                    Array<OneD, NekDouble> &entry1,
                    Array<OneD, NekDouble> &entry2,
                    Array<OneD, NekDouble> &entry3,
                    Array<OneD, NekDouble> &wsp) override final
    {
        unsigned int nPhys  = m_stdExp->GetTotPoints();
        unsigned int ntot   = m_numElmt * nPhys;
        unsigned int nmodes = m_stdExp->GetNcoeffs();
        unsigned int nmax   = max(ntot, m_numElmt * nmodes);
        Array<OneD, Array<OneD, const NekDouble>> in(3);
        Array<OneD, NekDouble> output, wsp1;
        Array<OneD, Array<OneD, NekDouble>> tmp(3);
 
        in[0] = entry0;
        in[1] = entry1;
        in[2] = entry2;
 
        output = entry3;
 
        for (int i = 0; i < 3; ++i)
        {
            tmp[i] = wsp + i * nmax;
        }
 
        if (m_isDeformed)
        {
            // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
            for (int i = 0; i < 3; ++i)
            {
                Vmath::Vmul(ntot, m_derivFac[i], 1, in[0], 1, tmp[i], 1);
                for (int j = 1; j < 3; ++j)
                {
                    Vmath::Vvtvp(ntot, m_derivFac[i + 3 * j], 1, in[j], 1,
                                 tmp[i], 1, tmp[i], 1);
                }
            }
        }
        else
        {
            Array<OneD, NekDouble> t;
            for (int e = 0; e < m_numElmt; ++e)
            {
                // calculate dx/dxi in[0] + dy/dxi in[1] + dz/dxi in[2]
                for (int i = 0; i < 3; ++i)
                {
                    Vmath::Smul(m_nqe, m_derivFac[i][e], in[0] + e * m_nqe, 1,
                                t = tmp[i] + e * m_nqe, 1);
                    for (int j = 1; j < 3; ++j)
                    {
                        Vmath::Svtvp(m_nqe, m_derivFac[i + 3 * j][e],
                                     in[j] + e * m_nqe, 1, tmp[i] + e * m_nqe,
                                     1, t = tmp[i] + e * m_nqe, 1);
                    }
                }
            }
        }
 
        wsp1 = wsp + 3 * nmax;
 
        // Sort into eta factors
        for (int i = 0; i < m_numElmt; ++i)
        {
            // scale tmp[0] by fac0
            Vmath::Vmul(nPhys, &m_fac0[0], 1, tmp[0].get() + i * nPhys, 1,
                        tmp[0].get() + i * nPhys, 1);
 
            // scale tmp[2] by fac1 and add to tmp0
            Vmath::Vvtvp(nPhys, &m_fac1[0], 1, tmp[2].get() + i * nPhys, 1,
                         tmp[0].get() + i * nPhys, 1, tmp[0].get() + i * nPhys,
                         1);
 
            // scale tmp[1] by fac0
            Vmath::Vmul(nPhys, &m_fac0[0], 1, tmp[1].get() + i * nPhys, 1,
                        tmp[1].get() + i * nPhys, 1);
 
            // scale tmp[2] by fac2 and add to tmp1
            Vmath::Vvtvp(nPhys, &m_fac2[0], 1, tmp[2].get() + i * nPhys, 1,
                         tmp[1].get() + i * nPhys, 1, tmp[1].get() + i * nPhys,
                         1);
        }
 
        // calculate Iproduct WRT Std Deriv
        PyrIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                    m_nmodes0, m_nmodes1, m_nmodes2, m_derbase0, m_base1,
                    m_base2, m_jacWStdW, tmp[0], output, wsp1);
 
        PyrIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                    m_nmodes0, m_nmodes1, m_nmodes2, m_base0, m_derbase1,
                    m_base2, m_jacWStdW, tmp[1], tmp[0], wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
 
        PyrIProduct(m_sortTopVertex, m_numElmt, m_nquad0, m_nquad1, m_nquad2,
                    m_nmodes0, m_nmodes1, m_nmodes2, m_base0, m_base1,
                    m_derbase2, m_jacWStdW, tmp[2], tmp[0], wsp1);
        Vmath::Vadd(m_numElmt * nmodes, tmp[0], 1, output, 1, output, 1);
    }
 
    void operator()(int dir, const Array<OneD, const NekDouble> &input,
                    Array<OneD, NekDouble> &output,
                    Array<OneD, NekDouble> &wsp) override final
    {
        boost::ignore_unused(dir, input, output, wsp);
        NEKERROR(ErrorUtil::efatal, "Not valid for this operator.");
    }
 
    virtual void CheckFactors(StdRegions::FactorMap factors,
                              int coll_phys_offset) override
    {
        boost::ignore_unused(factors, coll_phys_offset);
        ASSERTL0(false, "Not valid for this operator.");
    }
 
protected:
    const int m_nquad0;
    const int m_nquad1;
    const int m_nquad2;
    const int m_nmodes0;
    const int m_nmodes1;
    const int m_nmodes2;
    Array<OneD, const NekDouble> m_jacWStdW;
    Array<OneD, const NekDouble> m_base0;
    Array<OneD, const NekDouble> m_base1;
    Array<OneD, const NekDouble> m_base2;
    Array<OneD, const NekDouble> m_derbase0;
    Array<OneD, const NekDouble> m_derbase1;
    Array<OneD, const NekDouble> m_derbase2;
    Array<TwoD, const NekDouble> m_derivFac;
    Array<OneD, NekDouble> m_fac0;
    Array<OneD, NekDouble> m_fac1;
    Array<OneD, NekDouble> m_fac2;
    bool m_sortTopVertex;
 
private:
    IProductWRTDerivBase_SumFac_Pyr(
        vector<StdRegions::StdExpansionSharedPtr> pCollExp,
        CoalescedGeomDataSharedPtr pGeomData, StdRegions::FactorMap factors)
        : Operator(pCollExp, pGeomData, factors),
          m_nquad0(m_stdExp->GetNumPoints(0)),
          m_nquad1(m_stdExp->GetNumPoints(1)),
          m_nquad2(m_stdExp->GetNumPoints(2)),
          m_nmodes0(m_stdExp->GetBasisNumModes(0)),
          m_nmodes1(m_stdExp->GetBasisNumModes(1)),
          m_nmodes2(m_stdExp->GetBasisNumModes(2)),
          m_base0(m_stdExp->GetBasis(0)->GetBdata()),
          m_base1(m_stdExp->GetBasis(1)->GetBdata()),
          m_base2(m_stdExp->GetBasis(2)->GetBdata()),
          m_derbase0(m_stdExp->GetBasis(0)->GetDbdata()),
          m_derbase1(m_stdExp->GetBasis(1)->GetDbdata()),
          m_derbase2(m_stdExp->GetBasis(2)->GetDbdata())
 
    {
        m_jacWStdW = pGeomData->GetJacWithStdWeights(pCollExp);
        m_wspSize  = 6 * m_numElmt *
                    (max(m_nquad0 * m_nquad1 * m_nquad2,
                         m_nmodes0 * m_nmodes1 * m_nmodes2));
        m_derivFac = pGeomData->GetDerivFactors(pCollExp);
 
        if (m_stdExp->GetBasis(0)->GetBasisType() == LibUtilities::eModified_A)
        {
            m_sortTopVertex = true;
        }
        else
        {
            m_sortTopVertex = false;
        }
 
        const Array<OneD, const NekDouble> &z0 = m_stdExp->GetBasis(0)->GetZ();
        const Array<OneD, const NekDouble> &z1 = m_stdExp->GetBasis(1)->GetZ();
        const Array<OneD, const NekDouble> &z2 = m_stdExp->GetBasis(2)->GetZ();
 
        m_fac0 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        m_fac1 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
        m_fac2 = Array<OneD, NekDouble>(m_nquad0 * m_nquad1 * m_nquad2);
 
        for (int i = 0; i < m_nquad0; ++i)
        {
            for (int j = 0; j < m_nquad1; ++j)
            {
                for (int k = 0; k < m_nquad2; ++k)
                {
                    // set up geometric factor: 2/(1-z2)
                    m_fac0[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        2.0 / (1 - z2[k]);
                    // set up geometric factor: (1+z0)/(1-z2)
                    m_fac1[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        (1 + z0[i]) / (1 - z2[k]);
                    // set up geometric factor: (1+z1)/(1-z2)
                    m_fac2[i + j * m_nquad0 + k * m_nquad0 * m_nquad1] =
                        (1 + z1[j]) / (1 - z2[k]);
                }
            }
        }
    }
};
 
/// Factory initialisation for the IProductWRTDerivBase_SumFac_Pyr operator
OperatorKey IProductWRTDerivBase_SumFac_Pyr::m_type =
    GetOperatorFactory().RegisterCreatorFunction(
        OperatorKey(ePyramid, eIProductWRTDerivBase, eSumFac, false),
        IProductWRTDerivBase_SumFac_Pyr::create,
        "IProductWRTDerivBase_SumFac_Pyr");
 
} // namespace Collections
} // namespace Nektar