hanging_node_refiner_base.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__HANGING_NODE_REFINER_BASE__
#define __H__UG__HANGING_NODE_REFINER_BASE__
 
#include <queue>
#include <vector>
#include "lib_grid/lg_base.h"
#include "refiner_interface.h"
#include "ref_mark_adjuster_interface.h"
 
namespace ug
{
 
 
 
template <class TSelector>
class HangingNodeRefinerBase : public IRefiner, public GridObserver
{
  public:
    using IRefiner::mark;
 
    typedef TSelector selector_t;
 
    enum HNodeRefMarks{
      HNRM_TO_NORMAL =    1 << 5,
      HNRM_TO_CONSTRAINED = 1 << 6,
      HNRM_TO_CONSTRAINING =  1 << 7,
      HNRM_MAX
    };
 
  public:
    HangingNodeRefinerBase(SPRefinementProjector projector = SPNULL);
    virtual ~HangingNodeRefinerBase();
 
    virtual void grid_to_be_destroyed(Grid* grid);
 
 
    void enable_node_dependency_order_1(bool bEnable);
    bool node_dependency_order_1_enabled()        {return m_nodeDependencyOrder1;}
    void add_ref_mark_adjuster(SPIRefMarkAdjuster adjuster)   {m_refMarkAdjusters.push_back(adjuster);}
 
 
    virtual void clear_marks();
 
 
    virtual bool mark(Vertex* v, RefinementMark refMark = RM_REFINE);
    virtual bool mark(Edge* e, RefinementMark refMark = RM_REFINE);
    virtual bool mark(Face* f, RefinementMark refMark = RM_REFINE);
    virtual bool mark(Volume* v, RefinementMark refMark = RM_REFINE);
 
    virtual void mark_neighborhood(
            size_t numIterations,
            RefinementMark refMark,
            bool sideNbrsOnly);
 
 
    virtual RefinementMark get_mark(Vertex* v) const;
    virtual RefinementMark get_mark(Edge* e) const;
    virtual RefinementMark get_mark(Face* f) const;
    virtual RefinementMark get_mark(Volume* v) const;
    inline bool marked_refine(Edge* elem) const
    {
      return (m_selMarkedElements.get_selection_status(elem)
          & RM_REFINE) != 0;
    }
 
    template <class TElem>
    inline bool marked_refine(TElem* elem) const
    {
      return (m_selMarkedElements.get_selection_status(elem)
          & (RM_CLOSURE | RM_LOCAL | RM_FULL)) != 0;
    }
 
    template <class TElem>
    inline bool marked_adaptive(TElem* elem) const
    {
      return (m_selMarkedElements.get_selection_status(elem)
          & (RM_CLOSURE | RM_LOCAL));
    }
 
    template <class TElem>
    inline bool marked_regular(TElem* elem) const
    {
      return marked_refine(elem) && (!(marked_adaptive(elem)));
    }
 
    template <class TElem>
    inline bool marked_coarsen(TElem* elem) const
    {
      return (m_selMarkedElements.get_selection_status(elem)
          & RM_COARSEN) == RM_COARSEN;
    }
 
 
 
    virtual bool save_marks_to_file(const char* filename);
 
  protected:
    typedef typename TSelector::template traits<Vertex>::iterator sel_vrt_iter;
    typedef typename TSelector::template traits<Edge>::iterator   sel_edge_iter;
    typedef typename TSelector::template traits<Face>::iterator     sel_face_iter;
    typedef typename TSelector::template traits<Volume>::iterator   sel_vol_iter;
 
 
    void perform_refinement();
 
 
    virtual bool refinement_is_allowed(Vertex* elem)  {return true;}
    virtual bool refinement_is_allowed(Edge* elem)    {return true;}
    virtual bool refinement_is_allowed(Face* elem)      {return true;}
    virtual bool refinement_is_allowed(Volume* elem)    {return true;}
 
 
    void set_grid(typename TSelector::grid_type* grid);
 
 
    virtual void collect_objects_for_refine();
 
    virtual bool continue_collect_objects_for_refine(bool continueRequired)
    {return continueRequired;}
 
    virtual void assign_hnode_marks();
 
    virtual void pre_refine() {}
 
    virtual void post_refine()  {}
 
  //  refine methods
 
    virtual void process_constrained_vertex(ConstrainedVertex* cdv);
    virtual void process_constrained_edge(ConstrainedEdge* cde);
    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 process_constrained_face(ConstrainedFace* cdf);
    virtual void process_constraining_face(ConstrainingFace* cgf);
    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);
  //  helpers. Make sure that everything is initialized properly
  //  before calling these methods.
  //  you should use this methods instead of directly marking elements.
    inline bool is_marked(Vertex* v)        {return m_selMarkedElements.is_selected(v);}
    //inline void mark(Vertex* v)           {mark(v);}
 
    inline bool is_marked(Edge* e)          {return m_selMarkedElements.is_selected(e);}
    //inline void mark(Edge* e)           {mark(e);}
 
 
    virtual Vertex* get_center_vertex(Edge* e) = 0;
 
    virtual void set_center_vertex(Edge* e, Vertex* v) = 0;
 
    inline bool is_marked(Face* f)            {return m_selMarkedElements.is_selected(f);}
    //inline void mark(Face* f)             {mark(f);}
 
 
    virtual Vertex* get_center_vertex(Face* f) = 0;
 
    virtual void set_center_vertex(Face* f, Vertex* v) = 0;
 
    inline bool is_marked(Volume* v)          {return m_selMarkedElements.is_selected(v);}
    //inline void mark(Volume* v)           {mark(v);}
 
 
    template <class TElem>
    inline bool marked_to_normal(TElem* elem) const     {return (m_selMarkedElements.get_selection_status(elem) & HNRM_TO_NORMAL) == HNRM_TO_NORMAL;}
 
    template <class TElem>
    inline bool marked_to_constrained(TElem* elem) const  {return (m_selMarkedElements.get_selection_status(elem) & HNRM_TO_CONSTRAINED) == HNRM_TO_CONSTRAINED;}
 
    template <class TElem>
    inline bool marked_to_constraining(TElem* elem) const {return (m_selMarkedElements.get_selection_status(elem) & HNRM_TO_CONSTRAINING) == HNRM_TO_CONSTRAINING;}
 
    template <class TElem>
    void add_hmark(TElem* elem, HNodeRefMarks mark);
 
    template <class TElem>
    void remove_hmark(TElem* elem, uint mark);
 
 
    template <class TElem>
    bool remove_coarsen_marks();
 
 
    TSelector& get_refmark_selector() {return m_selMarkedElements;}
 
    inline bool adjusting_ref_marks() const {return m_adjustingRefMarks;}
 
  private:
    HangingNodeRefinerBase(const HangingNodeRefinerBase&);
 
  protected:
    TSelector             m_selMarkedElements;
    std::vector<SPIRefMarkAdjuster>   m_refMarkAdjusters;
 
  private:
    Grid*   m_pGrid;
    std::vector<Vertex*>  m_newlyMarkedRefVrts;
    std::vector<Edge*>    m_newlyMarkedRefEdges;
    std::vector<Face*>      m_newlyMarkedRefFaces;
    std::vector<Volume*>    m_newlyMarkedRefVols;
    //todo: Use the following vectors during coarsening...
    /*
    std::vector<Vertex*>  m_newlyMarkedCoarseVrts;
    std::vector<Edge*>    m_newlyMarkedCoarseEdges;
    std::vector<Face*>      m_newlyMarkedCoarseFaces;
    std::vector<Volume*>    m_newlyMarkedCoarseVols;
    */
    bool    m_nodeDependencyOrder1;
    //bool    m_automarkHigherDimensionalObjects; <-- unused
    bool    m_adjustingRefMarks;
};
 
 
}// end of namespace
 
#endif