domain.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__DOMAIN__
#define __H__UG__LIB_DISC__DOMAIN__
 
#include "lib_grid/algorithms/subset_util.h"
#include "lib_grid/refinement/projectors/refinement_projector.h"
 
#include <map>
 
#ifdef UG_PARALLEL
#include "lib_grid/parallelization/distributed_grid.h"
#endif
 
namespace ug{
 
 
class DomainInfo
{
  public:
    typedef unsigned long long int_t;
 
    inline int element_type() const                 {return m_elementType;}
    inline size_t num_levels() const                {return m_numElems.size();}
    inline size_t num_elements_on_level(size_t lvl) const     {return (size_t)m_numElems[lvl];}
    inline size_t num_surface_elements() const            {return (size_t)m_numSurfElems;}
    inline size_t num_local_elements_on_level(size_t lvl) const   {return (size_t)m_numLocalElems[lvl];}
    inline size_t min_num_local_elements_on_level(size_t lvl) const {return (size_t)m_minNumLocalElems[lvl];}
    inline size_t max_num_local_elements_on_level(size_t lvl) const {return (size_t)m_maxNumLocalElems[lvl];}
    inline size_t num_local_ghosts_on_level(size_t lvl) const   {return (size_t)m_numLocalGhosts[lvl];}
 
    inline size_t num_subsets() const
      {return m_subsetDims.size();}
    inline size_t subset_dim(int si) const
      {return m_subsetDims[si];}
 
    inline size_t num_elements() const
      {
        int_t total = 0;
        for(size_t i = 0; i < m_numElems.size(); ++i){
          total += m_numElems[i];
        }
        return (size_t)total;
      }
 
    inline void set_info(GridBaseObjectId elemType,
                const std::vector<int_t>& numElems,
                const std::vector<int_t>& numLocalElems,
                const std::vector<int_t>& minNumLocalElems,
                const std::vector<int_t>& maxNumLocalElems,
                const std::vector<int_t>& numLocalGhosts,
                const std::vector<int_t>& subsetDims,
                int_t numSurfElems)
      {m_elementType = elemType;
       m_numElems = numElems;
       m_numLocalElems = numLocalElems;
       m_minNumLocalElems = minNumLocalElems;
       m_maxNumLocalElems = maxNumLocalElems;
       m_numLocalGhosts = numLocalGhosts;
       m_subsetDims = subsetDims;
       m_numSurfElems = numSurfElems;
      }
 
    std::string to_string() const;
 
  private:
    GridBaseObjectId  m_elementType;
    std::vector<int_t>  m_numElems;
    std::vector<int_t>  m_numLocalElems;
    std::vector<int_t>  m_minNumLocalElems;
    std::vector<int_t>  m_maxNumLocalElems;
    std::vector<int_t>  m_numLocalGhosts;
    std::vector<int_t>  m_subsetDims;
    int_t       m_numSurfElems;
};
 
 
 
template <typename TGrid = MultiGrid, typename TSubsetHandler = MGSubsetHandler>
class IDomain
{
  public:
    typedef TGrid grid_type;
 
    typedef TSubsetHandler subset_handler_type;
 
  public:
 
    IDomain(bool isAdaptive = true);
 
    virtual ~IDomain();
 
    virtual int get_dim() const = 0;
    
    inline SmartPtr<TGrid> grid() {return m_spGrid;};
 
    inline const ConstSmartPtr<TGrid> grid() const {return m_spGrid;};
 
    inline SmartPtr<TSubsetHandler> subset_handler() {return m_spSH;};
 
    inline const ConstSmartPtr<TSubsetHandler> subset_handler() const {return m_spSH;};
 
    SPMessageHub message_hub() {return m_spGrid->message_hub();}
 
    bool is_adaptive() const    {return m_isAdaptive;}
 
 
    bool empty() const      {return m_spGrid->num_vertices() == 0;}
 
    void update_subset_infos(int rootProc);
 
 
    const DomainInfo& domain_info() const   {return m_domainInfo;}
 
 
    void update_domain_info();
 
 
    bool is_parallel()                      {return m_spGrid->is_parallel();}
 
    inline DistributedGridManager* distributed_grid_manager() {return m_spGrid->distributed_grid_manager();}
 
 
    bool create_additional_subset_handler(std::string name);
 
    std::vector<std::string> additional_subset_handler_names() const;
 
    SmartPtr<TSubsetHandler> additional_subset_handler(std::string name);
 
    const ConstSmartPtr<TSubsetHandler> additional_subset_handler(std::string name) const;
 
    void set_refinement_projector(SPRefinementProjector proj);
 
    SPRefinementProjector refinement_projector() const;
 
    virtual SPIGeometry3d geometry3d() const = 0;
 
  protected:
    #ifdef UG_PARALLEL
      SPRefinementProjector
      broadcast_refinement_projector (
          int rootProc,
          pcl::ProcessCommunicator& procCom,
          SPIGeometry3d geometry,
          SPRefinementProjector projector = SPNULL);
 
      void serialize_projector (
          BinaryBuffer& bufOut,
          SPRefinementProjector proj);
 
      SPRefinementProjector deserialize_projector (BinaryBuffer& buf);
    #endif
      
    SmartPtr<TGrid> m_spGrid;     
    SmartPtr<TSubsetHandler> m_spSH;  
    std::map<std::string, SmartPtr<TSubsetHandler> >  m_additionalSH; 
 
    SPRefinementProjector   m_refinementProjector;
 
    MessageHub::SPCallbackId  m_spGridAdaptionCallbackID;
    MessageHub::SPCallbackId  m_spGridCreationCallbackID;
    MessageHub::SPCallbackId  m_spGridDistributionCallbackID;
 
    DomainInfo  m_domainInfo;
 
    bool  m_isAdaptive;
    bool  m_adaptionIsActive;
 
    inline void grid_adaption_callback(const GridMessage_Adaption& msg);
 
    inline void grid_creation_callback(const GridMessage_Creation& msg);
 
    inline void grid_distribution_callback(const GridMessage_Distribution& msg);
 
#ifdef UG_PARALLEL
  protected:
    template <class TElem>
    void count_ghosts(std::vector<DomainInfo::int_t>& numGhostsOnLvlOut);
#endif
 
    template <class TElem>
    size_t count_local_unique_surface_elements();
};
 
 
template <int d, typename TGrid = MultiGrid, typename TSubsetHandler = MGSubsetHandler>
class Domain : public IDomain<TGrid, TSubsetHandler>
{
  private:
    typedef IDomain<TGrid, TSubsetHandler> base_type;
 
  public:
    static const int dim = d;
 
    typedef MathVector<dim> position_type;
 
    typedef Attachment<position_type> position_attachment_type;
 
    typedef Grid::VertexAttachmentAccessor<position_attachment_type>
          position_accessor_type;
 
  public:
    typedef typename base_type::grid_type grid_type;
 
    typedef typename base_type::subset_handler_type subset_handler_type;
 
  public:
 
    Domain(bool isAdaptive = true);
    virtual ~Domain() {};
 
    virtual int get_dim() const {return dim;}
 
    inline position_attachment_type& position_attachment(){return m_aPos;}
 
    inline const position_attachment_type& position_attachment() const {return m_aPos;}
 
    inline position_accessor_type& position_accessor() {return m_aaPos;}
 
    inline const position_accessor_type& position_accessor() const{return m_aaPos;}
 
    virtual SPIGeometry3d geometry3d() const  {return m_geometry3d;}
 
  protected:
    position_attachment_type m_aPos;  
    position_accessor_type  m_aaPos;    
    SPIGeometry3d     m_geometry3d;
};
 
typedef Domain<1, MultiGrid, MGSubsetHandler> Domain1d;
typedef Domain<2, MultiGrid, MGSubsetHandler> Domain2d;
typedef Domain<3, MultiGrid, MGSubsetHandler> Domain3d;
 
} // end namespace ug
 
// end group lib_disc_domain
 
// include implementation
#include "domain_impl.h"
 
#endif /* __H__UG__LIB_DISC__DOMAIN__ */