approximation_space.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__FUNCTION_SPACE__APPROXIMATION_SPACE__
#define __H__UG__LIB_DISC__FUNCTION_SPACE__APPROXIMATION_SPACE__
 
#include "lib_disc/common/revision_counter.h"
#include "lib_disc/dof_manager/dof_distribution_info.h"
#include "lib_disc/dof_manager/dof_distribution.h"
#include "lib_grid/tools/surface_view.h"
#include "lib_algebra/algebra_type.h"
 
namespace ug{
 
 
class IApproximationSpace : public DoFDistributionInfoProvider
{
  public:
    typedef MGSubsetHandler subset_handler_type;
 
    typedef MultiGrid grid_type;
 
  public:
    IApproximationSpace(SmartPtr<subset_handler_type> spMGSH,
                        SmartPtr<grid_type> spMG);
 
    IApproximationSpace(SmartPtr<subset_handler_type> spMGSH,
                        SmartPtr<grid_type>,
                        const AlgebraType& algebraType);
 
  protected:
    void init(SmartPtr<subset_handler_type> spMGSH,
              SmartPtr<grid_type> spMG, const AlgebraType& algebraType);
 
  public:
    ~IApproximationSpace();
 
    void clear() {m_spDoFDistributionInfo->clear();}
 
  public:
 
    void add(const std::vector<std::string>& vName, LFEID id){
      m_spDoFDistributionInfo->add(vName, id);
    }
 
    void add(const std::vector<std::string>& vName, const char* type, int order);
 
    void add(const std::vector<std::string>& vName, const char* type);
 
    void add(const char* name, const char* type, int order);
 
    void add(const char* name, const char* type);
 
  public:
 
    void add(const std::vector<std::string>& vName, LFEID id,
         const std::vector<std::string>& vSubset){
      m_spDoFDistributionInfo->add(vName, id, vSubset);
    }
 
    void add(const std::vector<std::string>& vName, const char* type, int order,
         const std::vector<std::string>& vSubsets);
 
 
    void add(const char* name, const char* type, int order, const char* subsets);
 
    void add(const std::vector<std::string>& vName, const char* type,
         const std::vector<std::string>& vSubsets);
 
 
    void add(const char* name, const char* type, const char* subsets);
 
  public:
    ConstSmartPtr<MGSubsetHandler> subset_handler() const {return m_spMGSH;}
 
    size_t num_levels() const {return m_spMGSH->num_levels();}
 
    ConstSmartPtr<SurfaceView> surface_view() const {return m_spSurfaceView;}
 
    bool grouped() const {return m_bGrouped;}
 
    bool might_contain_ghosts(int lvl) const;
 
    bool might_contain_ghosts() const;
 
    SmartPtr<DoFDistribution> dof_distribution(const GridLevel& gl, bool bCreate = true);
    SmartPtr<DoFDistribution> dd(const GridLevel& gl, bool bCreate = true);
 
    ConstSmartPtr<DoFDistribution> dof_distribution(const GridLevel& gl, bool bCreate = true) const;
    ConstSmartPtr<DoFDistribution> dd(const GridLevel& gl, bool bCreate = true) const;
 
    std::vector<SmartPtr<DoFDistribution> > dof_distributions() const;
 
    ConstSmartPtr<DoFDistributionInfo> ddinfo() const {return m_spDoFDistributionInfo;}
    ConstSmartPtr<DoFDistributionInfo> dof_distribution_info() const {return ddinfo();}
 
    void print_statistic(std::string flags) const;
 
    void print_statistic() const;
 
    void print_layout_statistic() const;
 
 
    void init_levels();
 
    void init_surfaces();
 
    void init_top_surface();
 
    const RevisionCounter& revision() const {return m_RevCnt;}
 
  protected:
    void create_dof_distribution(const GridLevel& gl);
 
    void surface_view_required();
 
    void dof_distribution_info_required();
 
  protected:
    void reinit();
 
    MessageHub::SPCallbackId m_spGridAdaptionCallbackID;
    MessageHub::SPCallbackId m_spGridDistributionCallbackID;
    bool m_bAdaptionIsActive;
 
    void register_at_adaption_msg_hub();
 
    void grid_changed_callback(const GridMessage_Adaption& msg);
 
    void grid_distribution_callback(const GridMessage_Distribution& msg);
 
  protected:
    SmartPtr<MultiGrid> m_spMG;
 
    SmartPtr<MGSubsetHandler> m_spMGSH;
 
    SmartPtr<SurfaceView> m_spSurfaceView;
 
    AlgebraType m_algebraType;
 
    bool m_bGrouped;
 
    SmartPtr<DoFDistributionInfo> m_spDoFDistributionInfo;
 
    RevisionCounter m_RevCnt;
 
  protected:
    std::vector<SmartPtr<DoFDistribution> > m_vDD;
 
    SmartPtr<DoFIndexStorage> m_spDoFIndexStrgForLevelNoGhost;
    SmartPtr<DoFIndexStorage> m_spDoFIndexStrgForLevelWithGhost;
};
 
template <typename TDomain>
class ApproximationSpace : public IApproximationSpace
{
  public:
    typedef TDomain domain_type;
 
    static const int dim = domain_type::dim;
 
    typedef typename domain_type::subset_handler_type subset_handler_type;
 
  public:
    ApproximationSpace(SmartPtr<TDomain> domain);
 
    ApproximationSpace(SmartPtr<TDomain> domain, const AlgebraType& algebraType);
 
    ConstSmartPtr<TDomain> domain() const {return m_spDomain;}
 
    SmartPtr<TDomain> domain() {return m_spDomain;}
 
    int get_dim() const { return dim; }
 
  protected:
    SmartPtr<TDomain> m_spDomain;
};
 
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__FUNCTION_SPACE__APPROXIMATION_SPACE__ */