LCOV - code coverage report
Current view: top level - ugbase/lib_grid/refinement - global_multi_grid_refiner.h (source / functions) Coverage Total Hit
Test: coverage.info Lines: 0.0 % 11 0
Test Date: 2025-09-21 23:31:46 Functions: 0.0 % 11 0

            Line data    Source code
       1              : /*
       2              :  * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Sebastian Reiter
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__LIB_GRID__GLOBAL_MULTI_GRID_REFINER__
      34              : #define __H__LIB_GRID__GLOBAL_MULTI_GRID_REFINER__
      35              : 
      36              : #include <vector>
      37              : #include "lib_grid/lg_base.h"
      38              : #include "lib_grid/multi_grid.h"
      39              : #include "refiner_interface.h"
      40              : 
      41              : namespace ug
      42              : {
      43              : 
      44              : ///     \addtogroup lib_grid_algorithms_refinement
      45              : ///     @{
      46              : 
      47              : class GlobalMultiGridRefiner : public IRefiner, public GridObserver
      48              : {
      49              :         public:
      50              :                 GlobalMultiGridRefiner(SPRefinementProjector projector = SPNULL);
      51              :                 GlobalMultiGridRefiner(MultiGrid& mg,
      52              :                                                            SPRefinementProjector projector = SPNULL);
      53              :                                                            
      54              :                 virtual ~GlobalMultiGridRefiner();
      55              : 
      56              :                 virtual void grid_to_be_destroyed(Grid* grid);
      57              :                 
      58              :                 void assign_grid(MultiGrid& mg);
      59              :                 void assign_grid(MultiGrid* mg);
      60              : 
      61            0 :                 virtual Grid* get_associated_grid()             {return m_pMG;}
      62            0 :                 virtual Grid* grid()                                    {return m_pMG;}
      63            0 :                 virtual MultiGrid* multi_grid()                 {return m_pMG;}
      64              : 
      65            0 :                 virtual bool adaptivity_supported() const       {return false;}
      66            0 :                 virtual bool coarsening_supported() const       {return false;}
      67              : 
      68              :                 virtual bool save_marks_to_file(const char* filename);
      69              : 
      70              :         protected:
      71              :         ///     returns the number of (globally) marked edges on this level of the hierarchy
      72              :                 virtual void num_marked_edges_local(std::vector<int>& numMarkedEdgesOut);
      73              :         ///     returns the number of (globally) marked faces on this level of the hierarchy
      74              :                 virtual void num_marked_faces_local(std::vector<int>& numMarkedFacesOut);
      75              :         ///     returns the number of (globally) marked volumes on this level of the hierarchy
      76              :                 virtual void num_marked_volumes_local(std::vector<int>& numMarkedVolsOut);
      77              : 
      78              :                 template <class TElem>
      79              :                 void num_marked_elems(std::vector<int>& numMarkedElemsOut);
      80              : 
      81              :         ////////////////////////////////
      82              :         ///     performs refinement on the marked elements.
      83              :                 virtual void perform_refinement();
      84              : 
      85              :         ///     a callback that allows to deny refinement of special vertices
      86            0 :                 virtual bool refinement_is_allowed(Vertex* elem)        {return true;}
      87              :         ///     a callback that allows to deny refinement of special edges
      88            0 :                 virtual bool refinement_is_allowed(Edge* elem)          {return true;}
      89              :         ///     a callback that allows to deny refinement of special faces
      90            0 :                 virtual bool refinement_is_allowed(Face* elem)                  {return true;}
      91              :         ///     a callback that allows to deny refinement of special volumes
      92            0 :                 virtual bool refinement_is_allowed(Volume* elem)                {return true;}
      93              :                 
      94              :         ///     this method helps derived classes to perform operations directly before actual element refinement is performed.
      95              :         /**     Called from the refine() method in each refinement-iteration after
      96              :          *      collect_objects_for_refine().
      97              :          *      Default implementation is empty.*/
      98            0 :                 virtual void refinement_step_begins()   {};
      99              : 
     100              :         ///     this method helps derived classes to perform operations directly after actual element refinement took place.
     101              :         /**     Called from the refine() method in each refinement-iteration after
     102              :          *      all scheduled elements had been refined.
     103              :          *      The refine process will either terminate after this method or will
     104              :          *      start a new iteration, if new elements had been marked during refine.
     105              :          *      Default implementation is empty.*/
     106            0 :                 virtual void refinement_step_ends()             {};
     107              :                 
     108              :         protected:
     109              :                 MultiGrid*      m_pMG;
     110              : };
     111              : 
     112              : /// @}
     113              : }//     end of namespace
     114              : 
     115              : #endif
        

Generated by: LCOV version 2.0-1