/usr/include/dune/grid/common/refinement.hh is in libdune-grid-dev 2.2.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | #ifndef DUNE_GRID_COMMON_REFINEMENT_HH
#define DUNE_GRID_COMMON_REFINEMENT_HH
// This file is part of DUNE, a Distributed and Unified Numerics Environment
// This file is copyright (C) 2005 Jorrit Fahlke <jorrit@jorrit.de>
// This file is licensed under version 2 of the GNU General Public License,
// with a special "runtime exception." See COPYING at the top of the source
// tree for the full licence.
/*! @file
@brief This file simply includes all @ref Refinement implementations
so you don't have to do them separately.
@verbatim
$Id: refinement.hh 7929 2012-03-08 12:26:26Z joe $
@endverbatim
*/
/*! @addtogroup Refinement Refinement
@ingroup Grid
<!--WWWWWWWWWWWWW-->
@section General
<!--=========-->
The %Refinement system allows to temporarily refine a grid or single
entities without changing the grid itself. You may want to do this
because you want to write your data to a file and have to do
subsampling, but want to continue the calculation with the
unmodified grid afterwards.
@subsection Can_do What Refinement can do for you
<!---------------------------------------------->
For a given geometry type and refinement level, %Refinement will
- assign consecutive integer indices starting at 0 to each
subvertex,
- assign consecutive integer indices starting at 0 to each
subelement,
- calculate the coordinates of the subvertices for you,
- calculate subvertex-indices of the corners of the subelements for
you.
The geometry type of the refined entity and of the subelements may
be different, for example you can refine a quadrilateral but get
subelements which are triangles.
Currently the following geometry types are supported:
- hypercubes (quadrilaterals, hexahedrons),
- simplices (triangles, tetrahedrons),
- triangulating hypercubes into simplices (quadrilaterals ->
triangles, hexahedrons -> tetrahedrons).
@subsection Cannot_do What Refinement can't do for you
<!--------------------------------------------------->
- %Refinement does not actually subsample your data, it only tells
you @em where to subsample your data.
- The geometry types need to be known at compile time. See @link
VirtualRefinement VirtualRefinement@endlink if you need to
calculate the right geometry type at run time.
- No %Refinement implementations for anything besides hypercubes and
simplices have been written yet.
@section User_interface The user interface
<!--===================================-->
@code
template<unsigned topologyId, class CoordType,
unsigned coerceToId, int dimension>
class StaticRefinement
{
public:
enum { dimension };
template<int codimension>
struct codim {
class SubEntityIterator;
};
typedef ImplementationDefined VertexIterator; // These are aliases for codim<codim>::SubEntityIterator
typedef ImplementationDefined ElementIterator;
typedef ImplementationDefined IndexVector; // These are FieldVectors
typedef ImplementationDefined CoordVector;
static int nVertices(int level);
static VertexIterator vBegin(int level);
static VertexIterator vEnd(int level);
static int nElements(int level);
static ElementIterator eBegin(int level);
static ElementIterator eEnd(int level);
}
@endcode
The Iterators can do all the usual things that Iterators can do,
except dereferencing. In addition, to do something useful, they
support some additional methods:
@code
template<unsigned topologyId, class CoordType, unsigned coerceToId, int dimension>
class VertexIterator
{
public:
typedef ImplementationDefined Refinement;
int index() const;
Refinement::CoordVector coords() const;
}
template<unsigned topologyId, class CoordType, unsigned coerceToId, int dimension>
class ElementIterator
{
public:
typedef ImplementationDefined Refinement;
int index() const;
// Coords of the center of mass of the element
Refinement::CoordVector coords() const;
Refinement::IndexVector vertexIndices() const;
}
@endcode
@subsection How_to_use_it How to use it
<!------------------------------------>
Either use VirtualRefinement, or if you don't want to do that, read
on.
@code
// Include the necessary files
#include <dune/grid/common/refinement.hh>
// If you know that you are only ever going to need one refinement
// backend, you can include the corresponding file directly:
//#include <dune/grid/common/refinement/hcube.cc>
// Get yourself the Refinement you need:
typedef StaticRefinement<GenericGeometry::CubeTopology<2>::type::id,
SGrid<2, 2>::ctype,
GenericGeometry::CubeTopology<2>::type::id,
2> MyRefinement;
int main()
{
const int refinementlevel = 2;
cout << "Using refinementlevel = " << refinementlevel << endl << endl;
// get Number of Vertices
cout << "Number of Vertices: "
<< MyRefinement::nVertices(refinementlevel)
<< endl;
// Iterate over Vertices
cout << "Index\tx\ty" << endl;
MyRefinement::VertexIterator vEnd = MyRefinement::vEnd(refinementlevel);
for(MyRefinement::VertexIterator i = MyRefinement::vBegin(refinementlevel); i != vEnd; ++i)
cout << i.index() << "\t" << i.coords()[0] << "\t" << i.coords()[1] << endl;
cout << endl;
// Iterate over Vertices
cout << "Index\tEcke0\tEcke1\tEcke2\tEcke3" << endl;
MyRefinement::ElementIterator eEnd = MyRefinement::eEnd(refinementlevel);
for(MyRefinement::ElementIterator i = MyRefinement::eBegin(refinementlevel); i != eEnd; ++i)
cout << i.index() << "\t"
<< i.indexVertices()[0] << "\t" << i.indexVertices()[1] << "\t"
<< i.indexVertices()[2] << "\t" << i.indexVertices()[3] << endl;
cout << endl;
}
@endcode
@subsection Guarantees
<!------------------->
The %Refinement system gives this guarantee (besides conforming to
the above interface:
- The indices of the subvertices and subelement start at 0 and are
consecutive.
@section Implementing Implementing a new Refinement type
<!--=================================================-->
If you want to write a %Refinement implementation for a particular
geometry type, e.g. SquaringTheCircle (or a particular set of
geometry types) here is how:
- create a file refinement/squaringthecircle.cc and \#include
"base.cc". Your file will be included by others, so don't forget
to protect against double inclusion.
- implement a class (or template class) RefinementImp conforming
exactly to the user interface above.
- put it (and it's helper stuff as apropriate) into it's own
namespace Dune::RefinementImp::SquaringTheCircle.
- define the mapping of topologyId, CoordType and coerceToId to your
implementation by specialising template struct
RefinementImp::Traits. It should look like this:
@code
namespace Dune::RefinementImp {
// we're only implementing this for dim=2
template<class CoordType>
struct Traits<sphereTopologyId, CoordType,
GenericGeometry::CubeTopology<2>::type::id, 2>
{
typedef SquaringTheCircle::RefinementImp<CoordType> Imp;
};
}
@endcode
If you implement a template class, you have to specialise struct
RefinementImp::Traits for every possible combination of
topologyId and coerceToId that your implementation supports.
- \#include "refinement/squaringthecircle.cc" from refinement.hh.
This is enough to integrate your implementation into the %Refinement
system. You probably want to include it into @link
VirtualRefinement VirtualRefinement@endlink also.
@subsection Namespaces
<!------------------->
The (non-virtual) %Refinement system is organized in the following
way into namespaces:
- Only template class StaticRefinement lives directly in namespace Dune.
- Use namespace Dune::RefinementImp for all the Implementation.
- Use namespace Dune::RefinementImp::HCube, namespace
Dune::RefinementImp::Simplex, ... for each implementation.
The complete @link VirtualRefinement VirtualRefinement@endlink stuff
is directly in namespace Dune.
@subsection Layers Conceptual layers
<!--------------------------------->
- <strong>Layer 0</strong> declares struct
RefinementImp::Traits<topologyId, CoordType, coerceToId, dim>.
It's member typedef Imp tells which %Refinement implementation to
use for a given topologyId (and CoordType). It is located in
refinementbase.cc.
- <strong>Layer 1</strong> defines
RefinementImp::XXX::RefinementImp. It implements the Refinements
for each topologyId, coerceToId (and CoordType). Also in this
layer are the definitions of struct RefinementImp::Traits. This
layer is located in refinementXXX.cc.
- <strong>Layer 2</strong> puts it all together. It defines class
StaticRefinement<topologyId, CoordType, coerceToId, dim> by deriving
from the corresponding RefinementImp. It is located in
refinementbase.cc.
- There is a dummy <strong>layer 2.5</strong> which simply includes
all the refinementXXX.cc files. It is located in refinement.cc.
@link VirtualRefinement VirtualRefinement@endlink adds two more
layers to the ones defined here.
*/
// The interface (template<...> class StaticRefinement) is not included here
// since it derives from parts which I consider implementation. Look
// into refinement/base.cc if the documentation is above is not enough.
#include "refinement/base.cc"
#include "refinement/hcube.cc"
#include "refinement/simplex.cc"
#include "refinement/hcubetriangulation.cc"
#include "refinement/prismtriangulation.cc"
#include "refinement/pyramidtriangulation.cc"
#endif //DUNE_GRID_COMMON_REFINEMENT_HH
|