////////////////////////////////////////////////////////////////////////////////
//
//  File: QuadGeom.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:
//
//
////////////////////////////////////////////////////////////////////////////////
#ifndef NEKTAR_SPATIALDOMAINS_QUADGEOM_H
#define NEKTAR_SPATIALDOMAINS_QUADGEOM_H

#include <StdRegions/StdRegions.hpp>

#include <SpatialDomains/Geometry2D.h>
#include <SpatialDomains/PointGeom.h>
#include <SpatialDomains/SpatialDomainsDeclspec.h>
#include <SpatialDomains/SegGeom.h>     // for SegGeomSharedPtr, etc


namespace Nektar
{
    namespace SpatialDomains
    {
        class  QuadGeom;
        struct Curve;
        typedef boost::shared_ptr<Curve> CurveSharedPtr;
        typedef boost::shared_ptr<QuadGeom> QuadGeomSharedPtr;
        typedef std::vector< QuadGeomSharedPtr > QuadGeomVector;
        typedef std::vector< QuadGeomSharedPtr >::iterator QuadGeomVectorIter;
        typedef std::map<int, QuadGeomSharedPtr> QuadGeomMap;
        typedef std::map<int, QuadGeomSharedPtr>::iterator QuadGeomMapIter;

        class QuadGeom: public Geometry2D
        {
        public:
            SPATIAL_DOMAINS_EXPORT QuadGeom();
            
	    SPATIAL_DOMAINS_EXPORT QuadGeom(
                    const int id, 
                    const PointGeomSharedPtr verts[],
                    const SegGeomSharedPtr edges[], 
                    const StdRegions::Orientation eorient[]);

            SPATIAL_DOMAINS_EXPORT QuadGeom(
                    const int id, 
                    const SegGeomSharedPtr edges[], 
                    const StdRegions::Orientation eorient[]);

            SPATIAL_DOMAINS_EXPORT QuadGeom(
                    const int id, 
                    const SegGeomSharedPtr edges[], 
                    const StdRegions::Orientation eorient[], 
                    const CurveSharedPtr &curve);

            SPATIAL_DOMAINS_EXPORT QuadGeom(const QuadGeom &in);

            SPATIAL_DOMAINS_EXPORT ~QuadGeom();

            SPATIAL_DOMAINS_EXPORT NekDouble GetCoord(
                    const int i,
                    const Array<OneD, const NekDouble> &Lcoord);
  
            /// Get the orientation of face1.
            SPATIAL_DOMAINS_EXPORT static StdRegions::Orientation
                GetFaceOrientation(
                    const QuadGeom              &face1,
                    const QuadGeom              &face2);
            SPATIAL_DOMAINS_EXPORT static StdRegions::Orientation
                GetFaceOrientation(
                    const PointGeomVector &face1,
                    const PointGeomVector &face2);

            SPATIAL_DOMAINS_EXPORT static const int kNverts = 4;
            SPATIAL_DOMAINS_EXPORT static const int kNedges = 4;
            SPATIAL_DOMAINS_EXPORT static const std::string XMLElementType;

        protected:
            PointGeomVector                     m_verts;
            SegGeomVector                       m_edges;
            StdRegions::Orientation             m_eorient[kNedges];
            int                                 m_fid;
            bool                                m_ownVerts;
            std::list<CompToElmt>               m_elmtMap;
            CurveSharedPtr                      m_curve;

            SPATIAL_DOMAINS_EXPORT virtual void v_AddElmtConnected(
                    int gvo_id, 
                    int locid);
            
            SPATIAL_DOMAINS_EXPORT virtual int  v_NumElmtConnected() const;
	
            SPATIAL_DOMAINS_EXPORT virtual bool v_IsElmtConnected(
                    int gvo_id, 
                    int locid) const;

            SPATIAL_DOMAINS_EXPORT virtual int v_GetFid() const;

            SPATIAL_DOMAINS_EXPORT virtual int v_GetCoordim() const;

	    SPATIAL_DOMAINS_EXPORT virtual const LibUtilities::BasisSharedPtr 
                    v_GetBasis(const int i);

	    SPATIAL_DOMAINS_EXPORT virtual const LibUtilities::BasisSharedPtr 
                    v_GetEdgeBasis(const int i);

	    SPATIAL_DOMAINS_EXPORT virtual NekDouble v_GetCoord(
                    const int i, 
                    const Array<OneD,const NekDouble> &Lcoord);

	    SPATIAL_DOMAINS_EXPORT void v_GenGeomFactors();

            SPATIAL_DOMAINS_EXPORT virtual void v_SetOwnData();

	    /// Put all quadrature information into edge structure
            SPATIAL_DOMAINS_EXPORT virtual void v_FillGeom();

            SPATIAL_DOMAINS_EXPORT virtual NekDouble v_GetLocCoords(
                    const Array<OneD,const NekDouble> &coords, 
                          Array<OneD,NekDouble> &Lcoords);

            SPATIAL_DOMAINS_EXPORT virtual int v_GetEid(int i) const;

            SPATIAL_DOMAINS_EXPORT virtual int v_GetVid(int i) const;

            SPATIAL_DOMAINS_EXPORT virtual PointGeomSharedPtr
                    v_GetVertex(int i) const;

            SPATIAL_DOMAINS_EXPORT virtual const Geometry1DSharedPtr 
                    v_GetEdge(int i) const;

            SPATIAL_DOMAINS_EXPORT virtual StdRegions::Orientation 
                    v_GetEorient(const int i) const;

            SPATIAL_DOMAINS_EXPORT virtual StdRegions::Orientation 
                    v_GetCartesianEorient(const int i) const;

            /// Return the edge number of the given edge
            SPATIAL_DOMAINS_EXPORT virtual int v_WhichEdge(
                    SegGeomSharedPtr edge); 

            SPATIAL_DOMAINS_EXPORT virtual int v_GetNumVerts() const;

            SPATIAL_DOMAINS_EXPORT virtual int v_GetNumEdges() const;

            SPATIAL_DOMAINS_EXPORT virtual bool v_ContainsPoint(
                    const Array<OneD, const NekDouble> &gloCoord, 
                          NekDouble                     tol = 0.0);

            SPATIAL_DOMAINS_EXPORT virtual bool v_ContainsPoint(
                    const Array<OneD, const NekDouble> &gloCoord,
                          Array<OneD, NekDouble>       &locCoord,
                          NekDouble                     tol);

            SPATIAL_DOMAINS_EXPORT virtual bool v_ContainsPoint(
                    const Array<OneD, const NekDouble> &gloCoord,
                          Array<OneD, NekDouble>       &locCoord,
                          NekDouble                     tol,
                          NekDouble                    &resid);

            SPATIAL_DOMAINS_EXPORT virtual void v_Reset(
                    CurveMap &curvedEdges,
                    CurveMap &curvedFaces);

        private:
            /// Boolean indicating whether object owns the data
            bool                                m_ownData;

            void SetUpXmap();
        };

    }; //end of namespace
}; //end of namespace

#endif //NEKTAR_SPATIALDOMAINS_QUADGEOM_H
