Loading [MathJax]/extensions/tex2jax.js
ug4
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
global_multi_grid_refiner.h
Go to the documentation of this file.
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
41namespace ug
42{
43
46
48{
49 public:
53
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 virtual Grid* get_associated_grid() {return m_pMG;}
62 virtual Grid* grid() {return m_pMG;}
63 virtual MultiGrid* multi_grid() {return m_pMG;}
64
65 virtual bool adaptivity_supported() const {return false;}
66 virtual bool coarsening_supported() const {return false;}
67
68 virtual bool save_marks_to_file(const char* filename);
69
70 protected:
72 virtual void num_marked_edges_local(std::vector<int>& numMarkedEdgesOut);
74 virtual void num_marked_faces_local(std::vector<int>& numMarkedFacesOut);
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
83 virtual void perform_refinement();
84
86 virtual bool refinement_is_allowed(Vertex* elem) {return true;}
88 virtual bool refinement_is_allowed(Edge* elem) {return true;}
90 virtual bool refinement_is_allowed(Face* elem) {return true;}
92 virtual bool refinement_is_allowed(Volume* elem) {return true;}
93
95
98 virtual void refinement_step_begins() {};
99
101
106 virtual void refinement_step_ends() {};
107
108 protected:
110};
111
113}// end of namespace
114
115#endif
Base-class for edges.
Definition grid_base_objects.h:397
Faces are 2-dimensional objects.
Definition grid_base_objects.h:510
Definition global_multi_grid_refiner.h:48
virtual MultiGrid * multi_grid()
Definition global_multi_grid_refiner.h:63
virtual bool save_marks_to_file(const char *filename)
Writes the associated grid and marks to a file. Pure virtual.
Definition global_multi_grid_refiner.cpp:464
virtual bool refinement_is_allowed(Edge *elem)
a callback that allows to deny refinement of special edges
Definition global_multi_grid_refiner.h:88
void num_marked_elems(std::vector< int > &numMarkedElemsOut)
Definition global_multi_grid_refiner.cpp:124
virtual Grid * get_associated_grid()
DEPRECIATED! Use grid(). Has to return the associated grid. Pure virtual.
Definition global_multi_grid_refiner.h:61
void assign_grid(MultiGrid &mg)
Definition global_multi_grid_refiner.cpp:83
virtual bool refinement_is_allowed(Vertex *elem)
a callback that allows to deny refinement of special vertices
Definition global_multi_grid_refiner.h:86
virtual ~GlobalMultiGridRefiner()
Definition global_multi_grid_refiner.cpp:72
virtual bool coarsening_supported() const
returns true, if the refiner supports coarsening.
Definition global_multi_grid_refiner.h:66
MultiGrid * m_pMG
Definition global_multi_grid_refiner.h:109
virtual void perform_refinement()
performs refinement on the marked elements.
Definition global_multi_grid_refiner.cpp:135
virtual void num_marked_faces_local(std::vector< int > &numMarkedFacesOut)
returns the number of (globally) marked faces on this level of the hierarchy
Definition global_multi_grid_refiner.cpp:110
virtual bool refinement_is_allowed(Face *elem)
a callback that allows to deny refinement of special faces
Definition global_multi_grid_refiner.h:90
virtual void num_marked_edges_local(std::vector< int > &numMarkedEdgesOut)
returns the number of (globally) marked edges on this level of the hierarchy
Definition global_multi_grid_refiner.cpp:104
virtual void grid_to_be_destroyed(Grid *grid)
Definition global_multi_grid_refiner.cpp:78
virtual void num_marked_volumes_local(std::vector< int > &numMarkedVolsOut)
returns the number of (globally) marked volumes on this level of the hierarchy
Definition global_multi_grid_refiner.cpp:116
virtual Grid * grid()
Returns the grid associated with the refiner.
Definition global_multi_grid_refiner.h:62
virtual bool refinement_is_allowed(Volume *elem)
a callback that allows to deny refinement of special volumes
Definition global_multi_grid_refiner.h:92
virtual bool adaptivity_supported() const
returns whether the refiner is able to perform adaptive refinement
Definition global_multi_grid_refiner.h:65
virtual void refinement_step_ends()
this method helps derived classes to perform operations directly after actual element refinement took...
Definition global_multi_grid_refiner.h:106
virtual void refinement_step_begins()
this method helps derived classes to perform operations directly before actual element refinement is ...
Definition global_multi_grid_refiner.h:98
Manages the elements of a grid and their interconnection.
Definition grid.h:132
Definition grid_observer.h:80
The refiner interface allows to mark elements for refinement and to call refine.
Definition refiner_interface.h:67
SPRefinementProjector projector()
Definition refiner_interface.h:78
Definition multi_grid.h:72
Base-class for all vertex-types.
Definition grid_base_objects.h:231
Volumes are 3-dimensional objects.
Definition grid_base_objects.h:754
const NullSmartPtr SPNULL
The equivalent to NULL for smart pointers.
Definition smart_pointer.h:90
the ug namespace