SU2

Installation

SU2 is generally installed under /opt/drz/apps/su2<version>. A version specific modulefile for SU2 with setup and MPI configuration is placed under /opt/drz/modulefiles/su2/. Additionally, modulefiles are also placed for GCC, GMSH, mpi4py, paraview and swig in case SU2 is compiled with non distribution libraries.

An example module file for SU2 is below

#
#  SU2 7.0.8 module file
#


set  SU2_ROOT /opt/drz/apps/su2
set  SU2_VERSION 7.0.8

set SU2_RUN $SU2_ROOT/$SU2_VERSION/bin
set SU2_HOME $SU2_ROOT/SU2-7.0.8

setenv          SU2_RUN     $SU2_RUN
setenv          SU2_HOME    $SU2_HOME
prepend-path    PATH        $SU2_RUN
prepend-path    PYTHONPATH  $SU2_RUN

# # Set Intel Compiler runtime path
#setenv INTEL_COMPILER_HOME /opt/drz/apps/intel/impi/2017

# Load additional tools
module load paraview
module load gmsh
module load mpi4py
module load gcc/8.4.0
module load swig/4.0.2
# Set Intel MPI configuration

setenv   DRZ_SU2_IMPI_I_MPI_FABRICS  shm:ofi
setenv   DRZ_SU2_IMPI_PATH  /opt/intel/oneapi/mpi/latest/bin
setenv   DRZ_SU2_IMPI_FI_PROVIDER_PATH /opt/intel/oneapi/mpi/latest/libfabric/lib/prov
setenv   DRZ_SU2_IMPI_LD_LIBRARY_PATH /opt/intel/oneapi/mpi/latest/lib

Example module file for GCC

#%Module 1.0
#
#  GCC 8.4.0 module file
#


set  GCC_ROOT /opt/drz/apps/gcc
set  GCC_VERSION 8.4.0

prepend-path    PATH        $GCC_ROOT/$GCC_VERSION/bin
prepend-path    LD_LIBRARY_PATH  $GCC_ROOT/$GCC_VERSION/lib64
prepend-path    INCLUDE  $GCC_ROOT/$GCC_VERSION/include
prepend-path    C_INCLUDE  $GCC_ROOT/$GCC_VERSION/include

Example modulefile for GMSH

#%Module 1.0
#
#  GMSH 4.5.6 Module file
#


set  GMSH_ROOT /opt/drz/apps/gmsh
set  GMSH_VERSION 4.5.6

prepend-path PATH $GMSH_ROOT/$GMSH_VERSION/bin

Example module file for Paraview

#%Module 1.0
#
#  Paraview 5.8 module file
#


set  PARAVIEW_ROOT /opt/drz/apps/paraview
set  PARAVIEW_VERSION 5.8

prepend-path PATH $PARAVIEW_ROOT/$PARAVIEW_VERSION/bin

Example modulefile for Swig

#%Module 1.0
#
#  SWIG 4.0.2 module file
#


set  SWIG_ROOT /opt/drz/apps/swig
set  SWIG_VERSION 4.0.2

prepend-path    PATH        $SWIG_ROOT/$SWIG_VERSION/bin

Workflow

The SU2 component can be used to run the SU2, open-source CFD code in both serial and parallel.

Working Directory: The directory where you want to execute the SU2 solver.

SU2 Config File: The SU2 config file to be passed as input to the SU2 command.

Version: The version of SU2 to execute.

Number of CPU cores: The number of cpu cores to use for execution. If the number of cores is more than 1, the command will be started with Intel MPI on multiple compute nodes, if necessary.

The SU2 Command: The SU2 command to execute. Commonly used SU2 commands are provided here. Note that, for commands which take the options:

-f FILE, --file=FILE read config from FILE

-n PARTITIONS, --partitions=PARTITIONS number of PARTITIONS

these values are automatically passed in by HPCBOX. You can provide additional options like

-c COMPUTE, --compute=COMPUTE COMPUTE direct and adjoint problem

in the Arguments field of the form.

Run a custom command: Use this option if you would like to run an SU2 command which is not provided in the previous dropdown list.

The custom SU2 command: This option is displayed only if you have selected to run a custom SU2 command. Again, you do not need to pass in the config file or number of partition options when specifying the command name.

Editing files

Visual Studio Code is provided as an editor to edit your SU2 config files. An icon to start Code can be found on your desktop, alternatively, Code can be started from a terminal using the code command. To set the terminal environment for SU2, you’ll have to run the following command

module load su2

Running the above command will set the following environment variables

SU2_HOME SU2_RUN PYTHONPATH IMPI_HOME

tip

We recommend getting assistance from HPCBOX support at boxhelp[at]drizti.com for building, fine-tuning and setting up SU2 in case the version you require is not already available on your instance of HPCBOX. We are here to help!