summaryrefslogtreecommitdiff
path: root/README.md
blob: 515e19db651def479b2ec6e49bba1fefbb016a4f (plain)
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
# MAMMOTH

MAMMOTH is a wavelet-based multiresolution mesh generator, leveraging
{[J.R. Shewchuk's
Triangle](https://www.cs.cmu.edu/~quake/triangle.html)} for the
Delaunay triangulation.

## Dependencies

+ [GCC, the GNU Compiler Collection](https://gcc.gnu.org)
+ [GNU Make](https://www.gnu.org/software/make/)
+ [Triangle](https://www.cs.cmu.edu/~quake/triangle.html)

## Installation

Use GNU make to build the code.

## Usage

After building, the executable is located in the root directory.

```
./mammoth <input-file>
```

See the example input folder provided alongside the code.

## References

+ Özgen-Xian, I., Kesserwani, G., Caviedes-Voullième, D., Molins, S.,
  Xu, Z., Dwivedi, D., Moulton, J. D., Steefel, C. I., Wavelet-based
  local mesh refinement for rainfall-runoff simulations, Journal of
  Hydroinformatics, 22, pp. 1059-1077, 2020.
+ Shewchuk, J. R., Triangle: Engineering a 2D Quality Mesh Generator
  and Delaunay Triangulator, in: Applied Computational Geometry:
  Towards Geometric Engineering (Ming C. Lin and Dinesh Manocha,
  editors), pp. 203-222, Springer-Verlag, Berlin, 1996.