Developers wiki: Project's tree

Project's tree

Project's source tree

The mmg project is organized as follows:

• the cmake folder contains customization files for CMake and CTest:

Subfolder	Contents
cmake/config	configuration files for CTest
cmake/modules	module files for CMake
cmake/supp	file to suppress libSystem Valgrind errors on MacOs
cmake/testing	files listing the continuous integration tests used by CTest

• the doc folder contains files related to the project documentation:

Subfolder	Contents
doc/Doxygen/mmg3d	Doxygen documentation for mmg3d
doc/Doxygen/mmgs	Doxygen documentation for mmgs
doc/Doxygen/mmg2d	Doxygen documentation for mmg2d

• the libexamples directory contains examples to use the mmg libraries. The libexamples/mmg3d subfolder contains the examples related to the mmg3d library, the libexamples/mmg2d subfolder contains the examples related to the mmg2d library, the libexamples/mmgs subfolder contains the examples related to the mmgs library and the libexamples/mmg subfolder contains the examples related to the use of the mmg library (that gathers the three others libraries).

Subfolder	Contents	Additional informations
libexamples/mmg/example0/	basic example of the use of the mmg library for 2d and 3d surface and volume adaptation test cases
libexamples/mmg/example0_fortran/	same basic example but for a Fortran developer
libexamples/mmg2d/adaptation_example0/	two basic examples of the use of the mmg2d library for an adaptation test case	README.md
libexamples/mmg2d/adaptation_example0_fortran/	basic example of the use of the mmg2d library for a Fortran developer	README.md
libexamples/mmg2d/adaptation_example1/	advanced used of the mmg2d library for an adaptation example	README.md
libexamples/mmg2d/squareGeneration_example2/	advanced used of the mmg2d library for a mesh generation test case	README.md
libexamples/mmgs/adaptation_example0/	basic example of the use of the mmgs library for an adaptation test case	README.md
libexamples/mmgs/adaptation_example0_fortran/	same basic example but for a Fortran developer	README.md
libexamples/mmgs/adaptation_example1/	advanced used of the mmgs library for an adaptation example	README.md
libexamples/mmg3d/adaptation_example0/	two basic examples of the use of the mmg3d library for an adaptation test case	README.md
libexamples/mmg3d/adaptation_example0_fortran/	same basic examples but for a Fortran developer	README.md
libexamples/mmg3d/adaptation_example1/	move quickly from a call to the mmg3d4 library to a call to the new mmg3d library (release 5.x.x)	README.md
libexamples/mmg3d/adaptation_example2/	advanced used of the mmg3d library for an adaptation example	README.md
libexamples/mmg3d/IsosurfDiscretization_example0/	basic example of the use of the mmg3d library for a level-set discretization	README.md

• the src folder contains the applications sources:

Subfolder	Contents
src/common	files used by both mmg2d, mmgs and mmg3d
src/mmg	header files for the mmg library
src/mmg2d	files dedicated to the mmg2d application
src/mmgs	files dedicated to the mmgs application
src/mmg3d	files dedicated to the mmg3d application

• the scripts folder contains the project's scripts.

Created directories

• Compiling the project creates some additional directories used to store the produced outputs:

Folder	Contents
bin	created executables
include	library header files
lib	created libraries

Note that the installation step copies the previous directories at the specified installation path.

• Compiling the Doxygen documentation creates subfolders into the doc/doxygen/ directory:

Subfolder	Contents
doc/doxygen/mmg2d/html	mmg2d documentation
doc/doxygen/mmgs/html	mmgs documentation
doc/doxygen/mmg3d/html	mmg3d documentation