ElInfo.h

/******************************************************************************
 *
 * AMDiS - Adaptive multidimensional simulations
 *
 * Copyright (C) 2013 Dresden University of Technology. All Rights Reserved.
 * Web: https://fusionforge.zih.tu-dresden.de/projects/amdis
 *
 * Authors: 
 * Simon Vey, Thomas Witkowski, Andreas Naumann, Simon Praetorius, et al.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 *
 * This file is part of AMDiS
 *
 * See also license.opensource.txt in the distribution.
 * 
 ******************************************************************************/



/** \file ElInfo.h */

#ifndef AMDIS_ELINFO_H
#define AMDIS_ELINFO_H

#include <boost/numeric/mtl/mtl.hpp>

#include "Flag.h"
#include "Boundary.h"
#include "Global.h"
#include "FixVec.h"
#include "Element.h"
#include "AMDiS_fwd.h" 

namespace AMDiS {

  /** \ingroup Traverse
   * \brief 
   * An ElInfo object holds informations wich are not stored in the corresponding
   * element. It is filled during mesh traversal by the traversal routines.
   * A fill flag determines which informations should be filled and which elements
   * should be visited. Since it is a
   * pure virtual base class for the dimension speciefic ElInfo classes, it must
   * not be instantiated directly.
   * \see ElInfo1d \see ElInfo2d \see ElInfo3d
   */

  class ElInfo
  {
  protected: 
    /// Protected constructor. Avoids instatiation of the basis class
    ElInfo();

    /// Protected constructor. Avoids instatiation of the basis class.
    /// \param mesh pointer to the corresponding mesh.
    ElInfo(Mesh *mesh);

  public:
    /// Virtual destructor because ElInfo is pure virtual.
    virtual ~ElInfo();

    /// Assignement operator.
    /// \param rhs right hand side.
    ElInfo& operator=(const ElInfo& rhs) 
    {
      mesh = rhs.mesh;
      element = rhs.element;
      parent = rhs.parent;
      macroElement = rhs.macroElement;
      fillFlag = rhs.fillFlag;
      level = rhs.level;
      elType = rhs.elType;
      iChild = rhs.iChild;
      coord = rhs.coord;
      boundary = rhs.boundary;
      projection = rhs.projection;
      oppCoord = rhs.oppCoord;
      neighbour = rhs.neighbour;
      neighbourCoord = rhs.neighbourCoord;
      oppVertex = rhs.oppVertex;
      det = rhs.det;
      grdLambda = rhs.grdLambda;
      parametric = rhs.parametric;
      dimOfWorld = rhs.dimOfWorld;

      return *this;
    }

  public:
    /** \name getting methods
     * \{ 
     */

    /// Get ElInfo's \ref mesh
    inline Mesh* getMesh() const 
    { 
      return mesh; 
    }

    /// Get ElInfo's \ref macroElement
    inline MacroElement* getMacroElement() const 
    { 
      return macroElement; 
    }

    /// Get ElInfo's \ref element
    inline Element* getElement() const 
    { 
      return element; 
    }

    /// Get ElInfo's \ref parent
    inline Element* getParent() const 
    { 
      return parent; 
    }

    /// Get ElInfo's \ref fillFlag
    inline Flag getFillFlag() const 
    { 
      return fillFlag; 
    }

    /// Get ElInfo's \ref level
    inline int getLevel() const 
    { 
      return level; 
    }

    /// Get ElInfo's \ref iChild
    inline int getIChild() const 
    {
      return iChild;
    }

    /// Get ElInfo's \ref coord[i]. This is a WorldVector<double> filled with 
    /// the coordinates of the i-th vertex of element \ref el.
    inline WorldVector<double>& getCoord(int i) 
    { 
      return coord[i]; 
    }

    /// Get ElInfo's \ref coord[i]. This is a WorldVector<double> filled with the
    /// coordinates of the i-th vertex of element \ref el.
    inline const WorldVector<double>& getCoord(int i) const 
    { 
      return coord[i]; 
    }

    /// Get ElInfo's \ref coord. This is a FixVec<WorldVector<double> > filled 
    /// with the coordinates of the all vertice of element \ref el.
    inline FixVec<WorldVector<double>, VERTEX>& getCoords() 
    { 
      return coord; 
    }

    /// Get ElInfo's \ref coord. This is a FixVec<WorldVector<double> > filled
    /// with the coordinates of the all vertice of element \ref el.
    inline const FixVec<WorldVector<double>, VERTEX>& getCoords() const 
    { 
      return coord; 
    }

    /// Get ElInfo's \ref oppCoord[i]
    inline WorldVector<double>& getOppCoord(int i) 
    { 
      return oppCoord[i]; 
    }

    /// Get ElInfo's \ref boundary[i] 
    inline BoundaryType getBoundary(int i) const 
    { 
      return boundary[i]; 
    }

    /// Get boundary type of i-th vertex/edge/face (pos).
    BoundaryType getBoundary(GeoIndex pos, int i);

    /// Get ElInfo's \ref neighbour[i]
    inline Element* getNeighbour(int i) const 
    { 
      return neighbour[i]; 
    }

    /// Get ElInfo's \ref neighbourCoord[i]
    inline FixVec<WorldVector<double>, VERTEX> getNeighbourCoord(int i) const 
    {
      return neighbourCoord[i];
    }

    /// Get ElInfo's \ref oppVertex[i] 
    inline int getOppVertex(int i) const 
    { 
      return oppVertex[i]; 
    }

    virtual int getSideOfNeighbour(int i) 
    { 
      return oppVertex[i]; 
    }

    /// Get ElInfo's \ref det
    inline double getDet() const 
    { 
      return det; 
    }

    /// Returns \ref grdLambda
    inline const DimVec<WorldVector<double> >& getGrdLambda() const 
    { 
      return grdLambda; 
    }
    
    inline void getGrdLambda(mtl::dense2D<double>& grd_lam)
    {
      grd_lam.change_dim(grdLambda.size(), Global::getGeo(WORLD));
      for (size_t i = 0; i < static_cast<size_t>(grdLambda.size()); i++)
	for (size_t j = 0; j < static_cast<size_t>(Global::getGeo(WORLD)); j++)
	  grd_lam(i,j) = grd_lam[i][j];
    }

    /// Returns \ref projection[i]
    inline Projection *getProjection(int i) const 
    {
      return projection[i];
    }

    /// Returns \ref parametric
    inline bool getParametric() const
    { 
      return parametric; 
    }

    /// Returns \ref refinementPath
    inline unsigned long getRefinementPath() const
    {
      return refinementPath;
    } 

    /// Get \ref refinementPathLength
    inline int getRefinementPathLength() const
    {
      return refinementPathLength;
    }

    virtual mtl::dense2D<double>& getSubElemCoordsMat(int degree) const 
    {
      return subElemMatrices[degree][std::make_pair(refinementPathLength, refinementPath)];
    }

    virtual mtl::dense2D<double>& getSubElemGradCoordsMat(int degree) const 
    {
      return getSubElemCoordsMat(degree);
    }

    /** \} */ 

    /** \name setting methods
     * \{ 
     */

    /// Set ElInfo's \ref mesh
    inline void setMesh(Mesh* aMesh) 
    { 
      mesh = aMesh; 
    }

    /// Set ElInfo's \ref macroElement
    inline void setMacroElement(MacroElement* mel) 
    { 
      macroElement = mel; 
    }

    /// Set ElInfo's \ref element
    inline void setElement(Element* elem) 
    { 
      element = elem; 
    }

    /// Set ElInfo's \ref parent
    inline void setParent(Element* elem) 
    { 
      parent = elem; 
    }

    /// Set ElInfo's \ref fillFlag
    inline void setFillFlag(Flag flag) 
    { 
      fillFlag = flag; 
    }

    /// Sets ElInfo's \ref coord[i]. 
    inline void setCoord(int i, WorldVector<double>& c) 
    { 
      coord[i] = c; 
    }

    /// Sets ElInfo's \ref coord. 
    inline void setCoords(FixVec<WorldVector<double>, VERTEX >& c) 
    { 
      coord = c; 
    }

    /// Set ElInfo's \ref level
    inline void setLevel(int l) 
    { 
      level = l; 
    }

    /// Set ElInfo's \ref boundary[i] 
    inline void setBoundary(int i, BoundaryType t) 
    { 
      boundary[i] = newBound(boundary[i], t);
    }

    /// Set \ref projection[i] = p
    inline void setProjection(int i, Projection *p) 
    {
      projection[i] = p;
    }

    /// Set ElInfo's \ref boundary[i] 
    inline void setNeighbor(int i, Element* neigh) 
    { 
      neighbour[i] = neigh;
    }

    /// Set \ref det = d
    inline void setDet(double d) 
    { 
      det = d; 
    }

    /// Set \ref parametric = param
    inline void setParametric(bool param) 
    { 
      parametric = param; 
    }

    /// Set \ref refinementPath
    inline void setRefinementPath(unsigned long rPath)
    {
      refinementPath = rPath;
    } 

    /// Set \ref refinementPathLength
    inline void setRefinementPathLength(int length)
    {
      refinementPathLength = length;
    }

    /// Set ElInfo's \ref elType.
    inline void setType(int t) 
    { 
      elType = t; 
    }

    /** \} */


    /// Returns the absolute value of the determinant of the affine linear 
    /// parametrization's Jacobian
    virtual double calcDet() const;

    /// Used by non static method \ref calcDet(). Calculates the determinant
    /// for a given vector of vertex coordinates.
    double calcDet(const FixVec<WorldVector<double>, VERTEX> &coords) const;

    /// from CFE_Integration
    double calcSurfaceDet(VectorOfFixVecs<DimVec<double> > &surfVert) const;

    /// Checks whether flag is set in ElInfo's \ref fillFlag. If not, the 
    /// program exits.
    void testFlag(const Flag& flag) const;

    /// Transforms local barycentric coordinates of a point defined on this 
    /// element to global world coordinates.
    void coordToWorld(const DimVec<double>& lambda,
		      WorldVector<double>& world) const;
  
    /// Fills ElInfo's \ref det and \ref grdLambda entries.
    virtual void fillDetGrdLambda();

    /// Returns a pointer to a vector, which contains the barycentric coordinates
    /// with respect to \ref element of a point with world coordinates world.
    /// The barycentric coordinates are stored in lambda. 
    /// pure virtual => must be overriden in sub-class.
    virtual int worldToCoord(const WorldVector<double>& world, 
				   DimVec<double>* lambda) const = 0;

    /// Fills this ElInfo with macro element information of mel.
    /// pure virtual => must be overriden in sub-class.
    virtual void fillMacroInfo(const MacroElement *mel) = 0;

    /// Fills this ElInfo for the child ichild using hierarchy information and
    /// parent data parentInfo.
    /// pure virtual => must be overriden in sub-class.
    virtual void fillElInfo(int ichild, const ElInfo *parentInfo) = 0;


    void fillElInfo(const MacroElement *mel, 
		    int refinementPathLength, 
		    unsigned long refinementPath);

    /// Calculates the Jacobian of the barycentric coordinates on \element and
    /// stores the matrix in grd_lam. The return value of the function is the
    /// absolute value of the determinant of the affine linear paraetrization's 
    /// Jacobian.
    /// pure virtual => must be overriden in sub-class.
    virtual double calcGrdLambda(DimVec<WorldVector<double> >& grd_lam) = 0;

    /// calculates a normal of the given side (1d, 2d: edge, 3d: face) of \ref element.
    /// Returns the absolute value of the determinant of the
    /// transformation to the reference element.
    /// pure virtual => must be overriden in sub-class.
    virtual double getNormal(int side, WorldVector<double> &normal) const = 0;

    /// calculates a normal of the element in dim of world = dim + 1.
    /// Returns the absolute value of the determinant of the
    /// transformation to the reference element.
    /// pure virtual => must be overriden in sub-class.
    virtual double getElementNormal(WorldVector<double> &elementNormal) const 
    {
      FUNCNAME("ElInfo::getElementNormal()");

      ERROR("virtual function not implemented in this sub-class ");
    
      return 0.0;
    }

    /// Get ElInfo's \ref elType.
    inline int getType() const 
    { 
      return elType; 
    }

  protected:
    /// Pointer to the current mesh
    Mesh *mesh;

    /// Pointer to the current element
    Element *element;

    /// \ref element is child of element parent
    Element *parent;

    /// \ref element is an element of the binary tree located at MacroElement 
    /// macroElement
    MacroElement *macroElement;

    /// Indicates wich elements will be called and wich information should be
    /// present while mesh traversal.
    Flag fillFlag;

    /// Level of the element. The level is zero for macro elements and the level
    /// of the children is (level of the parent + 1). level_ is filled always by
    /// the traversal routines.
    unsigned char level;

    /// Elements type index. This is used only for 3d, where type can be either 0, 1 or
    /// 2. In all other cases type is not used and the variable is set to 0.
    /// In 3d, it is filled automatically by the traversal routines.
    int elType;

    /// This ElInfo is the iChild-th child of the parent element.
    int iChild;

    /// \ref coord[i] is a WorldVector<double> storing the world coordinates of the
    /// i-th vertex of element \ref element.
    FixVec<WorldVector<double>, VERTEX> coord;

    /** \brief 
     * boundary[i] is the BoundaryType of the i-th edge/face
     * for i=0,...,N_NEIGH - 1. In 3d 
     * (*boundary)[N_FACES + i] is a pointer to the Boundary
     * object of the i-th edge, for i=0,..,N_EDGES - 1. It is
     * a NULL for an interior edge/face.
     */
    FixVec<BoundaryType, BOUNDARY> boundary;

    /// Vector storing pointers to projections for each face, edge, vertex.
    FixVec<Projection*, PROJECTION> projection;

    /// oppCoord[i] coordinates of the i-th neighbour vertex opposite the
    /// common edge/face.
    FixVec<WorldVector<double>, NEIGH> oppCoord;

    /// neighbour[i] pointer to the element at the edge/face with local index i.
    /// It is a NULL for boundary edges/faces.
    FixVec<Element*, NEIGH> neighbour;

    /// neighbourCoord[i][j] are the coordinate of the j-th vertex of the i-th
    /// neighbour element with the common edge/face.
    FixVec<FixVec<WorldVector<double>, VERTEX>, NEIGH> neighbourCoord;

    /// oppVertex[i] is undefined if neighbour[i] is a pointer to NULL. 
    /// Otherwise it is the local index of the neighbour's vertex opposite the
    /// common edge/face.
    FixVec<int, NEIGH> oppVertex;

    /// Elements determinant.
    double det;

    /// Gradient of lambda.
    DimVec<WorldVector<double> > grdLambda;

    /// True, if this elInfo stores parametrized information. False, otherwise.
    bool parametric;

    /// Stores the world dimension.
    int dimOfWorld;

    unsigned long refinementPath;

    int refinementPathLength;

  public:
    static std::vector<std::map<std::pair<int, unsigned long>, mtl::dense2D<double> > > subElemMatrices;
    
    static std::vector<std::map<std::pair<int, unsigned long>, mtl::dense2D<double> > > subElemGradMatrices;

    /// child_vertex[el_type][child][i] = father's local vertex index of new 
    /// vertex i. 4 stands for the newly generated vertex .     
    static const int childVertex[3][2][4];

    /// child_edge[el_type][child][i] = father's local edge index of new edge i.
    /// new edge 2 is half of old edge 0, new edges 4,5 are really new edges, and
    /// value is different: child_edge[][][4,5] = index of same edge in other
    /// child.
    static const int childEdge[3][2][6];

    friend class ElInfo1d;
    friend class ElInfo2d;
    friend class ElInfo3d;
  };

}

#include "ElInfo1d.h"
#include "ElInfo2d.h"
#include "ElInfo3d.h"

#endif  // AMDIS_ELINFO_H