Code_Saturne

Overview

Code_Saturne is the free, open-source software developed and released by EDF to solve computational fluid dynamics (CFD) applications. It solves the Navier-Stokes equations for 2D, 2D-axisymmetric and 3D flows, steady or unsteady, laminar or turbulent, incompressible or weakly dilatable, isothermal or not, with scalars transport if required. Several turbulence models are available, from Reynolds-Averaged models to Large-Eddy Simulation models.

In addition, a number of specific physical models are also available as modules: gas, coal and heavy-fuel oil combustion, semi-transparent radiative transfer, particle-tracking with Lagrangian modeling, Joule effect, electrics arcs, weakly compressible flows, atmospheric flows, rotor/stator interaction for hydraulic machines.

Restrictions on use

There are no restrictions on accessing Code Saturne on the CSF. It is release under the GPL v2 license and all usage must adhere to that license.

Set up procedure

To begin using Code_Saturne on CSF4, load one of the following environment modules:

module load code_saturne/9.1.0-iomkl-2020.02-python-3.8.2
module load code_saturne/9.0.0-iomkl-2020.02-python-3.8.2
module load code_saturne/7.0.2-iomkl-2020.02-python-3.8.2
module load code_saturne/6.0.6-iomkl-2020.02-Python-3.8.2
module load code_saturne/5.0.13-iomkl-2020.02-Python-3.8.2

This will in turn load the modules used for the installation of the code (openmpi/compilers/python etc)

Please do not run Code Saturn simulations on the login node. Jobs should be submitted to the compute nodes via batch.

Please follow the instructions in the documentation to create your case and study.

Submitting Jobs

One method of submitting Code Saturne jobs to the batch system is to create a file named run.cfg in your DATA directory containing a [slurm:job_header] section. This allows you to specify the Slurm #SBATCH options that will be added to the jobscript that Code Saturn generates:

cd ~/scratch/my_case/DATA
gedit run.cfg
... other code saturn config sections here ...

[slurm:job_header]
#SBATCH -p multicore           # A single node (multicore) job. Use multinode for larger
#SBATCH -n 20                  # Up to 40 permitted in multicore, 80 or more in multinode
#SBATCH -o job_%j.out.log
#SBATCH -e job_%j.err.log
#SBATCH -Jcode_saturne:my_case

Save the file, then submit the job using the following on the login node:

module load code_saturne/9.1.0-iomkl-2020.02-python-3.8.2
code_saturn submit

This command will read your run.cfg file, create a jobscript with the #SBATCH lines given by the [slurm:job_header] section, and submit it to the batch system.

Further Documentation

The specific version documentation listed below gives full details of how to run Code_Saturne.

v5.0.13

Please see the Code_Saturne v5.0.13 CSF4 documentation.

v6.0.6

Please see the Code_Saturne v6.0.6 CSF4 documentation.

v7.0.2

Please see the Code_Saturne v7.0.2 CSF4 documentation.