Quick Start with LBM_Saclay

1. LBM_Saclay’s environment & documentation

For training session: LBM_Saclay’s documentation

Open a terminal, and execute the command below for LBM_Saclay’s environment:

$ /tmpformation/LBM_Saclay/Bin-Training/lbm-env.sh

The shell script lbm-env.sh copies in your home a .bashrc and .profile for necessary paths and connexions. The script also creates a directory Training-LBM on your local disk /volatile/formation/ and copies the folder of test cases run_training_lbm inside /volatile/formation/Training-LBM.

Open the documentation

$ lbm-doc.sh &

lbm-doc.sh is an alias of command google-chrome /tmpformation/LBM_Saclay/LBM_Saclay_Doc/_build/html/index.html

To be completed

2. Get the source files of LBM_Saclay

Get access to the git repository on codev-tuleap.cea.fr

Get access to the git repository

LBM_Saclay is on the git repository [1]. To get an access to codev-tuleap, open an AD EXTRA account by sending a message on [2]. For scientists of other institutes (CNRS, INRIA, University, etc.) open an AD partner account by sending an email to alain.cartalade at cea.fr or teo.boutin at cea.fr. Once you got the account, change your password on [3].

Download LBM_Saclay

Download LBM_Saclay

To download either the Training version or the Rech-Dev version, open a terminal (or Konsole) and copy-paste one of two commands below:

e.g. for LBM_Saclay_Rech-Dev version:

$ git clone --recursive https://codev-tuleap.cea.fr/plugins/git/lbmsaclay/LBM_Saclay_Rech-Dev.git

e.g. for LBM_Saclay_Training version

$ git clone --recursive https://codev-tuleap.cea.fr/plugins/git/lbmsaclay/LBM_Saclay_Training.git

For training session

Copy file LBM_Saclay_Rech-Dev.tar

$ cp /tmpformation/LBM_Saclay/LBM_Saclay_Rech-Dev.tar .

untar your file

$ tar -xvf LBM_Saclay_Rech-Dev.tar

3. Compilation

You can run your first simulations on CPUs of your personal desktop. However, it is highly recommended to run LBM_Saclay on one (or better on several) graphic cards (GPUs). You will find the procedure for compiling on single-CPU, single-GPU, and multi-GPU.

Makefile

  • For openmp (omp) on CPU

./compilation/local/omp/configure_build.sh

  • For cuda on GPU H100 of ORCUS

./compilation/orcus/cuda_h100/configure_build.sh

For GPU A100 and V100, modify only cuda_h100 by cuda_a100 (A100) or cuda_v100 (V100)

  • For cuda on A6000 of MANWE

./compilation/manwe/cuda_a6000/configure_build.sh

will return:

The following problems are currently implemented:
0  AC
1  Advection-Diffusion
2  Crystal_growth_Younsi
3  GPMixt
4  GPMixtNS
5  GPMixtTernary
6  GPMuTernary
7  MPwSLphC
8  NS
9  NS_3phases_1comp_phase_change
10 NSAC_Comp
11 NSAC_Comp_3phases
12 NSAC_Comp_3phases3D
13 NSAC_coupling
14 NSAC_Fakhari
15 NSAC_Surfactant
Choose which problems to include by indicating a list of space or comma separated numbers, eg '0 1' or '0,1'.
Write 'all' to include all problems.
Problem numbers:

Compilation

Go to the directory that is indicated by the green link, e.g., if number 10 has been set:

$ cd LBM_Saclay_Rech-Dev/build_cuda_a6000/build_NSAC_Comp

Compile:

$ make -j 22

4. Run your first test case on your local CPU

It is recommended to start with a test case of folder run_training_lbm and execute on local disk /volatile. For example:

For training session: local computer

Go to one test case of run_training_lbm, e.g. TestCase02_Poiseuille_Water:

$ cd /volatile/formation/Training-LBM/run_training_lbm/TestCase02_Poiseuille_Water

Run LBM_saclay with the input file name.ini

$ /volatile/formation/Training-LBM/LBM_Saclay_Rech-Dev/build_openmp/src/LBM_saclay TestCase02_Poiseuille_Water.ini

5. Post-processing with Paraview

The .bashrc file contains an alias for paraview versions 5.11 and 5.12 in /tmpformation/LBM_Saclay. In paraview, open the .vti files. For post-processing the .h5 (HDF5) files open the .xml file and clic on XDMF Reader.

For training session: post-processing with paraview

For post-processing .xmf and .h5 files for videos use paraview11

$ paraview11&

For comparison with analytical solutions, use paraview12

$ paraview12&

and follow tutorials presented in Practice of two-phase flows with test cases of run_training_lbm.

6. Help and Support

On weblink [4] open a NEW ID_LBM and explain your problem.

Section author: Alain Cartalade