convection_diffusion_fv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-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__CONVECTION_DIFFUSION__CONVECTION_DIFFUSION_FV__
#define __H__UG__LIB_DISC__CONVECTION_DIFFUSION__CONVECTION_DIFFUSION_FV__
 
// library intern headers
#include "../convection_diffusion_base.h"
#include "lib_disc/spatial_disc/disc_util/conv_shape_interface.h"
 
namespace ug{
namespace ConvectionDiffusionPlugin{
 
// \ingroup lib_disc_elem_disc
 
 
template< typename TDomain>
class ConvectionDiffusionFV : public ConvectionDiffusionBase<TDomain>
{
  private:
    typedef ConvectionDiffusionBase<TDomain> base_type;
 
    typedef ConvectionDiffusionFV<TDomain> this_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    ConvectionDiffusionFV(const char* functions, const char* subsets);
 
  private:
 
    template <typename TElem, typename TFVGeom>
    void prep_elem_loop(const ReferenceObjectID roid, const int si);
 
 
    template <typename TElem, typename TFVGeom>
    void prep_elem(const LocalVector& u, GridObject* elem, const ReferenceObjectID roid, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void fsh_elem_loop();
 
    template <typename TElem, typename TFVGeom>
    void add_jac_A_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_jac_M_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_def_A_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_def_M_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void add_rhs_elem(LocalVector& d, GridObject* elem, const MathVector<dim> vCornerCoords[]);
    
  protected:
    template <typename TElem, typename TFVGeom>
    void lin_def_velocity(const LocalVector& u,
                          std::vector<std::vector<MathVector<dim> > > vvvLinDef[],
                          const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_diffusion(const LocalVector& u,
                           std::vector<std::vector<MathMatrix<dim,dim> > > vvvLinDef[],
                           const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_flux(const LocalVector& u,
                      std::vector<std::vector<MathVector<dim> > > vvvLinDef[],
                      const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_reaction(const LocalVector& u,
                          std::vector<std::vector<number> > vvvLinDef[],
                          const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_reaction_rate(const LocalVector& u,
                               std::vector<std::vector<number> > vvvLinDef[],
                               const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_source(const LocalVector& u,
                        std::vector<std::vector<number> > vvvLinDef[],
                        const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_vector_source(const LocalVector& u,
                               std::vector<std::vector<MathVector<dim> > > vvvLinDef[],
                               const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_mass_scale(const LocalVector& u,
                            std::vector<std::vector<number> > vvvLinDef[],
                            const size_t nip);
 
    template <typename TElem, typename TFVGeom>
    void lin_def_mass(const LocalVector& u,
                      std::vector<std::vector<number> > vvvLinDef[],
                      const size_t nip);
                
  private:
    static const size_t _C_ = 0;
 
    using base_type::m_imDiffusion;
    using base_type::m_imVelocity;
    using base_type::m_imFlux;
    using base_type::m_imSource;
    using base_type::m_imSourceExpl;
    using base_type::m_imVectorSource;
    using base_type::m_imReactionRate;
    using base_type::m_imReactionRateExpl;
    using base_type::m_imReaction;
    using base_type::m_imReactionExpl;
    using base_type::m_imMassScale;
    using base_type::m_imMass;
 
    using base_type::m_exGrad;
    using base_type::m_exValue;
 
  protected:
    template <typename TElem, typename TFVGeom>
    void ex_value(number vValue[],
                  const MathVector<dim> vGlobIP[],
                  number time, int si,
                  const LocalVector& u,
                  GridObject* elem,
                  const MathVector<dim> vCornerCoords[],
                  const MathVector<TFVGeom::dim> vLocIP[],
                  const size_t nip,
                  bool bDeriv,
                  std::vector<std::vector<number> > vvvDeriv[]);
 
    template <typename TElem, typename TFVGeom>
    void ex_grad(MathVector<dim> vValue[],
                 const MathVector<dim> vGlobIP[],
                 number time, int si,
                 const LocalVector& u,
                 GridObject* elem,
                 const MathVector<dim> vCornerCoords[],
                 const MathVector<TFVGeom::dim> vLocIP[],
                 const size_t nip,
                 bool bDeriv,
                 std::vector<std::vector<MathVector<dim> > > vvvDeriv[]);
 
  public:
    virtual void prepare_setting(const std::vector<LFEID>& vLfeID, bool bNonRegularGrid);
 
    virtual bool use_hanging() const;
 
    void set_quad_order(size_t order);
 
  protected:
    LFEID m_lfeID;
 
    bool m_bQuadOrderUserDef;
    int m_quadOrder;
 
    void register_all_funcs(const LFEID& lfeID, const int quadOrder);
    template <typename TElem, typename TFVGeom> void register_func();
};
 
// end group convection_diffusion
 
} // end ConvectionDiffusionPlugin
} // end namespace ug
 
 
#endif /*__H__UG__LIB_DISC__CONVECTION_DIFFUSION__CONVECTION_DIFFUSION_FV__*/