ug4
fv_geom_base.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2015: G-CSC, Goethe University Frankfurt
3  * Author: Andreas Vogel
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__UG__LIB_DISC__SPATIAL_DISC__DISC_HELPER__FINITE_VOLUME_BASE__
34 #define __H__UG__LIB_DISC__SPATIAL_DISC__DISC_HELPER__FINITE_VOLUME_BASE__
35 
36 
37 namespace ug{
38 
40 struct MidID
41 {
42  MidID() : dim(0), id(0) {};
43  MidID(size_t dim_, size_t id_) : dim(dim_), id(id_) {};
44  size_t dim;
45  size_t id;
46 };
47 
50  public:
52  static UniqueFVGeomIDProvider instance;
53  return instance;
54  }
55 
56  size_t new_id() {return ++m_id;}
57 
58  private:
60  size_t m_id;
61 };
62 
64 template <class TType>
66 {
67  static size_t typeID = UniqueFVGeomIDProvider::inst().new_id();
68  //** Unkomment the next line to see the correspondence of the id's and the types
69  //UG_LOG ("--> Assigning id " << typeID << " to type " << typeid(TType).name () << " <--\n");
70  //**
71  return typeID;
72 }
73 
74 
76 class FVGeometryBase {};
77 
78 } // end namespace ug
79 
80 #endif /* __H__UG__LIB_DISC__SPATIAL_DISC__DISC_HELPER__FINITE_VOLUME_BASE__ */
base class for all FVGeometries
Definition: fv_geom_base.h:76
a singleton class that returns a new id for each type
Definition: fv_geom_base.h:49
size_t m_id
Definition: fv_geom_base.h:60
size_t new_id()
Definition: fv_geom_base.h:56
static UniqueFVGeomIDProvider & inst()
Definition: fv_geom_base.h:51
UniqueFVGeomIDProvider()
Definition: fv_geom_base.h:59
the ug namespace
size_t GetUniqueFVGeomID()
This method associates a unique unsigned integer value with each type.
Definition: fv_geom_base.h:65
helper class to store dimension and id of a midpoint of a sub-element
Definition: fv_geom_base.h:41
size_t id
Definition: fv_geom_base.h:45
MidID()
Definition: fv_geom_base.h:42
size_t dim
Definition: fv_geom_base.h:43
MidID(size_t dim_, size_t id_)
Definition: fv_geom_base.h:43