ParaDiGM (Parallel Distributed General Mesh) is a parallel computational geometry library under LGPL, with interfaces in C, Fortran and Python.

Documentation

User documentation is deployed on ONERA's internal GitLab pages server and can be found here.

Build and install

Dependencies

General dependencies for building ParaDiGM are:

• a C compiler
• CMake (version 3.16 or higher)
• an MPI distribution

Basic Installation

Follow these steps to build ParaDiGM from the sources:

1. git clone [email protected]:numerics/mesh/paradigm.git (for ONERA users only)
2. cd paradigm
3. git submodule update --init extensions/paradigma (if you want to enable ParaDiGMA)
4. mkdir build
5. cd build
6. cmake ..
7. make
8. make install
9. ./pdm_run (if you want to run the test cases)

CMake general options

cmake -D<option1_name>=<option1_value> ... -D<option2_name>=<option2_value>

Installation prefix

CMAKE_INSTALL_PREFIX=<prefix>

Enable Fortran interface

PDM_ENABLE_Fortran=<ON | OFF> (default : OFF)

Enable Python interface

PDM_ENABLE_PYTHON_BINDINGS=<ON | OFF> (default : OFF)

If a simple autodetection fails, you can use these options to find Python :

PYTHON_LIBRARY=<path>
PYTHON_INCLUDE_DIR=<path>

Refer to FindPython in the CMake documentation for more information.

⚠️ Note that a shared library is necessary for Python interface: PDM_ENABLE_SHARED=ON

Build shared library

PDM_ENABLE_SHARED=<ON | OFF> (default : ON)

Build static library

PDM_ENABLE_STATIC=<ON | OFF> (default : ON)

Build tests

PDM_ENABLE_TESTS=<ON | OFF> (default : ON)

Enable the use of ParMETIS (parallel graph partitioning)

PDM_ENABLE_PARMETIS=<ON | OFF> (default : ON)

If a simple autodetection fails, you can use these options to find ParMETIS :

PARMETIS_DIR=<path>

To link shared libraries, ParMETIS must be compiled with the -fPIC flag.
CMake looks for

• parmetis.h and metis.h includes
• parmetis and metis libraries

Enable the use of PT-Scotch (parallel graph partitioning)

PDM_ENABLE_PTSCOTCH=<ON | OFF> (default : ON)

If a simple autodetection fails, you can use these options to find PT-Scotch :

PTSCOTCH_DIR=<path>

To link shared libraries, PT-Scotch must be compiled with the -fPIC flag.
CMake looks for

• ptscotch.h include file
• scotch, scotcherr, ptscotch, ptscotcherr libraries

Enable the use of BLAS / LAPACK (linear algebra)

PDM_ENABLE_BLASLAPACK=<ON | OFF> (default : OFF)

Enable long int for global IDs

PDM_ENABLE_LONG_G_NUM=<ON | OFF> (default : ON)

• ON : PDM_g_num_t type is long int
• OFF : PDM_g_num_t type is int

Enable documentation compilation

PDM_ENABLE_DOC=<ON | OFF> (default : OFF)

Once built (using the make doc command), the documentation home page can be found in build/doc/sphinx/html/index.html

Compiler choice

CC=<C compiler> CXX=<CXX compiler> FC=<Fortran compiler> cmake ...

or use the following CMake options

CMAKE_C_COMPILER=<C compiler>
CMAKE_CXX_COMPILER=<CXX compiler>
CMAKE_Fortran_COMPILER=<Fortran compiler>

CMake MPI options

MPI_C_COMPILER=<C MPI wrapper>
MPI_CXX_COMPILER=<CXX MPI wrapper>
MPI_Fortran_COMPILER=<Fortran MPI wrapper>

If a simple autodetection fails, you can use these options to find MPI :

MPI_<language>_LIBRARIES
MPI_<language>_INCLUDE_PATH

Refer to FindMPI in the CMake documentation for more information.

Issues

Issues can be reported directly in the Issues section.

License

ParaDiGM is available under the LGPL3 license (https://www.gnu.org/licenses/lgpl-3.0.fr.html).

Copyright

Copyright 2025, ONERA The French Aerospace Lab