dune-grid
2.2.0
|
Specialization of the generic GridFactory for UGGrid. More...
#include <dune/grid/uggrid/uggridfactory.hh>
Public Member Functions | |
GridFactory () | |
Default constructor. | |
GridFactory (UGGrid< dimworld > *grid) | |
Constructor for a given grid object. | |
~GridFactory () | |
Destructor. | |
virtual void | insertVertex (const FieldVector< ctype, dimworld > &pos) |
Insert a vertex into the coarse grid. | |
virtual void | insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices) |
Insert an element into the coarse grid. | |
void | insertBoundarySegment (const std::vector< unsigned int > &vertices) |
Method to insert a boundary segment into a coarse grid. | |
void | insertBoundarySegment (const std::vector< unsigned int > &vertices, const shared_ptr< BoundarySegment< dimworld > > boundarySegment) |
Method to insert an arbitrarily shaped boundary segment into a coarse grid. | |
virtual UGGrid< dimworld > * | createGrid () |
Finalize grid creation and hand over the grid. | |
virtual void | insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices, const shared_ptr< VirtualFunction< FieldVector< ctype, dimension >, FieldVector< ctype, dimworld > > > &elementParametrization) |
Insert a parametrized element into the coarse grid. | |
virtual void | insertBoundarySegment (const std::vector< unsigned int > &vertices, const shared_ptr< BoundarySegment< dimension, dimworld > > &boundarySegment) |
insert an arbitrarily shaped boundary segment | |
virtual unsigned int | insertionIndex (const typename Codim< 0 >::Entity &entity) const |
obtain an element's insertion index | |
virtual unsigned int | insertionIndex (const typename Codim< dimension >::Entity &entity) const |
obtain a vertex' insertion index | |
virtual unsigned int | insertionIndex (const typename UGGrid< dimworld >::LeafIntersection &intersection) const |
obtain a boundary's insertion index | |
virtual bool | wasInserted (const typename UGGrid< dimworld >::LeafIntersection &intersection) const |
determine whether an intersection was inserted |
Protected Types | |
enum | |
The grid world dimension. More... |
Static Protected Attributes | |
static const int | dimension |
dimension of the grid |
Specialization of the generic GridFactory for UGGrid.
If you want to write a routine that reads a grid from some file into a Dune UGGrid object you have to know how to use the UGGrid grid factory. In the following we assume that you have a grid in some file format and an empty UGGrid object, created by one of its constructors. Hence, your file reader method signature may look like this:
UGGrid<3>* readMyFileFormat(const std::string& filename)
Now, in order to create a valid UGGrid object do the following steps:
Get a new GridFactory object by calling
GridFactory<UGGrid<dim> > factory;
Insert the grid vertices by calling
factory.insertVertex(const FieldVector<double,dimworld>& position);
for each vertex. The order of insertion determines the level- and leaf indices of your level 0 vertices.
For each element call
factory.insertElement(Dune::GeometryType type, const std::vector<int>& vertices);
The parameters are
The numbering of the vertices of each element is expected to follow the DUNE conventions. Refer to the page on reference elements for the details.
UGGrid supports parametrized domains. That means that you can provide a smooth description of your grid boundary. The actual grid will always be piecewise linear; however, as you refine, the grid will approach your prescribed boundary. You don't have to do this. If your coarse grid boundary describes your domain well read on at Section 5.
In order to create curved boundary segments, for each segment you have to write a class which implements the correct geometry. These classes are then handed over to the UGGrid object. Boundary segment implementations must be derived from
template <int dimworld> Dune::BoundarySegment
This is an abstract base class which requires you to overload the method
virtual FieldVector< double, dimworld > operator() (const FieldVector< double, dimworld-1 > &local)
This methods must compute the world coordinates from the local ones on the boundary segment. Give these classes to your grid factory by calling
factory.insertBoundarySegment(const std::vector<int>& vertices, const BoundarySegment<dimworld> *boundarySegment);
Control over the allocated objects is taken from you, and the grid object will take care of their destruction.
To finish off the construction of the UGGrid object call
UGGrid<dim>* grid = factory.createGrid();
This time it is you who gets full responsibility for the allocated object.
If you're working on a parallel machine, and you want to set up a parallel grid, proceed as described only on the rank-0 process. On the other processes just create a GridFactory and call createGrid() to obtain the grid object. This will create the grid on the master process and set up UG correctly on all other process. Call loadBalance()
to actually distribute the grid.
|
protectedinherited |
The grid world dimension.
Dune::GridFactory< UGGrid< dimworld > >::GridFactory | ( | ) |
Default constructor.
Dune::GridFactory< UGGrid< dimworld > >::GridFactory | ( | UGGrid< dimworld > * | grid | ) |
Constructor for a given grid object.
If you already have your grid object constructed you can hand it over using this constructor. A reason may be that you need a UGGrid object with a non-default heap size.
If you construct your factory class using this constructor the pointer handed over to you by the method createGrid() is the one you supplied here.
Dune::GridFactory< UGGrid< dimworld > >::~GridFactory | ( | ) |
Destructor.
|
virtual |
Finalize grid creation and hand over the grid.
The receiver takes responsibility of the memory allocated for the grid
Implements Dune::GridFactoryInterface< UGGrid< dimworld > >.
|
inlinevirtualinherited |
insert an arbitrarily shaped boundary segment
This method inserts a boundary segment into the coarse grid.
[in] | vertices | the indices of the vertices of the segment |
[in] | boundarySegment | user defined implementation of the boundary segment's geometry |
|
virtual |
Method to insert a boundary segment into a coarse grid.
Using this method is optional. It only influences the ordering of the segments
\param vertices The indices of the vertices of the segment
Implements Dune::GridFactoryInterface< UGGrid< dimworld > >.
void Dune::GridFactory< UGGrid< dimworld > >::insertBoundarySegment | ( | const std::vector< unsigned int > & | vertices, |
const shared_ptr< BoundarySegment< dimworld > > | boundarySegment | ||
) |
Method to insert an arbitrarily shaped boundary segment into a coarse grid.
vertices | The indices of the vertices of the segment |
boundarySegment | Class implementing the geometry of the boundary segment. |
|
inlinevirtualinherited |
Insert a parametrized element into the coarse grid.
type | The GeometryType of the new element |
vertices | The vertices of the new element, using the DUNE numbering |
elementParametrization | A function prescribing the shape of this element |
Make sure the inserted element is not inverted (this holds even for simplices). There are grids that can't handle inverted elements.
|
virtual |
Insert an element into the coarse grid.
type | The GeometryType of the new element |
vertices | The vertices of the new element, using the DUNE numbering |
Implements Dune::GridFactoryInterface< UGGrid< dimworld > >.
|
inlinevirtualinherited |
obtain an element's insertion index
Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.
Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.
[in] | entity | entity whose insertion index is requested |
|
inlinevirtualinherited |
obtain a vertex' insertion index
Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.
Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.
[in] | entity | entity whose insertion index is requested |
|
inlinevirtualinherited |
obtain a boundary's insertion index
Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.
Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.
[in] | intersection | intersection whose insertion index is requested |
|
virtual |
Insert a vertex into the coarse grid.
Implements Dune::GridFactoryInterface< UGGrid< dimworld > >.
|
inlinevirtualinherited |
determine whether an intersection was inserted
This method allows checking wheter an intersection was actually inserted into the grid factory.
[in] | intersection | intersection in question |
|
staticprotectedinherited |
dimension of the grid