NodalTriExp.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: NodalTriExp.h
//
// 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: Header for NodalTriExp routines
//
///////////////////////////////////////////////////////////////////////////////
 
#ifndef NODALTRIEXP_H
#define NODALTRIEXP_H
 
#include <SpatialDomains/TriGeom.h>
#include <StdRegions/StdNodalTriExp.h>
 
#include <LocalRegions/Expansion2D.h>
#include <LocalRegions/LocalRegionsDeclspec.h>
#include <LocalRegions/MatrixKey.h>
 
namespace Nektar::LocalRegions
{
 
class NodalTriExp final : virtual public StdRegions::StdNodalTriExp,
                          virtual public Expansion2D
{
public:
    /** \brief Constructor using BasisKey class for quadrature
        points and order definition */
    LOCAL_REGIONS_EXPORT NodalTriExp(
        const LibUtilities::BasisKey &Ba, const LibUtilities::BasisKey &Bb,
        const LibUtilities::PointsType Ntype,
        const SpatialDomains::TriGeomSharedPtr &geom);
 
    /// Copy Constructor
    LOCAL_REGIONS_EXPORT NodalTriExp(const NodalTriExp &T);
 
    /// Destructor
    LOCAL_REGIONS_EXPORT ~NodalTriExp() override = default;
 
    LOCAL_REGIONS_EXPORT void GetCoords(
        Array<OneD, NekDouble> &coords_1, Array<OneD, NekDouble> &coords_2,
        Array<OneD, NekDouble> &coords_3 = NullNekDouble1DArray);
    LOCAL_REGIONS_EXPORT void GetCoord(
        const Array<OneD, const NekDouble> &Lcoords,
        Array<OneD, NekDouble> &coords);
 
    //----------------------------
    // Integration Methods
    //----------------------------
 
    /// \brief Integrate the physical point list \a inarray over region
    LOCAL_REGIONS_EXPORT NekDouble
    Integral(const Array<OneD, const NekDouble> &inarray);
 
    /** \brief  Inner product of \a inarray over region with respect to the
        expansion basis (this)->_Base[0] and return in \a outarray */
    void IProductWRTBase(const Array<OneD, const NekDouble> &inarray,
                         Array<OneD, NekDouble> &outarray)
    {
        NodalTriExp::IProductWRTBase_SumFac(inarray, outarray);
    }
 
    void IProductWRTDerivBase(const int dir,
                              const Array<OneD, const NekDouble> &inarray,
                              Array<OneD, NekDouble> &outarray)
    {
        NodalTriExp::IProductWRTDerivBase_SumFac(dir, inarray, outarray);
    }
 
    //-----------------------------
    // Differentiation Methods
    //-----------------------------
 
    LOCAL_REGIONS_EXPORT void PhysDeriv(
        const Array<OneD, const NekDouble> &inarray,
        Array<OneD, NekDouble> &out_d0, Array<OneD, NekDouble> &out_d1,
        Array<OneD, NekDouble> &out_d2 = NullNekDouble1DArray);
 
    //----------------------------
    // Evaluations Methods
    //---------------------------
 
    /** \brief Forward transform from physical quadrature space
        stored in \a inarray and evaluate the expansion coefficients and
        store in \a (this)->_coeffs  */
    LOCAL_REGIONS_EXPORT void FwdTrans(
        const Array<OneD, const NekDouble> &inarray,
        Array<OneD, NekDouble> &outarray);
 
    LOCAL_REGIONS_EXPORT NekDouble
    PhysEvaluate(const Array<OneD, const NekDouble> &coord,
                 const Array<OneD, const NekDouble> &physvals);
 
    void MassMatrixOp(const Array<OneD, const NekDouble> &inarray,
                      Array<OneD, NekDouble> &outarray,
                      const StdRegions::StdMatrixKey &mkey)
    {
        StdExpansion::MassMatrixOp_MatFree(inarray, outarray, mkey);
    }
 
    LOCAL_REGIONS_EXPORT NekDouble
    v_PhysEvaluate(const Array<OneD, NekDouble> &coord,
                   const Array<OneD, const NekDouble> &inarray,
                   std::array<NekDouble, 3> &firstOrderDerivs) final;
 
    void LaplacianMatrixOp(const Array<OneD, const NekDouble> &inarray,
                           Array<OneD, NekDouble> &outarray,
                           const StdRegions::StdMatrixKey &mkey)
    {
        StdExpansion::LaplacianMatrixOp_MatFree_GenericImpl(inarray, outarray,
                                                            mkey);
    }
 
    void LaplacianMatrixOp(const int k1, const int k2,
                           const Array<OneD, const NekDouble> &inarray,
                           Array<OneD, NekDouble> &outarray,
                           const StdRegions::StdMatrixKey &mkey)
    {
        StdExpansion::LaplacianMatrixOp_MatFree(k1, k2, inarray, outarray,
                                                mkey);
    }
 
    void WeakDerivMatrixOp(const int i,
                           const Array<OneD, const NekDouble> &inarray,
                           Array<OneD, NekDouble> &outarray,
                           const StdRegions::StdMatrixKey &mkey)
    {
        StdExpansion::WeakDerivMatrixOp_MatFree(i, inarray, outarray, mkey);
    }
 
    void HelmholtzMatrixOp(const Array<OneD, const NekDouble> &inarray,
                           Array<OneD, NekDouble> &outarray,
                           const StdRegions::StdMatrixKey &mkey)
    {
        StdExpansion::HelmholtzMatrixOp_MatFree_GenericImpl(inarray, outarray,
                                                            mkey);
    }
 
protected:
    DNekMatSharedPtr CreateStdMatrix(const StdRegions::StdMatrixKey &mkey);
 
    void IProductWRTBase_SumFac(const Array<OneD, const NekDouble> &inarray,
                                Array<OneD, NekDouble> &outarray,
                                bool multiplybyweights = true);
    void IProductWRTBase_MatOp(const Array<OneD, const NekDouble> &inarray,
                               Array<OneD, NekDouble> &outarray);
 
    void IProductWRTDerivBase_SumFac(
        const int dir, const Array<OneD, const NekDouble> &inarray,
        Array<OneD, NekDouble> &outarray);
    void IProductWRTDerivBase_MatOp(const int dir,
                                    const Array<OneD, const NekDouble> &inarray,
                                    Array<OneD, NekDouble> &outarray);
 
    void GeneralMatrixOp_MatOp(const Array<OneD, const NekDouble> &inarray,
                               Array<OneD, NekDouble> &outarray,
                               const StdRegions::StdMatrixKey &mkey);
 
    StdRegions::StdExpansionSharedPtr v_GetStdExp(void) const override;
 
    StdRegions::StdExpansionSharedPtr v_GetLinStdExp(void) const override;
 
    DNekMatSharedPtr v_GenMatrix(const StdRegions::StdMatrixKey &mkey) override;
 
private:
    LibUtilities::NekManager<MatrixKey, DNekScalMat, MatrixKey::opLess>
        m_matrixManager;
    LibUtilities::NekManager<MatrixKey, DNekScalBlkMat, MatrixKey::opLess>
        m_staticCondMatrixManager;
 
    void v_GetCoords(
        Array<OneD, NekDouble> &coords_0,
        Array<OneD, NekDouble> &coords_1 = NullNekDouble1DArray,
        Array<OneD, NekDouble> &coords_2 = NullNekDouble1DArray) override
    {
        GetCoords(coords_0, coords_1, coords_2);
    }
 
    void v_GetCoord(const Array<OneD, const NekDouble> &lcoord,
                    Array<OneD, NekDouble> &coord) override
    {
        GetCoord(lcoord, coord);
    }
 
    /** \brief Virtual call to integrate the physical point list \a inarray
        over region (see SegExp::Integral) */
    NekDouble v_Integral(const Array<OneD, const NekDouble> &inarray) override
    {
        return Integral(inarray);
    }
 
    /** \brief Virtual call to TriExp::IProduct_WRT_B */
    void v_IProductWRTBase(const Array<OneD, const NekDouble> &inarray,
                           Array<OneD, NekDouble> &outarray) override
    {
        IProductWRTBase(inarray, outarray);
    }
 
    void v_IProductWRTDerivBase(const int dir,
                                const Array<OneD, const NekDouble> &inarray,
                                Array<OneD, NekDouble> &outarray) override
    {
        IProductWRTDerivBase(dir, inarray, outarray);
    }
 
    void v_StdPhysDeriv(
        const Array<OneD, const NekDouble> &inarray,
        Array<OneD, NekDouble> &out_d0, Array<OneD, NekDouble> &out_d1,
        Array<OneD, NekDouble> &out_d2 = NullNekDouble1DArray) override
    {
        StdTriExp::v_PhysDeriv(inarray, out_d0, out_d1, out_d2);
    }
 
    void v_PhysDeriv(const Array<OneD, const NekDouble> &inarray,
                     Array<OneD, NekDouble> &out_d0,
                     Array<OneD, NekDouble> &out_d1,
                     [[maybe_unused]] Array<OneD, NekDouble> &out_d2 =
                         NullNekDouble1DArray) override
    {
        PhysDeriv(inarray, out_d0, out_d1);
    }
 
    void v_PhysDeriv(const int dir, const Array<OneD, const NekDouble> &inarray,
                     Array<OneD, NekDouble> &outarray) override
    {
        Array<OneD, NekDouble> tmp;
        switch (dir)
        {
            case 0:
            {
                PhysDeriv(inarray, outarray, tmp);
            }
            break;
            case 1:
            {
                PhysDeriv(inarray, tmp, outarray);
            }
            break;
            default:
            {
                ASSERTL1(dir >= 0 && dir < 2, "input dir is out of range");
            }
            break;
        }
    }
 
    /// Virtual call to SegExp::FwdTrans
    void v_FwdTrans(const Array<OneD, const NekDouble> &inarray,
                    Array<OneD, NekDouble> &outarray) override
    {
        FwdTrans(inarray, outarray);
    }
 
    /// Virtual call to TriExp::Evaluate
    NekDouble v_PhysEvaluate(
        const Array<OneD, const NekDouble> &coord,
        const Array<OneD, const NekDouble> &physvals) override
    {
        return PhysEvaluate(coord, physvals);
    }
 
    DNekMatSharedPtr v_CreateStdMatrix(
        const StdRegions::StdMatrixKey &mkey) override
    {
        return CreateStdMatrix(mkey);
    }
 
    DNekScalMatSharedPtr v_GetLocMatrix(const MatrixKey &mkey) override
    {
        return m_matrixManager[mkey];
    }
 
    void v_DropLocMatrix(const MatrixKey &mkey) override
    {
        m_matrixManager.DeleteObject(mkey);
    }
 
    DNekScalBlkMatSharedPtr v_GetLocStaticCondMatrix(
        const MatrixKey &mkey) override
    {
        return m_staticCondMatrixManager[mkey];
    }
 
    void v_BwdTrans_SumFac(const Array<OneD, const NekDouble> &inarray,
                           Array<OneD, NekDouble> &outarray) override
    {
        StdNodalTriExp::v_BwdTrans_SumFac(inarray, outarray);
    }
 
    void v_IProductWRTBase_SumFac(
        const Array<OneD, const NekDouble> &inarray,
        Array<OneD, NekDouble> &outarray,
        [[maybe_unused]] bool multiplybyweights = true) override
    {
        IProductWRTBase_SumFac(inarray, outarray);
    }
 
    void v_IProductWRTDerivBase_SumFac(
        const int dir, const Array<OneD, const NekDouble> &inarray,
        Array<OneD, NekDouble> &outarray) override
    {
        IProductWRTDerivBase_SumFac(dir, inarray, outarray);
    }
 
    void v_AlignVectorToCollapsedDir(
        const int dir, const Array<OneD, const NekDouble> &inarray,
        Array<OneD, Array<OneD, NekDouble>> &outarray) override;
 
    void v_MassMatrixOp(const Array<OneD, const NekDouble> &inarray,
                        Array<OneD, NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey) override
    {
        MassMatrixOp(inarray, outarray, mkey);
    }
 
    void v_LaplacianMatrixOp(const Array<OneD, const NekDouble> &inarray,
                             Array<OneD, NekDouble> &outarray,
                             const StdRegions::StdMatrixKey &mkey) override
    {
        LaplacianMatrixOp(inarray, outarray, mkey);
    }
 
    void v_LaplacianMatrixOp(const int k1, const int k2,
                             const Array<OneD, const NekDouble> &inarray,
                             Array<OneD, NekDouble> &outarray,
                             const StdRegions::StdMatrixKey &mkey) override
    {
        LaplacianMatrixOp(k1, k2, inarray, outarray, mkey);
    }
 
    void v_WeakDerivMatrixOp(const int i,
                             const Array<OneD, const NekDouble> &inarray,
                             Array<OneD, NekDouble> &outarray,
                             const StdRegions::StdMatrixKey &mkey) override
    {
        WeakDerivMatrixOp(i, inarray, outarray, mkey);
    }
 
    void v_HelmholtzMatrixOp(const Array<OneD, const NekDouble> &inarray,
                             Array<OneD, NekDouble> &outarray,
                             const StdRegions::StdMatrixKey &mkey) override
    {
        HelmholtzMatrixOp(inarray, outarray, mkey);
    }
 
    void v_ComputeTraceNormal(const int edge) override;
};
 
typedef std::shared_ptr<NodalTriExp> NodalTriExpSharedPtr;
typedef std::vector<NodalTriExpSharedPtr> NodalTriExpVector;
 
} // namespace Nektar::LocalRegions
 
#endif // NODALTRIEXP_H