reference_mapping_provider.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * 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.
 */
 
#ifndef __H__UG__LIB_DISC__REFERENCE_ELEMENT__REFERENCE_MAPPING_PROVIDER__
#define __H__UG__LIB_DISC__REFERENCE_ELEMENT__REFERENCE_MAPPING_PROVIDER__
 
 
#include "common/common.h"
#include "common/math/ugmath.h"
#include "lib_grid/grid/grid_base_objects.h"
 
namespace ug{
 
 
template <int TDim, int TWorldDim = TDim>
class DimReferenceMapping
{
  public:
    static const int worldDim = TWorldDim;
 
    static const int dim = TDim;
 
  public:
    virtual bool is_linear() const = 0;
 
    virtual void update(const MathVector<worldDim>* vCornerCoord) = 0;
 
    virtual void update(const std::vector<MathVector<worldDim> >& vCornerCoord) = 0;
 
    virtual void local_to_global(MathVector<worldDim>& globPos,
                                 const MathVector<dim>& locPos) const = 0;
 
    virtual void local_to_global(MathVector<worldDim>* vGlobPos,
                   const MathVector<dim>* vLocPos, size_t n) const = 0;
 
    virtual void local_to_global(std::vector<MathVector<worldDim> >& vGlobPos,
                   const std::vector<MathVector<dim> >& vLocPos) const = 0;
 
    virtual void global_to_local(MathVector<dim>& locPos,
                                 const MathVector<worldDim>& globPos,
                                 const size_t maxIter = 1000,
                   const number tol = 1e-10) const = 0;
 
    virtual void global_to_local(MathVector<dim>* vLocPos,
                                 const MathVector<worldDim>* vGlobPos, size_t n,
                                 const size_t maxIter = 1000,
                   const number tol = 1e-10) const = 0;
 
    virtual void global_to_local(std::vector<MathVector<dim> >& vLocPos,
                                 const std::vector<MathVector<worldDim> >& vGlobPos,
                                 const size_t maxIter = 1000,
                   const number tol = 1e-10) const = 0;
 
    virtual void jacobian(MathMatrix<worldDim, dim>& J,
                const MathVector<dim>& locPos) const = 0;
 
    virtual void jacobian(MathMatrix<worldDim, dim>* vJ,
                const MathVector<dim>* vLocPos, size_t n) const = 0;
 
    virtual void jacobian(std::vector<MathMatrix<worldDim, dim> >& vJ,
                const std::vector<MathVector<dim> >& vLocPos) const = 0;
 
    virtual void jacobian_transposed(MathMatrix<dim, worldDim>& JT,
                                     const MathVector<dim>& locPos) const = 0;
 
    virtual void jacobian_transposed(MathMatrix<dim, worldDim>* vJT,
                     const MathVector<dim>* vLocPos, size_t n) const = 0;
 
    virtual void jacobian_transposed(std::vector<MathMatrix<dim, worldDim> >& vJT,
                     const std::vector<MathVector<dim> >& vLocPos) const = 0;
 
    virtual number jacobian_transposed_inverse(MathMatrix<worldDim, dim>& JTInv,
                                             const MathVector<dim>& locPos) const = 0;
 
    virtual void jacobian_transposed_inverse(MathMatrix<worldDim, dim>* vJTInv,
                         const MathVector<dim>* vLocPos, size_t n) const = 0;
 
    virtual void jacobian_transposed_inverse(MathMatrix<worldDim, dim>* vJTInv,
                                             number* vDet,
                         const MathVector<dim>* vLocPos, size_t n) const = 0;
 
    virtual void jacobian_transposed_inverse(std::vector<MathMatrix<worldDim, dim> >& vJTInv,
                         const std::vector<MathVector<dim> >& vLocPos) const = 0;
 
    virtual void jacobian_transposed_inverse(std::vector<MathMatrix<worldDim, dim> >& vJTInv,
                                             std::vector<number>& vDet,
                         const std::vector<MathVector<dim> >& vLocPos) const = 0;
 
    virtual number sqrt_gram_det(const MathVector<dim>& locPos) const = 0;
 
    virtual void sqrt_gram_det(number* vDet, const MathVector<dim>* vLocPos, size_t n) const = 0;
 
    virtual void sqrt_gram_det(std::vector<number>& vDet,
                  const std::vector<MathVector<dim> >& vLocPos) const = 0;
 
    virtual ~DimReferenceMapping() {}
};
 
 
 
class ReferenceMappingProvider {
  private:
  //  disallow private constructor
    ReferenceMappingProvider();
 
  // disallow copy and assignment (intentionally left unimplemented)
    ReferenceMappingProvider(const ReferenceMappingProvider&);
    ReferenceMappingProvider& operator=(const ReferenceMappingProvider&);
 
  //  private destructor
    ~ReferenceMappingProvider(){};
 
  //  Singleton provider
    static ReferenceMappingProvider& inst()
    {
      static ReferenceMappingProvider myInst;
      return myInst;
    };
 
  //  This is very dirty implementation, since casting to void. But, it is
  //  efficient, easy and typesafe. Maybe it should be changed to something
  //  inherent typesafe (not using casts) some day
  //  holding all mappings (worldDim x dim x roid)
    void* m_vvvMapping[4][4][NUM_REFERENCE_OBJECTS];
 
  //  casts void to map
    template <int TDim, int TWorldDim>
    DimReferenceMapping<TDim, TWorldDim>* get_mapping(ReferenceObjectID roid)
    {
      UG_STATIC_ASSERT(TDim <= 3, only_implemented_for_ref_dim_smaller_equal_3);
      UG_STATIC_ASSERT(TWorldDim <= 3, only_implemented_for_ref_dim_smaller_equal_3);
      UG_ASSERT(roid < NUM_REFERENCE_OBJECTS, "Roid specified incorrectly.");
      UG_ASSERT(roid >= 0, "Roid specified incorrectly.");
      return reinterpret_cast<DimReferenceMapping<TDim, TWorldDim>*>
            (m_vvvMapping[TDim][TWorldDim][roid]);
    }
 
  //  casts map to void
    template <int TDim, int TWorldDim>
    void set_mapping(ReferenceObjectID roid, DimReferenceMapping<TDim, TWorldDim>& map)
    {
      m_vvvMapping[TDim][TWorldDim][roid] = reinterpret_cast<void*>(&map);
    }
 
  public:
 
    template <int TDim, int TWorldDim>
    static DimReferenceMapping<TDim, TWorldDim>& get(ReferenceObjectID roid)
    {
      DimReferenceMapping<TDim, TWorldDim>* pMap = inst().get_mapping<TDim, TWorldDim>(roid);
      if(!pMap){
        UG_THROW("ReferenceMappingProvider: ReferenceMapping not found for "
            <<roid<<" from R^"<<TDim<<" to R^"<<TWorldDim);
      }
      else return *pMap;
    }
 
 
    template <int TDim, int TWorldDim>
    static DimReferenceMapping<TDim, TWorldDim>& get(ReferenceObjectID roid,
                                                     const std::vector<MathVector<TWorldDim> >& vCornerCoord)
    {
      DimReferenceMapping<TDim, TWorldDim>& map = get<TDim, TWorldDim>(roid);
      map.update(vCornerCoord);
      return map;
    }
 
 
    template <int TDim, int TWorldDim>
    static DimReferenceMapping<TDim, TWorldDim>& get(ReferenceObjectID roid,
                             const MathVector<TWorldDim>* vCornerCoord)
    {
      DimReferenceMapping<TDim, TWorldDim>& map = get<TDim, TWorldDim>(roid);
      map.update(vCornerCoord);
      return map;
    }
 
};
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__REFERENCE_ELEMENT__REFERENCE_MAPPING_PROVIDER__ */