domain_disc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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__DOMAIN_DISC__
#define __H__UG__LIB_DISC__SPATIAL_DISC__DOMAIN_DISC__
 
// other ug4 modules
#include "common/common.h"
#include "common/util/string_util.h"
 
// library intern headers
#include "subset_assemble_util.h"
#include "domain_disc_interface.h"
#include "lib_algebra/cpu_algebra_types.h"
#include "lib_disc/common/function_group.h"
#include "lib_disc/spatial_disc/elem_disc/elem_disc_assemble_util.h"
#include "lib_disc/spatial_disc/constraints/constraint_interface.h"
#include "disc_item.h"
#include "lib_disc/spatial_disc/domain_disc_interface.h"
#include "lib_disc/function_spaces/grid_function.h"
#include "lib_disc/function_spaces/error_elem_marking_strategy.h"
 
namespace ug {
 
 
 
template <typename TDomain, typename TAlgebra, typename TGlobAssembler>
class DomainDiscretizationBase
:   public IDomainDiscretization<TAlgebra>,
  public IDomainMarker<TDomain>,
    protected TGlobAssembler
{
        typedef TGlobAssembler gass_type;
        
  public:
    typedef TDomain domain_type;
 
    typedef TAlgebra algebra_type;
 
    typedef typename algebra_type::matrix_type matrix_type;
 
    typedef typename algebra_type::vector_type vector_type;
 
    typedef typename CPUAlgebra::vector_type error_vector_type;
 
    typedef ApproximationSpace<TDomain> approx_space_type;
    
    static const int dim = TDomain::dim;
    
  public:
    DomainDiscretizationBase(SmartPtr<approx_space_type> pApproxSpace) :
      m_bErrorCalculated(false),
      m_spApproxSpace(pApproxSpace), m_spAssTuner(new AssemblingTuner<TAlgebra>)
    {};
 
    virtual ~DomainDiscretizationBase() {};
 
  // Time independent part
 
    virtual void assemble_jacobian(matrix_type& J, const vector_type& u, ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_jacobian(matrix_type& J, const vector_type& u, const GridLevel& gl)
    {assemble_jacobian(J, u, dd(gl));}
 
    virtual void assemble_defect(vector_type& d, const vector_type& u, ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_defect(vector_type& d, const vector_type& u, const GridLevel& gl)
    {assemble_defect(d, u, dd(gl));}
 
    virtual void assemble_linear(matrix_type& A, vector_type& b, ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_linear(matrix_type& mat, vector_type& rhs, const GridLevel& gl)
    {assemble_linear(mat, rhs, dd(gl));}
 
    virtual void assemble_rhs(vector_type& rhs, const vector_type& u, ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_rhs(vector_type& rhs, const vector_type& u, const GridLevel& gl)
    {assemble_rhs(rhs, u, dd(gl));}
 
    virtual void assemble_rhs(vector_type& rhs, ConstSmartPtr<DoFDistribution> dd)
    {assemble_rhs(rhs, rhs, dd);}
    virtual void assemble_rhs(vector_type& rhs, const GridLevel& gl)
    {assemble_rhs(rhs, dd(gl));}
 
    virtual void adjust_solution(vector_type& u, ConstSmartPtr<DoFDistribution> dd);
    virtual void adjust_solution(vector_type& u, const GridLevel& gl)
    {adjust_solution(u, dd(gl));}
 
    void assemble_jacobian(matrix_type& J, GridFunction<TDomain, TAlgebra>& u)
    {assemble_jacobian(J, u, u.dof_distribution());}
 
    void assemble_defect(vector_type& d, GridFunction<TDomain, TAlgebra>& u)
    {assemble_defect(d, u, u.dof_distribution());}
 
    void assemble_linear(matrix_type& A, GridFunction<TDomain, TAlgebra>& rhs)
    {assemble_linear(A, rhs, rhs.dof_distribution());}
 
    void assemble_rhs(vector_type& rhs, GridFunction<TDomain, TAlgebra>& u)
    {assemble_rhs(rhs, u, u.dof_distribution());}
 
    void assemble_rhs(GridFunction<TDomain, TAlgebra>& b)
    {assemble_rhs(b, b.dof_distribution());}
 
    void adjust_solution(GridFunction<TDomain, TAlgebra>& u)
    {adjust_solution(u, u.dof_distribution());}
 
  // Time dependent part
    virtual void prepare_timestep(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, number future_time, ConstSmartPtr<DoFDistribution> dd);
    virtual void prepare_timestep(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, number future_time, const GridLevel& gl)
    {prepare_timestep(vSol, future_time, dd(gl));}
 
 
    virtual void prepare_timestep_elem(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                                  ConstSmartPtr<DoFDistribution> dd);
    virtual void prepare_timestep_elem(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, const GridLevel& gl)
    {prepare_timestep_elem(vSol, dd(gl));}
 
    virtual void assemble_jacobian(matrix_type& J,
                     ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                     const number s_a0,
                     ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_jacobian(matrix_type& J,
                                   ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                                   const number s_a, const GridLevel& gl)
    {assemble_jacobian(J, vSol, s_a, dd(gl));}
 
    virtual void assemble_defect(vector_type& d,
                   ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                   const std::vector<number>& vScaleMass,
                   const std::vector<number>& vScaleStiff,
                   ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_defect(vector_type& d,
                                 ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                                 const std::vector<number>& vScaleMass,
                                 const std::vector<number>& vScaleStiff,
                                 const GridLevel& gl)
    {assemble_defect(d, vSol, vScaleMass, vScaleStiff, dd(gl));}
 
    virtual void assemble_linear(matrix_type& A, vector_type& b,
                   ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                   const std::vector<number>& vScaleMass,
                   const std::vector<number>& vScaleStiff,
                   ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_linear(matrix_type& A, vector_type& b,
                                 ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                                 const std::vector<number>& vScaleMass,
                                 const std::vector<number>& vScaleStiff,
                                 const GridLevel& gl)
    {assemble_linear(A, b, vSol, vScaleMass, vScaleStiff, dd(gl));}
 
    virtual void assemble_rhs(   vector_type& b,
                   ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                   const std::vector<number>& vScaleMass,
                   const std::vector<number>& vScaleStiff,
                   ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_rhs(   vector_type& b,
                                 ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                                 const std::vector<number>& vScaleMass,
                                 const std::vector<number>& vScaleStiff,
                                 const GridLevel& gl)
    {assemble_rhs(b, vSol, vScaleMass, vScaleStiff, dd(gl));}
 
    virtual void adjust_solution(vector_type& u, number time, ConstSmartPtr<DoFDistribution> dd);
    virtual void adjust_solution(vector_type& u, number time, const GridLevel& gl)
    {adjust_solution(u, time, dd(gl));}
 
    virtual void finish_timestep(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, ConstSmartPtr<DoFDistribution> dd);
    virtual void finish_timestep(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, const GridLevel& gl)
    {finish_timestep(vSol, dd(gl));}
 
    virtual void finish_timestep_elem(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, ConstSmartPtr<DoFDistribution> dd);
    virtual void finish_timestep_elem(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol, const GridLevel& gl)
    {finish_timestep_elem(vSol, dd(gl));}
 
  // Mass and Stiffness Matrix
 
    virtual void assemble_mass_matrix(matrix_type& M, const vector_type& u,
                                      ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_mass_matrix(matrix_type& M, const vector_type& u,
                                      const GridLevel& gl)
    {assemble_mass_matrix(M, u, dd(gl));}
 
    virtual void assemble_stiffness_matrix(matrix_type& A, const vector_type& u,
                                           ConstSmartPtr<DoFDistribution> dd);
    virtual void assemble_stiffness_matrix(matrix_type& A, const vector_type& u,
                                           const GridLevel& gl)
    {assemble_stiffness_matrix(A, u, dd(gl));}
 
  // Error estimator                    ///
public:
  // stationary
    virtual void calc_error(const vector_type& u, ConstSmartPtr<DoFDistribution> dd, error_vector_type* u_vtk = NULL);
    virtual void calc_error(const vector_type& u, const GridLevel& gl, error_vector_type* u_vtk = NULL)
    {calc_error(u, dd(gl));}
 
    virtual void calc_error(const GridFunction<TDomain,TAlgebra>& u)
    {calc_error(u, u.dd(), NULL);}
    virtual void calc_error(const GridFunction<TDomain,TAlgebra>& u, error_vector_type* u_vtk)
    {calc_error(u, u.dd(), u_vtk);}
 
  // instationary
    virtual void calc_error(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                ConstSmartPtr<DoFDistribution> dd,
                const std::vector<number>& vScaleMass,
                const std::vector<number>& vScaleStiff,
                error_vector_type* u_vtk);
    virtual void calc_error(ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                const std::vector<number>& vScaleMass,
                const std::vector<number>& vScaleStiff,
                const GridLevel& gl,
                error_vector_type* u_vtk)
    {
      calc_error((ConstSmartPtr<VectorTimeSeries<vector_type> >) vSol, dd(gl),
             vScaleMass, vScaleStiff, u_vtk);
    }
 
    virtual void mark_with_strategy(IRefiner& refiner, SmartPtr <IElementMarkingStrategy<TDomain> > strategy);
 
    virtual void invalidate_error();
 
    virtual bool is_error_valid();
 
  protected:
    IMultigridElementIndicators<TDomain> m_mgElemErrors;  // holding the indicators
    bool m_bErrorCalculated;
 
  // Error estimator                     //
 
  public:
    virtual SmartPtr<AssemblingTuner<TAlgebra> > ass_tuner() {return m_spAssTuner;}
    virtual ConstSmartPtr<AssemblingTuner<TAlgebra> > ass_tuner() const {return m_spAssTuner;}
 
  public:
 
    void add(SmartPtr<IElemDisc<TDomain> > elem)
    {
    //  check that not already registered
      for(size_t i = 0; i < m_vDomainElemDisc.size(); ++i)
        if(m_vDomainElemDisc[i] == elem)
          return;
 
    //  set approximation space
      elem->set_approximation_space(m_spApproxSpace);
 
    //  add it
      m_vDomainElemDisc.push_back(elem);
    }
 
 
    void remove(SmartPtr<IElemDisc<TDomain> > elem)
    {
      // check that already registered
      for (size_t i = 0; i < m_vDomainElemDisc.size(); i++)
      {
        if (m_vDomainElemDisc[i] == elem)
        {
          // remove constraint
          m_vDomainElemDisc.erase(m_vDomainElemDisc.begin()+i);
          return;
        }
      }
 
      UG_LOG("Tried to remove ElemDisc from DomainDisc"
          ", but could not find it there.");
    }
 
 
    void add_elem_error_indicator(SmartPtr<IElemError<TDomain> > elem)
    {
      //  check that not already registered
      for(size_t i = 0; i < m_vDomainElemError.size(); ++i)
        if(m_vDomainElemError[i] == elem) return;
 
      //  set approximation space
      elem->set_approximation_space(m_spApproxSpace);
 
      //  add it
      m_vDomainElemError.push_back(elem);
    }
 
 
    void remove_elem_error_indicator(SmartPtr<IElemError<TDomain> > elem)
    {
      // check that 'elem' already registered
      for (size_t i = 0; i < m_vDomainElemError.size(); i++)
      {
        if (m_vDomainElemError[i] == elem)
        {
          // remove constraint
          m_vDomainElemError.erase(m_vDomainElemError.begin()+i);
          return;
        }
      }
 
      UG_LOG("Tried to remove ElemError from DomainDisc"
          ", but could not find it there.");
    }
 
 
 
    void add(SmartPtr<IDomainConstraint<TDomain, TAlgebra> > pp)
    {
    //  check that not already registered
      for(size_t i = 0; i < m_vConstraint.size(); ++i)
        if(m_vConstraint[i] == pp)
          return;
 
    //  set approximation space
      pp->set_approximation_space(m_spApproxSpace);
 
    //  add constraint
      m_vConstraint.push_back(pp);
    }
 
 
    void remove(SmartPtr<IDomainConstraint<TDomain, TAlgebra> > pp)
    {
      // check that already registered
      for (size_t i = 0; i < m_vConstraint.size(); i++)
      {
        if (m_vConstraint[i] == pp)
        {
          // remove constraint
          m_vConstraint.erase(m_vConstraint.begin()+i);
          return;
        }
      }
 
      UG_LOG("Tried to remove DomainConstraint from DomainDisc"
          ", but could not find it there.");
    }
 
 
    void add(SmartPtr<IDiscretizationItem<TDomain, TAlgebra> > di)
    {
    //  add elem discs
      for(size_t i = 0; i < di->num_elem_disc(); ++i)
        add(di->elem_disc(i));
 
    //  add constraints
      for(size_t i = 0; i < di->num_constraint(); ++i)
        add(di->constraint(i));
    }
 
    virtual size_t num_constraints() const {return m_vConstraint.size();}
 
    virtual SmartPtr<IConstraint<TAlgebra> > constraint(size_t i) {return m_vConstraint[i];}
 
    SmartPtr<approx_space_type> approximation_space ()        {return m_spApproxSpace;}
    ConstSmartPtr<approx_space_type> approximation_space () const {return m_spApproxSpace;}
 
  protected:
    void update_elem_discs();
    void update_elem_errors();
    void update_constraints();
    void update_disc_items();
    void update_error_items();
 
  protected:
    ConstSmartPtr<DoFDistribution> dd(const GridLevel& gl) const{return m_spApproxSpace->dof_distribution(gl);}
 
  protected:
    std::vector<SmartPtr<IElemDisc<TDomain> > > m_vDomainElemDisc;
 
    std::vector<IElemDisc<TDomain>*> m_vElemDisc;
 
    std::vector<SmartPtr<IElemError<TDomain> > > m_vDomainElemError;
 
    std::vector<IElemError<TDomain>*> m_vElemError;
 
    std::vector<SmartPtr<IDomainConstraint<TDomain, TAlgebra> > > m_vConstraint;
 
    SmartPtr<approx_space_type> m_spApproxSpace;
    
    SmartPtr<AssemblingTuner<TAlgebra> > m_spAssTuner;
  
  private:
  //---- Auxiliary function templates for the assembling ----//
  //  These functions call the corresponding functions from the global assembler for a composed list of elements:
  //-- for stationary problems --//
  template <typename TElem>
  void AssembleMassMatrix(    const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  matrix_type& M,
                  const vector_type& u);
  template <typename TElem>
  void AssembleStiffnessMatrix( const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  matrix_type& A,
                  const vector_type& u);
  template <typename TElem>
  void AssembleJacobian(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  matrix_type& J,
                  const vector_type& u);
  template <typename TElem>
  void AssembleDefect(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  vector_type& d,
                  const vector_type& u);
  template <typename TElem>
  void AssembleLinear(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  matrix_type& A,
                  vector_type& rhs);
  template <typename TElem>
  void AssembleRhs(       const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  vector_type& rhs,
                  const vector_type& u);
  template <typename TElem>
  void AssembleErrorEstimator(  const std::vector<IElemError<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  const vector_type& u);
  //-- for time-dependent problems --//
  template <typename TElem>
  void PrepareTimestepElem(   const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol);
  template <typename TElem>
  void AssembleJacobian(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  matrix_type& J,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                  number s_a0);
  template <typename TElem>
  void AssembleDefect(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  vector_type& d,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                  const std::vector<number>& vScaleMass,
                  const std::vector<number>& vScaleStiff);
  template <typename TElem>
  void AssembleLinear(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  matrix_type& A,
                  vector_type& rhs,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                  const std::vector<number>& vScaleMass,
                  const std::vector<number>& vScaleStiff);
  template <typename TElem>
  void AssembleRhs(       const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  vector_type& rhs,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
                  const std::vector<number>& vScaleMass,
                  const std::vector<number>& vScaleStiff);
  template <typename TElem>
  void FinishTimestepElem(      const std::vector<IElemDisc<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol);
  template <typename TElem>
  void AssembleErrorEstimator(  const std::vector<IElemError<domain_type>*>& vElemDisc,
                  ConstSmartPtr<DoFDistribution> dd,
                  int si, bool bNonRegularGrid,
                  const std::vector<number>& vScaleMass,
                  const std::vector<number>& vScaleStiff,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol);
};
 
 
template <typename TDomain, typename TAlgebra>
class DomainDiscretization
: public DomainDiscretizationBase<TDomain, TAlgebra, StdGlobAssembler<TDomain, TAlgebra> >
{
        typedef StdGlobAssembler<TDomain, TAlgebra> gass_type;
        
  public:
    typedef TDomain domain_type;
 
    typedef TAlgebra algebra_type;
 
    typedef typename algebra_type::matrix_type matrix_type;
 
    typedef typename algebra_type::vector_type vector_type;
 
    typedef ApproximationSpace<TDomain> approx_space_type;
    
    static const int dim = TDomain::dim;
    
  public:
    DomainDiscretization(SmartPtr<approx_space_type> pApproxSpace)
    : DomainDiscretizationBase<domain_type, algebra_type, gass_type> (pApproxSpace)
    {};
 
    virtual ~DomainDiscretization() {};
};
 
 
} // end namespace ug
 
// include documentation
#include "domain_disc_impl.h"
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__DOMAIN_DISC__ */