Skip to content

Latest commit

 

History

History
200 lines (145 loc) · 10.7 KB

README.md

File metadata and controls

200 lines (145 loc) · 10.7 KB
Raw

mmg - Surface and volume remeshers

open source software for bidimensional and tridimensional surface and volume remeshing

Release License

macOS support Ubuntu support Windows support
master branch (release) Build Status codecov
develop branch Build Status Coverage

Mmg provides 3 applications and 4 libraries:

  • the mmg2d application and library: mesh generation from a set of edges, adaptation and optimization of a bidimensional triangulation, and isovalue discretization;
  • the mmgs application and library: adaptation and optimization of a surface triangulation and isovalue discretization;
  • the mmg3d application and library: adaptation and optimization of a tetrahedral mesh, isovalue discretization and lagrangian movement;
  • the mmg library gathering the mmg2d, mmgs and mmg3d libraries.

Get and compile the mmg project

Needed tools

To get and build Mmg, you will need:

  • Git: to download the code you will have to use a git manager. You can install a git manager from the link below but there are many other git clients that you can use:

    Note that if you uses Microsoft Visual Studio (Windows OS), you can simply activate the Git Module of the application.

  • CMake : Mmg uses the CMake building system that can be downloaded on the following web page: https://cmake.org/download/. On Windows OS, once CMake is installed, please do not forget to mark the option:

         Add CMake to the system PATH for all users

Mmg download and compilation

Unix-like OS (Linux, MacOS...)

  1. Get the repository:
      wget https://github.com/MmgTools/mmg/archive/master.zip

or

      git clone https://github.com/MmgTools/mmg.git

The project sources are available under the src/ directory, see:

  • src/mmg2d/ for files related to the mmg2d application;
  • src/mmgs/ for files related to the mmgs application;
  • src/mmg3d/ for files related to the mmg3d application;
  • src/common/ for files related to all three.
  1. Fast compilation (build mmg2d, mmgs, mmg3d, the mmg2d static library (libmmg3d.a), the mmgs static library (libmmgs.a), the mmg3d static library (libmmg3d.a) and the mmg static library (libmmg.a)) all at once:
      cd mmg
      mkdir build
      cd build
      cmake ..
      make
      make install

If the make install command fails, try to run the sudo make install command. If you don't have root access, please refer to the Installation section of the setup guide.

The mmg2d, mmgs and mmg3d applications are available under the mmg2d_O3, mmgs_O3 and mmg3d_O3 commands.

Note that if you use some specific options and want to set them easily, you can use a shell script to execute the previous commands. An example is provided here.

Windows OS

The following compilation can be performed in any modern version of Windows (AKA 7, 8, 8.1 and 10). A basic knowledge of Windows is assumed (execute commands in cmd, create directories, etc...).

Compile with VisualStudio

Universal windows platform development

  1. Get the Visual Studio software: it can be downloaded here;

  2. if not done during the previous step, download C/C++ compilers: in the Visual Studio searching zone, search C compiler and install the Visual C++ compilers and libraries (individual componant) and the MSBuild componant;

  3. in the Visual Studio searching zone, search the git word and select the installation of the GitHub extension for VisualStudio;

  4. stay in VisualStudio and clone the Mmg repository from the following url: https://github.com/MmgTools/mmg.git;

  5. Use CMake to configure and generate your project. It can be done either with the graphic mode of CMake (you have to select the "VisualStudio" generator) or with a command line. In this case, it is highly recommended to specify that you intent to build a VisualStudio project. For example, if you are using VisualStudio 2017:

  cmake -G "Visual Studio 15 2017 Win64" ^
  configure

Note that you can use a script to make this step easier (an example of script is provided here).

Once the configuration script has finished without errors a mmg.sln file will be generated in the cmake_build directory.

  1. Double click this file and the visual studio project will open. Then choose the project configuration (Release, Debug...) and make sure that the project is set to Win32 or x64. Finally, in order to compile Mmg, right click the INSTALL project and select the option BUILD.
Compile with MinGW

  1. Get a C Compiler:

    • MinGW can be downloaded here. We recommand to install the mingw-developer-tools, mingw32-base, mingw32-gcc-fortran, mingw32-gcc-g++ and msys-base packages;
    • Edit the environment variables and add MinGW in your PATH variable. It can be done in the advanced system settings panel. (note that you must modify the PATH variable, not Path);
    • MinGW binaries are probably in C:\MinGW\bin
    • the MinGW terminal is in C:\MinGW\msys\1.0\msys

  2. Clone the Mmg repository from the following url: https://github.com/MmgTools/mmg.git;

  3. Quit and restart the CMake application to take the PATH modification into account then use CMake to configure and generate your project (select the MinGW Makefiles generator of CMake). If you have installed the scotch libraries, you will need to set explicitely the libraries paths;

  4. Build the Mmg applications: in the minGW prompt (C:\MinGW\msys\1.0\msys) run:

       mingw32-make

Again, if you use some specific options and want to make the CMake configuration step easier, you can use a batch script. An example script is provided here.

Documentation

Project web page

Actualities of the project and software tutorials can be found on the mmgtools web page.

Forum

Share your comments and issues with other members of the Mmg community on the Mmg forum.

GitHub Wiki

More detailed information about the compilation and configuration of Mmg applications is available on the project wiki.

Man pages

Man pages are available inside the doc/man directory:

  • To see the mmg2d man page, just run man ./doc/man/mmg2d.1.gz
  • To see the mmgs man page, run man ./doc/man/mmgs.1.gz
  • To see the mmg3d man page, run man ./doc/man/mmg3d.1.gz

Code documentation

Run the make doc command to build the Doxygen documentation, after running cmake with the option -DBUILD_DOC=yes if you did not already do so. You may wish to adapt build/Doxyfile to your liking.

  • To see the mmg documentation, open the file <build>/doc/index.html.

Platforms

The mmg applications are tested on OS X and on most of the Linux platforms.

Contributing

Your contributions to the mmg project are welcome. You can help us to improve our code by many means:

About the team

Mmg's current developers and maintainers are Charles Dapogny, Cécile Dobrzynski, Pascal Frey and Algiane Froehly.

Contact: [email protected]

License and copyright

Code is under the terms of the GNU Lesser General Public License.

Copyright © Bx INP/Inria/UBordeaux/UPMC, 2004- .

Reference

Tetrahedral remeshing in the context of large-scale numerical simulation and high performance computing - G. Balarac, F. Basile, P. Bénard, F. Bordeu, J.-B. Chapelier, L. Cirrottola, G. Caumon, C. Dapogny, P. Frey, A. Froehly, G. Ghigliotti, R. Laraufie, G. Lartigue, C. Legentil, R. Mercier, V. Moureau, C. Nardoni, S. Pertant and M. Zakari - submitted, (2021)

Three-dimensional adaptive domain remeshing, implicit domain meshing, and applications to free and moving boundary problems - C. Dapogny, C. Dobrzynski and P. Frey - April 1, 2014 - JCP