QuadExp.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File QuadExp.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).
//
// License for the specific language governing rights and limitations under
// 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: Expansion for quadrilateral elements.
//
///////////////////////////////////////////////////////////////////////////////

#ifndef QUADEXP_H
#define QUADEXP_H

#include <LocalRegions/LocalRegionsDeclspec.h>
#include <LocalRegions/Expansion2D.h>
#include <LocalRegions/MatrixKey.h>
#include <StdRegions/StdQuadExp.h>
#include <SpatialDomains/QuadGeom.h>
#include <SpatialDomains/GeomFactors.h>


namespace Nektar
{
    namespace LocalRegions
    {

        class QuadExp:  virtual public StdRegions::StdQuadExp,
                        virtual public Expansion2D
        {
        public:
            /**
             * @brief Constructor using BasisKey class for quadrature
             *        points and order definition
             */
            LOCAL_REGIONS_EXPORT QuadExp(
                    const LibUtilities::BasisKey &Ba,
                    const LibUtilities::BasisKey &Bb,
                    const SpatialDomains::QuadGeomSharedPtr &geom);

            LOCAL_REGIONS_EXPORT QuadExp(const QuadExp &T);

            LOCAL_REGIONS_EXPORT virtual ~QuadExp();

        protected:
            //-------------------------------
            // Integration Methods
            //-------------------------------
            LOCAL_REGIONS_EXPORT virtual NekDouble v_Integral(
                    const Array<OneD, const NekDouble> &inarray);
            
            //----------------------------
            // Differentiation Methods
            //----------------------------
            LOCAL_REGIONS_EXPORT virtual NekDouble v_StdPhysEvaluate(
                    const Array<OneD, const NekDouble> &Lcoord,
                    const Array<OneD, const NekDouble> &physvals);
            LOCAL_REGIONS_EXPORT virtual void v_PhysDeriv(
                    const Array<OneD, const NekDouble> &inarray,
                          Array<OneD,       NekDouble> &out_d0,
                          Array<OneD,       NekDouble> &out_d1,
                          Array<OneD,       NekDouble> &out_d2 = NullNekDouble1DArray);
            LOCAL_REGIONS_EXPORT virtual void v_PhysDeriv(
                        const int dir,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_PhysDirectionalDeriv(
                        const Array<OneD, const NekDouble> &inarray,
                        const Array<OneD, const NekDouble> &direction,
                              Array<OneD,       NekDouble> &out);

            //---------------------------------------
            // Transforms
            //---------------------------------------
            LOCAL_REGIONS_EXPORT virtual void v_FwdTrans(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);

            LOCAL_REGIONS_EXPORT virtual void v_FwdTrans_BndConstrained(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);

            //---------------------------------------
            // Inner product functions
            //---------------------------------------
            LOCAL_REGIONS_EXPORT virtual void v_IProductWRTBase(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_IProductWRTDerivBase(
                        const int dir,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_IProductWRTBase_SumFac(
                        const Array<OneD, const NekDouble> &inarray,
                        Array<OneD,       NekDouble> &outarray,
                        bool multiplybyweights = true);
            LOCAL_REGIONS_EXPORT virtual void v_IProductWRTBase_MatOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_IProductWRTDerivBase_SumFac(
                        const int dir,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_IProductWRTDerivBase_MatOp(
                        const int dir,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);

            LOCAL_REGIONS_EXPORT virtual void v_NormVectorIProductWRTBase(
                        const Array<OneD, const NekDouble> &Fx,
                        const Array<OneD, const NekDouble> &Fy,
                        const Array<OneD, const NekDouble> &Fz,
                              Array<OneD,       NekDouble> &outarray);

            LOCAL_REGIONS_EXPORT virtual void v_NormVectorIProductWRTBase(
                        const Array<OneD, const Array<OneD, NekDouble> > &Fvec,
                              Array<OneD,       NekDouble>           &outarray);

            //---------------------------------------
            // Evaluation functions
            //---------------------------------------
            LOCAL_REGIONS_EXPORT virtual
                StdRegions::StdExpansionSharedPtr v_GetStdExp(void) const;

            LOCAL_REGIONS_EXPORT virtual
                StdRegions::StdExpansionSharedPtr v_GetLinStdExp(void) const;
            
            LOCAL_REGIONS_EXPORT virtual void v_GetCoord(
                        const Array<OneD, const NekDouble> &Lcoords,
                              Array<OneD,       NekDouble> &coords);
            LOCAL_REGIONS_EXPORT virtual void v_GetCoords(
                             Array<OneD,        NekDouble> &coords_1,
                             Array<OneD,        NekDouble> &coords_2,
                             Array<OneD,        NekDouble> &coords_3);
            LOCAL_REGIONS_EXPORT virtual NekDouble v_PhysEvaluate(
                        const Array<OneD, const NekDouble> &coord,
                        const Array<OneD, const NekDouble> &physvals);
            LOCAL_REGIONS_EXPORT virtual void v_GetEdgePhysVals(
                        const int edge,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_GetEdgePhysVals(
                        const int edge,
                        const StdRegions::StdExpansionSharedPtr &EdgeExp,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_GetTracePhysVals(
                        const int edge,
                        const StdRegions::StdExpansionSharedPtr &EdgeExp,
                        const Array<OneD, const NekDouble> &inarray,
                        Array<OneD,       NekDouble> &outarray,
                        StdRegions::Orientation  orient);
            LOCAL_REGIONS_EXPORT virtual void v_GetEdgeInterpVals(
                        const int edge,
                        const Array<OneD, const NekDouble> &inarray,
                        Array<OneD, NekDouble>      &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_GetEdgeQFactors(
                        const int edge,
                        Array<OneD, NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_ComputeEdgeNormal(
                        const int edge);


            //---------------------------------------
            // Helper functions
            //---------------------------------------
            LOCAL_REGIONS_EXPORT virtual const
                SpatialDomains::GeomFactorsSharedPtr& v_GetMetricInfo() const;
            LOCAL_REGIONS_EXPORT virtual  int v_GetCoordim();
            LOCAL_REGIONS_EXPORT virtual void v_ExtractDataToCoeffs(
                        const NekDouble *data,
                        const std::vector<unsigned int > &nummodes,
                        const int mode_offset,
                        NekDouble * coeffs,
                        std::vector<LibUtilities::BasisType> &fromType);
            LOCAL_REGIONS_EXPORT virtual
                StdRegions::Orientation v_GetEorient(int edge);
            LOCAL_REGIONS_EXPORT virtual
                StdRegions::Orientation v_GetCartesianEorient(int edge);
            LOCAL_REGIONS_EXPORT virtual const
                LibUtilities::BasisSharedPtr& v_GetBasis(int dir) const;
            LOCAL_REGIONS_EXPORT virtual int v_GetNumPoints(
                const int dir) const;
            LOCAL_REGIONS_EXPORT virtual void v_GetEdgePhysMap(
                const int                edge,
                Array<OneD, int>        &outarray);


            //---------------------------------------
            // Matrix creation functions
            //---------------------------------------
            LOCAL_REGIONS_EXPORT virtual DNekMatSharedPtr v_GenMatrix(
                        const StdRegions::StdMatrixKey &mkey);

            LOCAL_REGIONS_EXPORT virtual DNekMatSharedPtr v_CreateStdMatrix(
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT DNekScalMatSharedPtr  CreateMatrix(
                        const MatrixKey &mkey);
            LOCAL_REGIONS_EXPORT DNekScalBlkMatSharedPtr CreateStaticCondMatrix(
                        const MatrixKey &mkey);

            LOCAL_REGIONS_EXPORT virtual DNekScalMatSharedPtr v_GetLocMatrix(
                        const MatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual
                DNekScalBlkMatSharedPtr v_GetLocStaticCondMatrix(
                        const MatrixKey &mkey);

            LOCAL_REGIONS_EXPORT void v_DropLocStaticCondMatrix(
                        const MatrixKey &mkey);


            //---------------------------------------
            // Operators
            //---------------------------------------
            LOCAL_REGIONS_EXPORT virtual void v_MassMatrixOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_LaplacianMatrixOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_LaplacianMatrixOp(
                        const int k1,
                        const int k2,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_WeakDerivMatrixOp(
                        const int i,
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_WeakDirectionalDerivMatrixOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_MassLevelCurvatureMatrixOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_HelmholtzMatrixOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_GeneralMatrixOp_MatOp(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                        const StdRegions::StdMatrixKey &mkey);
            LOCAL_REGIONS_EXPORT virtual void v_LaplacianMatrixOp_MatFree_Kernel(
                        const Array<OneD, const NekDouble> &inarray,
                              Array<OneD,       NekDouble> &outarray,
                              Array<OneD,       NekDouble> &wsp);
            LOCAL_REGIONS_EXPORT virtual void v_ReduceOrderCoeffs(
                              int numMin,
                              const Array<OneD, const NekDouble> &inarray,
                              Array<OneD, NekDouble> &outarray);
            LOCAL_REGIONS_EXPORT virtual void v_ComputeLaplacianMetric();
            
            LOCAL_REGIONS_EXPORT virtual void v_SVVLaplacianFilter(
                    Array<OneD, NekDouble> &array,
                    const StdRegions::StdMatrixKey &mkey);

        private:
            LibUtilities::NekManager<MatrixKey, DNekScalMat, MatrixKey::opLess> m_matrixManager;
            LibUtilities::NekManager<MatrixKey, DNekScalBlkMat, MatrixKey::opLess> m_staticCondMatrixManager;

            QuadExp();

        };

        // type defines for use of QuadExp in a boost vector
        typedef boost::shared_ptr<QuadExp> QuadExpSharedPtr;
        typedef std::vector< QuadExpSharedPtr > QuadExpVector;
        typedef std::vector< QuadExpSharedPtr >::iterator QuadExpVectorIter;
    }
}

#endif