hanging_node_refiner_multi_grid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * 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__HANGIN_NODE_REFINER_MULTI_GRID__
#define __H__UG__HANGIN_NODE_REFINER_MULTI_GRID__
 
#include "hanging_node_refiner_base.h"
#include "lib_grid/tools/selector_multi_grid.h"
 
namespace ug
{
 
 
 
class HangingNodeRefiner_MultiGrid : public HangingNodeRefinerBase<MGSelector>
{
  public:
    typedef HangingNodeRefinerBase<MGSelector>  BaseClass;
    using BaseClass::mark;
 
    enum HNodeCoarsenMarks{
      HNCM_FIRST = HNRM_MAX + 1,
      HNCM_NO_NBRS,
      HNCM_NONE,
      HNCM_PARTIAL,
      HNCM_REPLACE,
      HNCM_ALL,
      HNCM_INVALID,
      HNCM_UNKNOWN
    };
 
  public:
    HangingNodeRefiner_MultiGrid(SPRefinementProjector projector = SPNULL);
    HangingNodeRefiner_MultiGrid(MultiGrid& mg,
                  SPRefinementProjector projector = SPNULL);
 
    virtual ~HangingNodeRefiner_MultiGrid();
 
    virtual void grid_to_be_destroyed(Grid* grid);
 
    virtual void assign_grid(MultiGrid& mg);
    virtual Grid* get_associated_grid()   {return m_pMG;}//depreciated
    virtual Grid* grid()          {return m_pMG;}
    virtual MultiGrid* multi_grid()     {return m_pMG;}
 
    virtual bool adaptivity_supported() const {return true;}
    virtual bool coarsening_supported() const {return true;}
 
  protected:
    virtual void num_marked_edges_local(std::vector<int>& numMarkedEdgesOut);
    virtual void num_marked_faces_local(std::vector<int>& numMarkedFacesOut);
    virtual void num_marked_volumes_local(std::vector<int>& numMarkedVolsOut);
    
    template <class TElem>
    void num_marked_elems(std::vector<int>& numMarkedElemsOut);
    
 
    virtual bool perform_coarsening();
 
    void save_coarsen_marks_to_file(ISelector& sel, const char* filename);
    void debug_save(ISelector& sel, const char* filename);
 
    virtual bool refinement_is_allowed(Vertex* elem);
    virtual bool refinement_is_allowed(Edge* elem);
    virtual bool refinement_is_allowed(Face* elem);
    virtual bool refinement_is_allowed(Volume* elem);
 
 
    void set_grid(MultiGrid* mg);
 
    virtual void assign_hnode_marks();
 
    virtual void pre_refine();
 
 
    virtual void pre_coarsen()  {};
 
 
    virtual void post_coarsen() {};
 
 
    virtual void process_constraining_edge(ConstrainingEdge* cge);
 
    virtual void refine_edge_with_normal_vertex(Edge* e,
                      Vertex** newCornerVrts = NULL);
    virtual void refine_edge_with_hanging_vertex(Edge* e,
                      Vertex** newCornerVrts = NULL);
 
    virtual void refine_face_with_normal_vertex(Face* f,
                      Vertex** newCornerVrts = NULL);
    virtual void refine_face_with_hanging_vertex(Face* f,
                      Vertex** newCornerVrts = NULL);
 
    virtual void refine_volume_with_normal_vertex(Volume* v,
                      Vertex** newVolumeVrts = NULL);
  /*  \} */
 
    virtual Vertex* get_center_vertex(Edge* e);
 
    virtual void set_center_vertex(Edge* e, Vertex* v);
 
    virtual Vertex* get_center_vertex(Face* f);
 
    virtual void set_center_vertex(Face* f, Vertex* v);
 
 
 
    template <class TElem>
    void collect_child_corners(std::vector<Vertex*>& cornersOut, TElem* elem)
    {
      cornersOut.resize(elem->num_vertices());
      for(size_t i = 0; i < elem->num_vertices(); ++i){
        //UG_ASSERT(m_pMG->get_child_vertex(elem->vertex(i)), "A child vertex has to exists!");
        cornersOut[i] = m_pMG->get_child_vertex(elem->vertex(i));
      }
    }
 
 
    virtual void restrict_selection_to_surface_coarsen_elements();
 
 
    virtual void restrict_selection_to_coarsen_families();
 
    template <class TElem>
    void restrict_selection_to_surface_coarsen_elements();
 
 
    template <class TElem>
    void restrict_selection_to_coarsen_families();
 
 
//    template <class TElem>
//    void classify_selection();
 
 
    //template <class TElem>
    //void adjust_coarsen_marks_on_side_elements();
 
 
//    template <class TElem>
//    bool deselect_invalid_coarsen_families();
//
//    template <class TElem>
//    void deselect_isolated_sides();
//
//    template <class TElem>
//    void deselect_uncoarsenable_parents();
 
 
    virtual void collect_objects_for_coarsen(bool scheduleCoarseningBeginsMessage = false);
 
 
  //  Callbacks for PARALLELIZATION
 
 
//    virtual bool continue_collect_objects_for_coarsen(bool continueRequired)
//    {return continueRequired;}
 
 
//    virtual void broadcast_vertex_coarsen_marks() {}
//    virtual void broadcast_edge_coarsen_marks()   {}
//    virtual void broadcast_face_coarsen_marks()   {}
 
    virtual bool contains_edges()     {return m_pMG->num<Edge>() > 0;}
 
 
    virtual bool contains_faces()     {return m_pMG->num<Face>() > 0;}
 
 
    virtual bool contains_volumes()     {return m_pMG->num<Volume>() > 0;}
 
    //virtual void assign_hnode_coarsen_marks();
 
    virtual void broadcast_marks_horizontally(bool vertices, bool edges, bool faces,
                          bool allowDeselection = false)  {}
    virtual void broadcast_marks_vertically(bool vertices, bool edges,
                        bool faces, bool volumes,
                        bool allowDeselection = false)  {}
 
    virtual void copy_marks_to_vmasters(bool vertices, bool edges,
                      bool faces, bool volumes)     {}
 
    virtual void copy_marks_to_vslaves(bool vertices, bool edges,
                      bool faces, bool volumes)     {}
 
    virtual bool one_proc_true(bool localProcTrue)    {return localProcTrue;}
 
  private:
    MultiGrid*  m_pMG;
};
 
 
}// end of namespace
 
#endif