neumann_boundary_fv1.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__SPATIAL_DISC__ELEM_DISC__NEUMANN_BOUNDARY___NEUMANN_BOUNDARY_FV1__
#define __H__UG__LIB_DISC__SPATIAL_DISC__ELEM_DISC__NEUMANN_BOUNDARY___NEUMANN_BOUNDARY_FV1__
 
// other ug4 modules
#include "common/common.h"
 
// library intern headers
#include "../neumann_boundary_base.h"
 
namespace ug{
 
template<typename TDomain>
class NeumannBoundaryFV1
  : public NeumannBoundaryBase<TDomain>
{
  private:
    typedef NeumannBoundaryBase<TDomain> base_type;
 
    typedef NeumannBoundaryFV1<TDomain> this_type;
 
    typedef SideAndElemErrEstData<TDomain> err_est_type;
 
  public:
    static const int dim = base_type::dim;
 
  public:
    NeumannBoundaryFV1(const char* function);
 
    void add(SmartPtr<CplUserData<number, dim> > data,      const char* BndSubsets, const char* InnerSubsets);
    void add(SmartPtr<CplUserData<number, dim, bool> > user,    const char* BndSubsets, const char* InnerSubsets);
    void add(SmartPtr<CplUserData<MathVector<dim>, dim> > user,   const char* BndSubsets, const char* InnerSubsets);
 
  protected:
    using typename base_type::Data;
 
    struct NumberData : public base_type::Data
    {
      NumberData(SmartPtr<CplUserData<number, dim> > data,
                 std::string BndSubsets, std::string InnerSubsets)
        : base_type::Data(BndSubsets, InnerSubsets)
      {
        import.set_data(data);
      }
 
      template<typename TElem, typename TFVGeom>
      void extract_bip(const TFVGeom& geo);
 
      template <typename TElem, typename TFVGeom>
      void lin_def(const LocalVector& u,
                   std::vector<std::vector<number> > vvvLinDef[],
                   const size_t nip);
 
      template <int refDim>
      void set_local_ips(const MathVector<refDim>* ips, std::size_t nIPs)
      {import.template set_local_ips<refDim>(ips, nIPs);}
 
      void set_global_ips(const MathVector<dim>* ips, std::size_t nIPs)
      {import.set_global_ips(ips, nIPs);}
 
      template <int refDim>
      std::vector<MathVector<refDim> >* local_ips();
 
      DataImport<number, dim> import;
      std::vector<MathVector<3> > vLocIP_dim3;
      std::vector<MathVector<2> > vLocIP_dim2;  // might have Neumann bnd for lower-dim elements!
      std::vector<MathVector<1> > vLocIP_dim1;
      std::vector<MathVector<dim> > vGloIP;
    };
 
    struct BNDNumberData : public base_type::Data
    {
      BNDNumberData(SmartPtr<CplUserData<number, dim, bool> > functor_,
              std::string BndSubsets, std::string InnerSubsets)
        : base_type::Data(BndSubsets, InnerSubsets), functor(functor_) {}
 
      SmartPtr<CplUserData<number, dim, bool> > functor;
    };
 
    struct VectorData : public base_type::Data
    {
      VectorData(SmartPtr<CplUserData<MathVector<dim>, dim> > functor_,
                 std::string BndSubsets, std::string InnerSubsets)
      : base_type::Data(BndSubsets, InnerSubsets), functor(functor_) {}
 
      SmartPtr<CplUserData<MathVector<dim>, dim> > functor;
    };
 
    std::vector<NumberData> m_vNumberData;
    std::vector<BNDNumberData> m_vBNDNumberData;
    std::vector<VectorData> m_vVectorData;
 
    void update_subset_groups();
    using base_type::update_subset_groups;
 
    int m_si;
 
  public:
    virtual void prepare_setting(const std::vector<LFEID>& vLfeID, bool bNonRegularGrid);
 
  protected:
    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_rhs_elem(LocalVector& d, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void prep_err_est_elem_loop(const ReferenceObjectID roid, const int si);
 
    template <typename TElem, typename TFVGeom>
    void prep_err_est_elem(const LocalVector& u, GridObject* elem, const MathVector<dim> vCornerCoords[]);
 
    template <typename TElem, typename TFVGeom>
    void compute_err_est_rhs_elem(GridObject* elem, const MathVector<dim> vCornerCoords[], const number& scale);
 
    template <typename TElem, typename TFVGeom>
    void fsh_err_est_elem_loop();
 
 
 
    static const int _C_ = 0;
 
  private:
    void register_all_funcs(bool bHang);
    template <typename TElem, typename TFVGeom> void register_func();
};
 
} // end namespac ug
 
#endif /*__H__UG__LIB_DISC__SPATIAL_DISC__ELEM_DISC__NEUMANN_BOUNDARY___NEUMANN_BOUNDARY_FV1__*/