Commit 22c8d7dd authored by Praetorius, Simon's avatar Praetorius, Simon

cleanup of README

parent b79c020c
......@@ -11,11 +11,14 @@ Installation
Building the module follows the standard Dune guideline, i.e. simply call
dunecontrol --current all
```
dunecontrol --current all
```
In the modules root directory. Required dependencies are the modules
- dune-common
- dune-grid
and optionally you may provide different grid modules that can be used with
dune-multimesh, e.g.
- dune-alugrid
......@@ -28,14 +31,18 @@ Getting started
In order to build a MultiMesh, simply wrap your host-grid type into a the
`MultiMesh` class and set the number of grids to construct.
using HostGrid = ALUGrid<2, 2, simplex, conforming>;
MultiMesh<HostGrid> multimesh(2);
```
using HostGrid = ALUGrid<2, 2, simplex, conforming>;
MultiMesh<HostGrid> multimesh(2);
```
If the host-grid allows to pass arguments to its constructo, these can be
appended to the MultiMesh constructor after the size argument, e.g.
using HostGrid = AlbertaGrid<3,3>;
MultiMesh<HostGrid> multimesh(2, filename);
```
using HostGrid = AlbertaGrid<3,3>;
MultiMesh<HostGrid> multimesh(2, filename);
```
Since grids are not copy-constructable, all grids in a MultiMesh are constructed
from scratch from the same arguments or the same grid-factory, to guarantee
......@@ -46,10 +53,12 @@ constructor creates one grid only. (This is just to be conform the the
GridFactory interface). In order to use, e.g. structured grid-factory builders,
you have to pass the MultiMesh GridFactory:
using HostGrid = ALUGrid<2, 2, simplex, conforming>;
using Factory = StructuredGridBuilder<MultiMesh<HostGrid> >;
GridFactory<MultiMesh<HostGrid> > gridFactory(3); // create 3 grids
auto gridPtr = Factory::createSimplexGrid(gridFactory, lower, upper, num);
```
using HostGrid = ALUGrid<2, 2, simplex, conforming>;
using Factory = StructuredGridBuilder<MultiMesh<HostGrid> >;
GridFactory<MultiMesh<HostGrid> > gridFactory(3); // create 3 grids
auto gridPtr = Factory::createSimplexGrid(gridFactory, lower, upper, num);
```
Since the dune-grid StructuredGridFactory does not allow to pass an own
GridFactory object to fill, a modified StructuredGridFactory is provided in the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment