conv_shape_interface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-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__SPATIAL_DISC__ELEM_DISC__DENSITY_DRIVEN_FLOW__FV1__CONV_SHAPE_INTERFACE__
#define __H__UG__LIB_DISC__SPATIAL_DISC__ELEM_DISC__DENSITY_DRIVEN_FLOW__FV1__CONV_SHAPE_INTERFACE__
 
#include "common/common.h"
#include "common/util/provider.h"
#include "common/math/ugmath_types.h"
#include "lib_disc/spatial_disc/disc_util/fv_geom_base.h"
 
namespace ug{
 
// Interface for Convection shapes
 
 
template <int dim>
class IConvectionShapes
{
  public:
    typedef IConvectionShapes<dim> this_type;
 
    typedef bool (this_type::*UpdateFunc)
        (const FVGeometryBase* geo,
         const MathVector<dim>* Velocity,
         const MathMatrix<dim, dim>* Diffusion,
         bool computeDeriv);
 
  public:
    IConvectionShapes()
      : m_numScvf(0), m_numSh(0), m_bNonZeroDerivDiffusion(true)
    {
      m_vUpdateFunc.clear();
      m_vConvShape.clear();
      m_vConvShapeVel.clear();
      m_vConvShapeDiffusion.clear();
    }
 
    virtual ~IConvectionShapes() {};
 
    size_t num_sh() const {return m_numSh;}
 
    size_t num_scvf() const {return m_numScvf;}
 
    number operator()(size_t scvf, size_t sh) const
    {
      UG_ASSERT(scvf < m_vConvShape.size(), "Invalid index");
      UG_ASSERT(sh < m_vConvShape[scvf].size(), "Invalid index");
      return m_vConvShape[scvf][sh];
    }
 
    const MathVector<dim>& D_vel(size_t scvf, size_t sh) const
    {
      UG_ASSERT(scvf < m_vConvShapeVel.size(), "Invalid index");
      UG_ASSERT(sh < m_vConvShapeVel[scvf].size(), "Invalid index");
      return m_vConvShapeVel[scvf][sh];
    }
 
    bool non_zero_deriv_diffusion() const {return m_bNonZeroDerivDiffusion;}
 
    const MathMatrix<dim,dim>& D_diffusion(size_t scvf, size_t sh) const
    {
      UG_ASSERT(scvf < m_vConvShapeDiffusion.size(), "Invalid index");
      UG_ASSERT(sh < m_vConvShapeDiffusion[scvf].size(), "Invalid index");
      return m_vConvShapeDiffusion[scvf][sh];
    }
 
    bool update(const FVGeometryBase* geo,
          const MathVector<dim>* Velocity,
          const MathMatrix<dim, dim>* DiffDisp,
                bool computeDeriv)
      {return (this->*(m_vUpdateFunc[m_id])) (geo, Velocity, DiffDisp, computeDeriv);}
 
  // internal handling
 
  protected:
    void set_sizes(size_t numScvf, size_t numSh);
 
    void set_non_zero_deriv_diffusion_flag(bool flag) {m_bNonZeroDerivDiffusion = flag;}
 
    number& conv_shape(size_t scvf, size_t sh)
    {
      UG_ASSERT(scvf < m_vConvShape.size(), "Invalid index");
      UG_ASSERT(sh < m_vConvShape[scvf].size(), "Invalid index");
      return m_vConvShape[scvf][sh];
    }
 
    MathVector<dim>& D_vel(size_t scvf, size_t sh)
    {
      UG_ASSERT(scvf < m_vConvShapeVel.size(), "Invalid index");
      UG_ASSERT(sh < m_vConvShapeVel[scvf].size(), "Invalid index");
      return m_vConvShapeVel[scvf][sh];
    }
 
    MathMatrix<dim,dim>& conv_shape_diffusion(size_t scvf, size_t sh)
    {
      UG_ASSERT(scvf < m_vConvShapeDiffusion.size(), "Invalid index");
      UG_ASSERT(sh < m_vConvShapeDiffusion[scvf].size(), "Invalid index");
      return m_vConvShapeDiffusion[scvf][sh];
    }
 
 
    size_t m_numScvf;
 
    size_t m_numSh;
 
    std::vector<std::vector<number> > m_vConvShape;
 
    std::vector<std::vector<MathVector<dim> > > m_vConvShapeVel;
 
    std::vector<std::vector<MathMatrix<dim,dim> > > m_vConvShapeDiffusion;
 
    bool m_bNonZeroDerivDiffusion;
 
  // registering process
 
  public:
    template <typename TFVGeom, typename TAssFunc>
    void register_update_func(TAssFunc func);
 
    template <typename TFVGeom>
    bool set_geometry_type(const TFVGeom& geo);
 
  protected:
    std::vector<UpdateFunc> m_vUpdateFunc;
 
    int m_id;
};
 
// Interface for Stabilization
 
//  register a update function for a Geometry
template <int dim>
template <typename TFVGeom, typename TAssFunc>
void
IConvectionShapes<dim>::
register_update_func(TAssFunc func)
{
//  get unique geometry id
  size_t id = GetUniqueFVGeomID<TFVGeom>();
 
//  make sure that there is enough space
  if((size_t)id >= m_vUpdateFunc.size())
    m_vUpdateFunc.resize(id+1, NULL);
 
//  set pointer
  m_vUpdateFunc[id] = (UpdateFunc)func;
}
 
//  set the Geometry type to use for next updates
template <int dim>
template <typename TFVGeom>
bool
IConvectionShapes<dim>::
set_geometry_type(const TFVGeom& geo)
{
//  get unique geometry id
  size_t id = GetUniqueFVGeomID<TFVGeom>();
 
//  check that function exists
  if(id >= m_vUpdateFunc.size() || m_vUpdateFunc[id] == NULL)
  {
    UG_LOG("ERROR in 'IConvectionShapes::set_geometry_type':"
        " No update function registered for this Geometry.\n");
    return false;
  }
 
//  set current geometry
  m_id = id;
 
//  set sizes
  set_sizes(geo.num_scvf(), geo.num_sh());
 
//  we're done
  return true;
}
 
 
//  resize the data arrays
template <int dim>
void
IConvectionShapes<dim>::
set_sizes(size_t numScvf, size_t numSh)
{
//  remember sizes
  m_numScvf = numScvf;
  m_numSh = numSh;
 
//  adjust arrays
  m_vConvShape.resize(m_numScvf);
  m_vConvShapeVel.resize(m_numScvf);
  m_vConvShapeDiffusion.resize(m_numScvf);
  for(size_t scvf = 0; scvf < m_numScvf; ++scvf)
  {
    m_vConvShape[scvf].resize(m_numSh);
    m_vConvShapeVel[scvf].resize(m_numSh);
    m_vConvShapeDiffusion[scvf].resize(m_numSh);
  }
}
 
 
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__ELEM_DISC__DENSITY_DRIVEN_FLOW__FV1__CONV_SHAPE_INTERFACE__ */