MAMMOTH
			       =======

Contents

1. About
2. Dependencies
3. Installation
4. Usage
5. References

				About
				-----

MAMMOTH is a wavelet-based multiresolution mesh generator, leveraging
the Triangle mesh generator for high-quality Delaunay triangulations.


			     Dependencies
			     ------------

+ Triangle by J.R. Shewchuk {https://www.cs.cmu.edu/~quake/triangle.html}
+ LaGriT (Optional) {https://lagrit.lanl.gov}

/MAMMOTH/ provides tools to extrude the mesh in the vertical and
generate Exodus-II meshes.  Since Triangle doesn't offer such
capabilities, this is done through the mesh generator LaGriT.  If no
Exodus-II meshes are needed or another workflow is preferred, LaGriT
doesn't need to be installed.


			     Installation
			     ------------

/MAMMOTH/ ships with a GNU makefile.  Set your preferred C compiler and
build the code by executing

$ make; make clean

which will produce the executable `mammoth'.


				Usage
				-----

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

$ ./mammoth -[a/m] <input-file>


The `-a` flag is set for carrying out the multiresolution analysis.
The `-m` meshes the domain.

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.


			   Acknowledgments
			   ---------------

This work is supported as part of the Interoperable Design of
Extreme-scale Application Software - Watersheds project
(IDEAS-Watersheds) funded by the U.S. Department of Energy, Office of
Science, Office of Biological and Environmental Research under Award
Number DE-AC02-05CH11231.