hfvcr_geom.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2015:  G-CSC, Goethe University Frankfurt
 * Author: Christian Wehner
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
/*
 * Node centered finite volume geometry for Crouzeix-Raviart-Elements
 */
 
#ifndef __H__UG__LIB_DISC__SPATIAL_DISC__DISC_HELPER__HANGING_CR_FINITE_VOLUME_GEOMETRY__
#define __H__UG__LIB_DISC__SPATIAL_DISC__DISC_HELPER__HANGING_CR_FINITE_VOLUME_GEOMETRY__
 
// extern libraries
#include <cmath>
#include <map>
#include <vector>
 
// other ug4 modules
#include "common/common.h"
 
// library intern includes
#include "lib_disc/reference_element/reference_element.h"
#include "lib_disc/reference_element/reference_mapping.h"
#include "lib_disc/reference_element/reference_mapping_provider.h"
#include "lib_disc/reference_element/reference_element_traits.h"
#include "lib_disc/local_finite_element/local_finite_element_provider.h"
#include "lib_disc/local_finite_element/crouzeix-raviart/crouzeix_raviart.h"
#include "lib_disc/quadrature/gauss/gauss_quad.h"
#include "lib_disc/common/geometry_util.h"
#include "lib_disc/domain_util_impl.h"
 
#include "fv_geom_base.h"
#include "fv_util.h"
 
namespace ug{
 
/* hcrfv traits */
 
template <int TWorldDim,int nrfaceco> struct hcrfv_traits
{
    typedef void scv_type;
    typedef void face_type;
  static const size_t maxNumSCVF;
  static const size_t maxNumSCV;
  static const size_t maxNSH;
  static const size_t maxNumCo;
};
 
template <> struct hcrfv_traits<2, 2>
{
    typedef ReferenceTriangle scv_type;
    typedef ReferenceEdge face_type;
  static const size_t maxNumSCVF = 8;
  static const size_t maxNumSCV = 8;
  static const size_t maxNSH = maxNumSCV;
  static const size_t maxNumCo = 4;
};
 
template <> struct hcrfv_traits<2, 3>
{
    typedef ReferenceTriangle scv_type;
    typedef ReferenceEdge face_type;
  static const size_t maxNumSCVF = 8;
  static const size_t maxNumSCV = 8;
  static const size_t maxNSH = maxNumSCV;
  static const size_t maxNumCo = 4;
};
 
template <> struct hcrfv_traits<3, 3>
{
  typedef ReferenceTetrahedron scv_type;
    typedef ReferenceTriangle face_type;
  static const size_t maxNumSCVF = 40;
  static const size_t maxNumSCV = 24;
  static const size_t maxNSH = maxNumSCV;
  static const size_t maxNumCo = 8;
};
 
template <> struct hcrfv_traits<3, 4>
{
    typedef ReferencePyramid scv_type;
    typedef ReferenceQuadrilateral face_type;
  static const size_t maxNumSCVF = 40;
  static const size_t maxNumSCV = 24;
  static const size_t maxNSH = maxNumSCV;
  static const size_t maxNumCo = 8;
};
 
// Dimension-indipendent Finite Volume Geometry
 
template <  typename TElem, int TWorldDim>
class HCRFVGeometry : public FVGeometryBase
{
  public:
    typedef TElem elem_type;
    
    typedef typename reference_element_traits<TElem>::reference_element_type ref_elem_type;
 
    static const int dim = ref_elem_type::dim;
 
    static const int worldDim = TWorldDim;
 
    static const bool usesHangingNodes = true;
 
    static const bool staticLocalData = true;
 
    typedef CrouzeixRaviartLSFS<ref_elem_type> local_shape_fct_set_type;
 
    static const size_t nsh = local_shape_fct_set_type::nsh;
 
    static const size_t numNaturalSCV = nsh;
 
    static const size_t numNaturalSCVF = ref_elem_type::numEdges;
    
    typedef hcrfv_traits<dim,worldDim> traits;
 
    static const size_t maxNumSCV = traits::maxNumSCV;
    
    static const size_t maxNumSCVF = traits::maxNumSCVF;
 
  public:
    static const int order = 1;
 
    typedef typename hcrfv_traits<TWorldDim,TWorldDim>::scv_type scv_type0;
      typedef typename hcrfv_traits<TWorldDim,TWorldDim>::face_type face_type0;
      typedef typename hcrfv_traits<TWorldDim,TWorldDim+1>::scv_type scv_type1;
      typedef typename hcrfv_traits<TWorldDim,TWorldDim+1>::face_type face_type1;
 
    static const size_t nip = 1;
 
  // local/global element barycenter
    MathVector<dim> localBary;
    MathVector<worldDim> globalBary;
 
  public:
 
    class SCVF
    {
      public:
        static const size_t numCo = dim;
 
      public:
        SCVF() {}
 
        inline size_t from() const {return From;}
 
        inline size_t to() const {return To;}
 
        inline size_t num_ip() const {return nip;}
 
        inline const MathVector<dim>& local_ip() const {return localIP;}
 
        inline const MathVector<worldDim>& global_ip() const {return globalIP;}
 
        inline const MathVector<worldDim>& normal() const {return Normal;}
 
        inline const MathMatrix<worldDim,dim>& JTInv() const {return JtInv;}
 
        inline number detJ() const {return detj;}
 
        inline size_t num_sh() const {return nsh;}
 
        inline number shape(size_t sh) const {return vShape[sh];}
 
        inline const number* shape_vector() const {return vShape;}
 
        inline const MathVector<dim>& local_grad(size_t sh) const
          {UG_ASSERT(sh < num_sh(), "Invalid index"); return vLocalGrad[sh];}
 
        inline const MathVector<dim>* local_grad_vector() const {return vLocalGrad;}
 
        inline const MathVector<worldDim>& global_grad(size_t sh) const
          {UG_ASSERT(sh < num_sh(), "Invalid index"); return vGlobalGrad[sh];}
 
        inline const MathVector<worldDim>* global_grad_vector() const {return vGlobalGrad;}
 
        inline size_t num_corners() const {return numCo;}
 
        inline const MathVector<dim>& local_corner(size_t co) const
          {UG_ASSERT(co < num_corners(), "Invalid index."); return vLocPos[co];}
 
        inline const MathVector<worldDim>& global_corner(size_t co) const
          {UG_ASSERT(co < num_corners(), "Invalid index."); return vGloPos[co];}
 
      private:
      //  let outer class access private members
        friend class HCRFVGeometry<TElem, TWorldDim>;
 
      // This scvf separates the scv with the ids given in "from" and "to"
      // The computed normal points in direction from->to
        size_t From, To;
 
      //  The normal on the SCVF pointing (from -> to)
        MathVector<worldDim> Normal; // normal (incl. area)
 
        MathVector<dim> vLocPos[numCo]; // local corners of scvf
        MathVector<worldDim> vGloPos[numCo]; // global corners of scvf
 
      // scvf part
        MathVector<dim> localIP; // local integration point
        MathVector<worldDim> globalIP; // global integration point
 
      // shapes and derivatives
        number vShape[nsh]; // shapes at ip
        MathVector<dim> vLocalGrad[nsh]; // local grad at ip
        MathVector<worldDim> vGlobalGrad[nsh]; // global grad at ip
        MathMatrix<worldDim,dim> JtInv; // Jacobian transposed at ip
        number detj; // Jacobian det at ip
    };
 
    class SCV
    {
      public:
        static const size_t maxNumCo = 5;
 
      public:
        SCV() : numCorners(maxNumCo) {};
 
        inline number volume() const {return Vol;}
 
        inline size_t num_corners() const {return numCorners;}
 
        inline const MathVector<dim>& local_corner(size_t co) const
          {UG_ASSERT(co < num_corners(), "Invalid index."); return vLocPos[co];}
 
        inline const MathVector<worldDim>& global_corner(size_t co) const
          {UG_ASSERT(co < num_corners(), "Invalid index."); return vGloPos[co];}
 
        inline size_t node_id() const {return nodeID;}
 
        inline size_t num_ip() const {return nip;}
 
        inline const MathVector<dim>& local_ip() const {return vLocIP;}
 
        inline const MathVector<worldDim>& global_ip() const {return vGlobIP;}
 
        inline const MathVector<worldDim>& normal() const {return Normal;}
 
        inline const MathMatrix<worldDim,dim>& JTInv() const {return JtInv;}
 
        inline number detJ() const {return detj;}
 
        inline size_t num_sh() const {return nsh;}
 
        inline number shape(size_t sh) const {return vShape[sh];}
 
        inline const number* shape_vector() const {return vShape;}
 
        inline const MathVector<dim>& local_grad(size_t sh) const
          {UG_ASSERT(sh < num_sh(), "Invalid index"); return vLocalGrad[sh];}
 
        inline const MathVector<dim>* local_grad_vector() const {return vLocalGrad;}
 
        inline const MathVector<worldDim>& global_grad(size_t sh) const
          {UG_ASSERT(sh < num_sh(), "Invalid index"); return vGlobalGrad[sh];}
 
        inline const MathVector<worldDim>* global_grad_vector() const {return vGlobalGrad;}
 
      private:
      //  let outer class access private members
        friend class HCRFVGeometry<TElem, TWorldDim>;
 
      //  The normal on the associated face pointing outward
        MathVector<worldDim> Normal; // normal (incl. area)
 
      //  node id of associated node
        size_t nodeID;
 
      //  volume of scv
        number Vol;
 
      //  number of corners of this element
        int numCorners;
 
      //  local and global positions of this element
        MathVector<dim> vLocPos[maxNumCo]; // local position of node
        MathVector<worldDim> vGloPos[maxNumCo]; // global position of node
 
        MathVector<dim> vLocIP; // local position of node
        MathVector<worldDim> vGlobIP; // global position of node
 
      // shapes and derivatives
        number vShape[nsh]; // shapes at ip
        MathVector<dim> vLocalGrad[nsh]; // local grad at ip
        MathVector<worldDim> vGlobalGrad[nsh]; // global grad at ip
        MathMatrix<worldDim,dim> JtInv; // Jacobian transposed at ip
        number detj; // Jacobian det at ip
    };
 
    class CONSTRAINED_DOF
    {
      public:
        static const size_t maxNumConstrainingDofs = 4;
        inline size_t constraining_dofs_index(size_t i) const{
          return cDofInd[i];
        }
        inline number constraining_dofs_weight(size_t i) const{
          return cDofWeights[i];
        }
        inline size_t index() const{
          return i;
        }
        inline size_t num_constraining_dofs() const{
          return numConstrainingDofs;
        }
      private:
        //  let outer class access private members
        friend class HCRFVGeometry<TElem, TWorldDim>;
 
        //  constraining dofs indices
        size_t cDofInd[maxNumConstrainingDofs];
        //  weights
        number cDofWeights[maxNumConstrainingDofs];
        //  local index of dof in element
        size_t i;
        //  nr of constraining dofs
        size_t numConstrainingDofs;
    };
  
    class HandledEdge
    {
    public:
      size_t index;
      size_t associatedSCV[2];
      size_t scvfIndex;
      // indicates if the handled side is from or to
      bool from;
    };
 
  public:
    HCRFVGeometry();
 
    void update_local_data();
 
    void update(GridObject* elem, const MathVector<worldDim>* vCornerCoords,
                const ISubsetHandler* ish = NULL);
 
    void print();
                   
    const MathVector<worldDim>* corners() const {return m_vCo;}             
 
    inline size_t num_scvf() const {return numSCVF;};
 
    inline const SCVF& scvf(size_t i) const
      {UG_ASSERT(i < maxNumSCVF, "Invalid Index."); return m_vSCVF[i];}
 
    inline size_t num_scv() const {return numSCV;}
 
    inline const SCV& scv(size_t i) const
      {UG_ASSERT(i < maxNumSCV, "Invalid Index."); return m_vSCV[i];}
 
    inline size_t num_constrained_dofs() const {return numConstrainedDofs;}
 
    inline const CONSTRAINED_DOF& constrained_dof(size_t i) const
      {UG_ASSERT(i < numConstrainedDofs, "Invalid Index."); return m_vCD[i];}
 
    inline size_t num_sh() const {return nsh;};
 
  public:
    size_t num_scvf_ips() const {return numSCVF;}
 
    const MathVector<dim>* scvf_local_ips() const {return m_vLocSCVF_IP;}
 
    const MathVector<worldDim>* scvf_global_ips() const {return m_vGlobSCVF_IP;}
 
    size_t num_scv_ips() const {return numSCV;}
 
    const MathVector<dim>* scv_local_ips() const {return m_vLocUnkCoords;}
 
    const MathVector<worldDim>* scv_global_ips() const {return m_vGlobUnkCoords;}
 
    const MathVector<dim> local_bary() const {return localBary;}
 
    const MathVector<worldDim> global_bary() const {return globalBary;}
 
  protected:
  //  global and local ips on SCVF
    MathVector<worldDim> m_vGlobSCVF_IP[maxNumSCVF];
    MathVector<dim> m_vLocSCVF_IP[maxNumSCVF];
   // coord of location for unknowns in faces (edge/face barycenter)
    MathVector<worldDim> m_vGlobUnkCoords[maxNumSCV];
    MathVector<dim> m_vLocUnkCoords[maxNumSCV];
    
    static const size_t numMaxCo = 8;
   // corner coordinates
    MathVector<worldDim> m_vCo[numMaxCo];
 
  private:
    MathVector<dim> m_ipCoord[maxNumSCVF];
 
    SCVF m_vSCVF[maxNumSCVF];
 
    SCV m_vSCV[maxNumSCV];
 
    CONSTRAINED_DOF m_vCD[maxNumSCV];
  
    std::vector<HandledEdge> handledEdges;
 
    TElem* m_pElem;
 
    ReferenceMapping<ref_elem_type, worldDim> m_mapping;
 
    const ref_elem_type& m_rRefElem;
 
    const local_shape_fct_set_type& m_rTrialSpace;
    
    size_t numSCV;
    size_t numSCVF;
    size_t numConstrainedDofs;
    // numDofs number of all dofs including constraining and constrained dofs
    size_t numDofs;
 
    bool localUpdateNecessary;
  
    static const size_t deleted = 117;
 
};
 
 
}
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__DISC_HELPER__HANGING_CR_FINITE_VOLUME_GEOMETRY__ */