HTTPS SSH

mshr

mshr is the mesh generation component of FEniCS. It generates simplicial DOLFIN meshes in 2D and 3D from geometries described by Constructive Solid Geometry (CSG) or from surface files, utilizing CGAL and Tetgen as mesh generation backends.

Authors:
Benjamin Kehlet <benjamik@simula.no>
Contributors:
Anders Logg <logg@chalmers.se>
Johannes Ring <johannr@simula.no>
Garth N. Wells <gnw20@cam.ac.uk>

Documentation

The documentation is currently being prepared here: https://bitbucket.org/fenics-project/mshr/wiki

Installation

For Debian and Ubuntu users, installing mshr is as easy as:

sudo apt-get install fenics

To get a recent version of, enable the FEniCS PPA first. See Installation instructions for Ubuntu

To build mshr from source, run:

cmake <path to mshr source tree>
make
make install

mshr's build script will also build CGAL and Tetgen from source and include them in the binary.

Dependencies

mshr needs DOLFIN with Python support (pyDolfin). CGAL and Tetgen are shipped with mshr and built from source automatically. CGAL needs Gnu GMP and Gnu MPFR.

License

mshr is licensed under GPL version 3 or (at your option) any later version.

Contact

mshr is hosted at https://bitbucket.org/fenics-project/mshr/

For comments and requests, send an email to the FEniCS mailing list:

fenics@fenicsproject.org

For bug reports and feature requests, visit mshr's issue tracker at BitBucket:

https://bitbucket.org/fenics-project/mshr/issues

Contributions

Contributions are welcome!

Please read about contributing to FEniCS here: http://fenicsproject.org/contributing/

If you plan to implement a new feature, please discuss it at the FEniCS mailing list beforehand. Smaller patches and bugfixes are easiest submitted as pull request on Bitbucket.