Running CONVERGE on Linux

<< Click to Display Table of Contents >>

Navigation:  Workflow for a CONVERGE CFD Simulation >

Running CONVERGE on Linux

Before starting a simulation, you need to set up the CONVERGE environment. There are two ways to do so: (1) loading a module or (2) running a script.

 

Option (1) utilizes Environment Modules to simplify the shell initialization process. The modules provided by Convergent Science include environment configuration for the CONVERGE solver and related utilities, the supported MPI libraries, and CONVERGE user-defined functions.

 

To set up your environment, load the module for the MPI library and CONVERGE version that you want to use. Table 3 below shows the module load commands for each MPI library (refer to Appendix A for related hardware recommendations). Beginning with CONVERGE 5.0.0, Convergent Science provides an Open MPI modulefile to run CONVERGE using an Open MPI setup. The INTEL setup for CONVERGE 4.0.0+ has some different settings from previous CONVERGE versions that allow CONVERGE to run faster in most cases. If you have issues running CONVERGE with the new INTEL setup, you can use the INTEL-COMPAT setup to run CONVERGE with the INTEL setup settings used in previous CONVERGE versions.

 

Table 3: Module load commands for each MPI library. Replace <version> with the version you want to run (e.g., 5.0.0).

MPI Library

Command

HPC-X

module load <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/modulefiles/CONVERGE/HPCX/<version>

INTEL

module load <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/modulefiles/CONVERGE/INTEL/<version>

INTEL_COMPAT

module load <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/modulefiles/CONVERGE/INTEL_COMPAT/<version>

MPICH

module load <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/modulefiles/CONVERGE/MPICH/<version>

Open MPI

module load <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/modulefiles/CONVERGE/OMPI/<version>

 

If your organization has its own MPI setup, enter the module load command for your organization's MPI environment immediately after the command from Table 3. This ensures that you will run CONVERGE using your organization's MPI configuration instead of the default MPI configuration provided with the CONVERGE installer.

 

For option (2), CONVERGE offers a script for each MPI library in the scripts subdirectory. The script sets environment variables for the CONVERGE solver and related utilities, the MPI library, and CONVERGE user-defined functions.

 

Run the appropriate script to set up your environment. Table 4 below shows the commands for each MPI library (refer to Appendix A for related hardware recommendations).

 

Table 4: Environment setup scripts for each MPI library. Replace <version> with the version you want to run (e.g., 5.0.0).

MPI Library

Command

HPC-X

source <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/scripts/CONVERGE/HPCX/<version>.sh

INTEL

source <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/scripts/CONVERGE/INTEL/<version>.sh

INTEL_COMPAT

source <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/scripts/CONVERGE/INTEL_COMPAT/<version>.sh

MPICH

source <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/scripts/CONVERGE/MPICH/<version>.sh

Open MPI

source <install_root>/Convergent_Science/CONVERGE_CFD/5.0.0/environment/x64/scripts/CONVERGE/OMPI/<version>.sh

 

The scripts in Table 4 include the default MPI configuration provided with the CONVERGE installer. If your organization has its own MPI setup, work with your IT team to determine the additional steps needed to use your organization's MPI configuration instead of the default MPI configuration.

 

When your environment setup is complete, navigate to your Case Directory and use the appropriate command to run CONVERGE. We recommend using the converge* script that will read your environment and automatically run the correct binary to run CONVERGE based on your environment setup. For unique environment setups, refer to the following sections for example commands for each of the four MPI libraries. You must use a supported MPI version when using the binaries directly.

 

CONVERGE accepts a number of command-line options. Note that you must use the appropriate command-line option ( --license super in CONVERGE 5.0.0) if you have a superbase solver license.