deg_layer_mngr.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015:  G-CSC, Goethe University Frankfurt
 * Author: Dmitry Logashenko
 * 
 * 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.
 */
 
/*
 * A manager for the degenerated layer subsets. It helps to distinguish between the sides
 * of the degenerated elements and to find out the correspondence of the nodes
 * in them.
 */
#ifndef __H__UG__PLUGINS__D3F__DEGENERATED_LAYER_MANAGER__
#define __H__UG__PLUGINS__D3F__DEGENERATED_LAYER_MANAGER__
 
#include <map>
#include <vector>
 
// ug4 headers
#include "common/common.h"
#include "common/util/smart_pointer.h"
#include "lib_grid/grid/grid.h"
#include "lib_grid/tools/subset_group.h"
#include "lib_grid/tools/subset_handler_multi_grid.h"
#include "lib_grid/algorithms/subset_dim_util.h"
#include "lib_grid/grid_objects/grid_dim_traits.h"
#include "lib_grid/refinement/global_fractured_media_refiner.h"
#ifdef UG_PARALLEL
#include "lib_grid/parallelization/distributed_grid.h"
#include "lib_grid/parallelization/util/attachment_operations.hpp"
#endif
 
namespace ug {
 
 
template <int dim>
class DegeneratedLayerManager
{
public:
    typedef Attachment<signed char> mark_attachment_type;
    
    typedef typename grid_dim_traits<dim>::grid_base_object element_type;
    
    typedef typename grid_dim_traits<dim>::side_type side_type;
    
    static const size_t maxElemCorners = grid_dim_traits<dim>::MaxNumVerticesOfElem;
    
    static const size_t maxLayerSideCorners = maxElemCorners / 2;
  
    enum t_grid_object_mark
    {
      D_LAYER_UNKNOWN = -1,
      D_LAYER_OUTER = 0,
      D_LAYER_INNER = 1
    };
 
public:
    DegeneratedLayerManager
    (
      SmartPtr<MultiGridSubsetHandler> spSH 
    );
    
    virtual ~DegeneratedLayerManager ();
    
    void add
    (
      const char * ss_names 
    );
    
    void remove
    (
      const char * ss_names 
    );
 
    void close ();
    
    void init_refiner
    (
      SmartPtr<GlobalFracturedMediaRefiner> refiner, 
      bool as_low_dim 
    );
    
    bool is_closed () {return m_bClosed;};
    
    bool contains
    (
      int si 
    )
    {return m_layerSsGrp.contains (si);};
    
    const SubsetGroup & subset_grp () {return m_layerSsGrp;};
    
    size_t num_subsets () {return m_layerSsGrp.size ();};
    
    int subset (size_t i)
    {
      if (! is_closed ()) UG_THROW ("DegeneratedLayerManager: The manager is not closed.");
      return m_layerSsGrp[i];
    }
    
    int vert_mark (Vertex * vrt) {return m_aaVertMarks [vrt];};
    
    void get_layer_sides
    (
      element_type * elem, 
      size_t & num_fract_co, 
      side_type * & inner_side, 
      size_t & inner_side_idx, 
      size_t inner_side_corners [], 
      side_type * & outer_side, 
      size_t & outer_side_idx, 
      size_t outer_side_corners [], 
      size_t ass_co [] = NULL 
    );
    
    int assign_middle_subset
    (
      int layer_si, 
      int middle_si = -1 
    );
    
    int assign_middle_subset
    (
      int layer_si, 
      const char* middle_ss_name 
    );
    
    int assign_middle_subset
    (
      const char* layer_ss_name, 
      const char* middle_ss_name 
    );
    
protected:
    void mark_vertices ();
  
    void grid_adaption_callback (const GridMessage_Adaption& msg);
 
    void grid_distribution_callback (const GridMessage_Distribution& msg);
  
private:
    SmartPtr<MultiGridSubsetHandler> m_spSH;
  
    SubsetGroup m_layerSsGrp;
  
    mark_attachment_type m_aVertexMarks;
    MultiGrid::AttachmentAccessor<Vertex, mark_attachment_type> m_aaVertMarks;
    
    bool m_bClosed;
    
  //  Message hub callback id's for the notifications of the changes of the grid:
    MessageHub::SPCallbackId m_spGridAdaptionCallbackID;
    MessageHub::SPCallbackId m_spGridDistributionCallbackID;
};
 
} // end namespace ug
 
#include "deg_layer_mngr_impl.h"
 
#endif // __H__UG__PLUGINS__D3F__DEGENERATED_LAYER_MANAGER__
 
/* End of File */