Getting Started Guide 4
Getting Started Guide 4
If you do not have root access privileges, you can install CONVERGE for a single user. If
you are logged in as root, you can install CONVERGE for all users.
The first time you install and run CONVERGE 4.x.x, complete the following steps:
Every time you upgrade to a new minor version (e.g., from CONVERGE 4.0.0 to
CONVERGE 4.1.0) or patched version (e.g., from CONVERGE 4.0.0 to CONVERGE 4.0.1),
complete the following steps:
Run the downloaded script to install the CONVERGE CFD software products using an
interactive installation process. The installer will prompt you for the installation root. By
default, CONVERGE is installed in the /opt/Convergent_Science/ directory. To install in a
different directory, specify that directory when prompted. You will then be prompted to
select the components that you will install. The available products for installation are:
CONVERGE*, CONVERGE Studio*, Examples, Tecplot for CONVERGE, and ParaView*
(mesa included). By default, all of the products will be selected. Selected products will
have an "X" next to the product name. You can select or deselect products by pressing the
product's menu id on your keyboard. You must select at least one product to install. After
you have finished your selection you may press "Enter" to move to the next prompt.
If you selected CONVERGE or ParaView, the next prompt will ask you to select which
MPI types you want the products to use. You must select at least one MPI type from the
available options. The MPI types the products may use are: HPC-X, Intel MPI, MPICH,
and a Limited OMPI.
You are not required to use one of the MPI packages that are included in the CONVERGE
CFD software installation package. You can use your own MPI implementation instead,
as long as you are using a supported version of HPC-X, Intel MPI, MPICH, or Open MPI.
The installer will prompt you to verify your selection before starting the installation.
As a reference, the installer will display the silent installation command that matches the
current CONVERGE CFD software product selection. The command shown can be used
to install the same product selection in future installs without going through the
interactive selection process.
arguments after the path to select specific products to install using the silent installation.
The command, [./CONVERGE_CFD_BUNDLE_4.0.0_linux_x64.sh /opt] will install
the CONVERGE CFD software products in the default directory and with the default
product selection. The available command options are shown in the table below.
Table 1: The command options that may be used for a silent installation.
Command options Description
/opt This is the installation directory. The default installation
directory is /opt. You can install the products into a
different directory by entering the desired directory name in
place of /opt. You must put the path before any other
command options.
--menu This option will launch the selection menus. This option will
override any other options listed. Issuing only the install
command without any options will also launch the selection
menus.
--silent This option will start the silent installation of CONVERGE
CFD products to the default directory. The only time this
option is needed is when no directory or product options are
given, which will install all products in the package to the
default directory. Issuing the install command with the
install directory will silently install all products to the given
install directory. You do not need to provide the '--silent'
option if you provide the install directory.
--converge This option will install the CONVERGE solver in the
specified directory.
--studio This option will install CONVERGE Studio in the specified
directory.
--examples This option will install the example cases files in the
specified directory.
--paraview The option will install ParaView and ParaView mesa in the
specified directory.
--tecplot This option will install Tecplot for CONVERGE in the
specified directory.
--mpi <mpi types> This option will specify which MPI types you want the
installed products to use. The compatible MPI types are HPC-
X, Intel MPI, MPICH, and limited OMPI. These can be
specified in a comma delimited list following the initial '--
mpi' option. For example: --mpi hpcx,mpich,ompi
The following options can be used to specify the MPI
types the products will use:
hpcx: Installed products will use HPC-X type.
intel: Installed products will use Intel MPI type.
mpich: Installed products will use MPICH type.
ompi: Installed products will use limited OMPI type.
The CONVERGE_CFD Bundle creates a file called .manifest during the installation process
in the Convergent_Science directory. The .manifest file contains information on the
installation and the products that were selected for download.
The installation package for the CONVERGE_CFD Bundle 4.0.0 was created using
"makeself". For documentation on "makeself", and command options that can be used
with the self-extracting shell file, visit [Link] If the local system does not
have sufficient space to unpack the software to temp drive, then you can set another
directory as the temporary to unpack the software by using --target <dir>. For
example, [package_bundle.sh --target <extract_dir> --
<package_install_dir>] will set extract_dir as the temporary directory to unpack the
software to.
Double-click on the *.exe file to begin the installation. The name of the file is
CONVERGE_CFD_Bundle_4.0.0_win64.exe. You must have administrative access to
proceed.
You will be prompted to select which CONVERGE CFD software products you will
install. The available products for installation are: CONVERGE*, CONVERGE Studio*,
Examples, and Tecplot for CONVERGE. You may also choose which MPI type(s) you
want the installed products to use. The available MPI types are Intel MPI and Microsoft
MPI.
When the installation is complete, you can safely delete the *.exe file.
If you installed CONVERGE or the license server, a [Link] file was placed in the
license subdirectory of the installation directory. You must replace this file with a valid
[Link] file obtained from Convergent Science. To obtain a valid [Link] file, contact
licensing@[Link] with the hostname and the MAC address of the server (for
floating licenses) or all the machines (for node-locked licenses) that will run CONVERGE.
Table 2: Obtaining the hostname and MAC address for your machine.
Operating Steps to look up hostname Steps to look up MAC address
System
Windows Go to the command prompt and type Go to the command prompt and type
ipconfig /all ipconfig /all
The hostname is the item next to Host The MAC address is the item next to
Name in the Windows IP configuration Physical Address in your adapter
section. section.
Linux Go to the terminal and type Go to the terminal and type
hostname ip addr
The terminal will write out the The MAC address is the value next to
hostname. link/ether.
Before CONVERGE will run, it needs to check out a license from the license manager. The
license manager runs constantly on a server and listens for requests for licenses from
processes on the network. The license manager keeps track of how many licenses are
checked out and how many are still available.
The license manager provided with CONVERGE is the Reprise License Manager (RLM)
developed by Reprise Software, Inc. For full documentation on RLM, refer to their website
at [Link]
The last step in the license manager installation is the creation of a script named rlmd for
starting up the RLM server daemon automatically when the machine boots. If you choose
to create the rlmd script, the installation procedure will prompt for a user name under
whose account the license manager will start when the computer boots up. Enter a valid
user name under which RLM can be run. Even though root is a valid user name, it is not
necessary for the license manager to be run as root.
The RLM license manager is not included in the CONVERGE installation package. It is
available for separate download from the Convergent Science Hub
([Link]
rlm &
When started, RLM will look for any files named *.lic that reside in the same directory.
During the install procedure, a soft link to the [Link] file in the license directory was
created, so RLM will see the license file. The [Link] file provided by Convergent Science
indicates that the vendor-specific settings file named [Link] will also be used to handle the
licensing. Once RLM starts and sees the valid [Link] file, it will use the [Link] to launch
a second rlm daemon as well. If you run the ps command to see what processes are
running, you should see two instances of rlm.
Some license server error codes that you may encounter when launching the client, with
some potential solutions are listed in the License Server Errors section.
You must verify that the [Link] file is saved in the same directory as your [Link] file
( /<installation_directory>/<architecture>/rlm ). You can download the [Link] file from the
Convergent Science Hub ([Link] Note that a login is
required.
1. Pre-processing (preparing the surface geometry and configuring the input and data
files)
2. Running the simulation
3. Post-processing (analyzing the *.out ASCII files and using a visualization program to
view the information in the post*.h5 binary files)
We recommend using CONVERGE Studio for pre-processing. This chapter describes how
to run a simulation and troubleshoot errors (step 2).
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). Note that
Convergent Science does not provide an Open MPI modulefile for CONVERGE 4.0.0. You
can still use your own Open MPI setup with CONVERGE 4.0.0. Beginning wit
CONVERGE 4.0.0, the INTEL setup has some different setings 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., 4.0.0).
MPI Library Command
HPC-X module load <install_root>/Convergent_Science/CONVERGE_CFD/4.
0.0/environment/x64/modulefiles/CONVERGE/CONVERGE-
HPCX/<version>
INTEL module load <install_root>/Convergent_Science/CONVERGE_CFD/4.
0.0/environment/x64/modulefiles/CONVERGE/converge-
intel/<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). Note that Convergent Science does not provide a script for Open MPI
for CONVERGE 4.0.0. You can still use your own Open MPI setup with CONVERGE
4.0.0.
Table 4: Environment setup scripts for each MPI library. Replace <version> with the version you
want to run (e.g., 4.0.0).
MPI Library Command
HPC-X source <install_root>/Convergent_Science/CONVERGE_CFD/4.0.0/e
nvironment/x64/scripts/CONVERGE/CONVERGE-HPCX/<version>.sh
INTEL source <install_root>/Convergent_Science/CONVERGE_CFD/4.0.0/e
nvironment/x64/scripts/CONVERGE/converge-intel/<version>.sh
INTEL_COMP source <install_root>/Convergent_Science/CONVERGE_CFD/4.0.0/e
AT nvironment/x64/scripts/CONVERGE/converge-
intel_compat/<version>.sh
MPICH source <install_root>/Convergent_Science/CONVERGE_CFD/4.0.0/e
nvironment/x64/scripts/CONVERGE/CONVERGE-MPICH/<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. Refer to the following sections for example
commands for each of the four MPI libraries. You must use a supported MPI version.
CONVERGE accepts a number of command-line options. Note that you must use the
appropriate command-line option ( --license super in CONVERGE 4.0.0) if you have a
superbase solver license.
The -x arguments are necessary to export the required environment variables to the
remote nodes.
For example, the command to run CONVERGE on 4 nodes with 4 processing cores per
node is
In practice, however, a few things should be added to the mpirun command line to make it
more practical. To write the output to a file and start the job in the background, use
The redirect of the /dev/null is recommended by Intel MPI to avoid some warnings that
would otherwise be sent to stdout.
For example, to start a job on four processing cores you would type
mpirun -n 4 converge-mpich
In practice, however, a few things should be added to the mpirun command line to make it
more practical. To write the output to a file and start the job in the background, use
The redirect of the /dev/null is recommended by MPICH to avoid some warnings that
would otherwise be sent to stdout.
The -x arguments are necessary to export the required environment variables to the
remote nodes.
By default, CONVERGE uses the MPI environment configuration that is included in the
CONVERGE installation package. If your organization has its own MPI setup, we
recommend using that instead. To do so, prepend the path to your organization's MPI
environment files to the Path environment variable. You can edit environment variables in
the Control Panel.
CONVERGE accepts a number of command-line options. Note that you must use the
appropriate command-line option ( --license super in CONVERGE 4.0.0) if you have a
superbase solver license.
[Link]
to run the Intel MPI setup script using PowerShell. Then, enter
For example, to run CONVERGE 4.0.0 on 4 nodes with 4 processing cores per node, you
would type
Each version has a slightly different set of options and arguments, as detailed in Tables 5-
7.
You can also force CONVERGE to write a restart file by placing an empty file called
RESTART in the Case Directory. To create this file from the command line, navigate to the
Case Directory and type
or
Upon reading the empty file, CONVERGE will write a restart*.rst file at the end of the
current time-step and then delete the empty file.
To restart a simulation, copy the desired restart*.rst file to [Link] and set
simulation_control > restart_flag = 1 in [Link], then run the code as you normally do. In
CONVERGE 4.0.0, be sure to save [Link] in the root Case Directory instead of the
outputs_* directory. If a file named [Link] does not exist, CONVERGE will use the
restart file with the highest number.
The results from a restarted simulation might not exactly match the results from the
original run. Some of the physical models incorporate random number elements that are
not replicated in a restart case. These variations will be consistent with using a different
random seed for the same set of inputs.
For simulations using Adaptive Mesh Refinement (AMR), CONVERGE recreates the AMR
embedding at the beginning of a restart. To ensure that the new AMR embedding matches
exactly the AMR embedding from before the restart, CONVERGE saves the AMR
embedding information to the restart file.
Figure 1 below shows an example of the output. If the restart file is incomplete (for
example, if the simulation crashed while the file was being written), this command returns
an error.
HDF5 "[Link]" {
ATTRIBUTE "TIME_STEP" {
DATATYPE H5T_IEEE_F64LE
DATASPACE SIMPLE { ( 1 ) / ( 1 ) }
DATA {
(0): 0.0101109
}
}
}
Figure 1: Example h5dump output. Here, the [Link] file was written at a simulation time of
0.0101109 s.
or
in your Case Directory to create an empty STOP file. You can then see exactly what was
happening in the flow at the time-step where you stopped the simulation, edit the input
files if you wish, and restart your job as described above.
or
in your Case Directory to create an empty OUTPUT file. You can then see exactly what
was happening in the flow at the time-step where you generated the post files.
or
in your Case Directory to create an empty RESTART file. This allows you to force
CONVERGE to write a restart file at the end of the current time-step even when the time-
step is not lined up with the twrite_restart specification.
error while loading CONVERGE cannot find the user- Ensure that the UDF has been
shared libraries: defined function (UDF) library at built and that
libconverge_udf.so:
cannot open shared
runtime. LD_LIBRARY_PATH contains the
object file: no such path to the UDF library. Refer to
file or directory the CONVERGE UDF Manual for
more information about building
UDFs.
Simulation Warnings
CONVERGE generates warnings during runtime. Unlike errors, warnings do not
terminate the simulation. A warning usually indicates that the inputs you supplied to
CONVERGE are not typical for that type of simulation. Examples of warnings are:
Simulation Errors
Simulation errors usually cause the simulation to crash. Table 7 below lists common types
of these errors and gives examples for each type.
If you see the following error when you launch a job on RLM
you must verify that the [Link] file exists in the same directory as your [Link] file. You
can download the [Link] file from the Convergent Science Hub
([Link] Note that a login is required.
· For Windows systems, if CONVERGE Studio does not open, edit the Path environment
variable on your machine.
1. Open the system control panel and type env in the search bar.
2. Choose Edit the system environment variables.
3. In the System Properties dialog box, go to Advanced and click the Environment
variables... button.
4. In the Environment Variables dialog box, under System variables, select the Path
variable. Then click the Edit... button.
5. Find the path to your installed CONVERGE Studio executable (e.g., C:\Program
Files\Convergent_Science\CONVERGE_Studio\v4.0.0) and click the Move Up
button on the right side of the Edit environment variable dialog box until this path is
at the top of the list. Click OK to exit the Edit environment variable dialog box.
6. Click OK to exit the Environment Variables dialog box.
7. Click Apply then OK to exit the System Properties dialog box.
8. Launch CONVERGE Studio.
· For Windows systems, if CONVERGE Studio 4.0.0 crashes when you try to create a new
case, your machine might be missing OpenGL 3.3+ support. Work with your IT team to
install NVIDIA graphics drivers with OpenGL 3.3+ support.
· For Linux systems, if CONVERGE Studio 4.0.0 crashes immediately after launch, use the
qtconfig or qtconfig-qt4 command to update the GUI style for rendering Qt
applications under Appearance and then click File > Save. We recommend Cleanlooks or
Plastique.
· For Windows systems, if you are unable to import [Link], it is most likely because
your computer does not use a period as the decimal separator. We recommend changing
your region format as follows:
If you want to keep your current format for dates, times, or other elements, you can
click Additional settings... to customize the behavior. You must use a period (.) as the
Decimal symbol. If you modify other settings, we recommend evaluating their impact on
CONVERGE Studio.
· For Windows systems, if you have an unwanted clipping plane and if all edges are
rendered in the boundary fence color, the solution is as follows.
3. Run CONVERGE Studio with the -n command line option. Check the CONVERGE
Studio Message log to verify that CONVERGE Studio is using the OpenGL
rendering method.
· For both Linux and Windows systems, to use the boundary animation feature and to
enable faster rendering, you must have a discrete GPU from NVIDIA or AMD. If your
hardware meets our requirements and if the device driver works correctly, you can
verify that fast rendering is activated by checking the CONVERGE Studio Message log.
You should see the following messages after CONVERGE Studio starts a new
document. The OpenGL line will indicate which rendering method you are using:
--------------------------------------------------------------------------------
CONVERGE Studio v4.0.0 Dec 21 2023 [Link]
CONVERGE Studio uses QT 5.12.X
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
OpenGL: using GLSL to render triangles, edges and normals (the fastest method).
--------------------------------------------------------------------------------
If CONVERGE Studio is using the old rendering, you will see the following message:
--------------------------------------------------------------------------------
CONVERGE Studio v4.0.0 Dec 21 2023 [Link]
CONVERGE Studio uses QT 5.12.X
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
OpenGL: using old rendering methods (deprecated GL calls).
--------------------------------------------------------------------------------
· In Linux, CONVERGE Studio defaults to fast rendering. If your machine does not meet
the hardware requirement, CONVERGE Studio 4.0.0 will use the old rendering. To force
CONVERGE Studio 4.0.0 to use the old rendering, use the -o command line option.
· You may see the warning "missing libicui18n dynamic library" when launching
CONVERGE Studio 4.0.0 on RedHat (CentOS) 7.x. However, this warning should not
affect the functionality of CONVERGE Studio.
· Many newer Linux operating systems upgrade to gstreamer 1.0 instead of 0.1, which is
the required version for CONVERGE Studio 4.0.0. It is much easier to install gstreamer
0.1 on newer systems compared to installing gstreamer 1.0 on older systems. If your
system does not install gstreamer 0.1 by default, you can manually install it.
o For OpenSUSE, you can find rpm packages from
[Link]
o For Ubuntu 18.10, use the following steps:
§ wget [Link]
base0.10/libgstreamer-plugins-base0.10-0_0.10.36-1_amd64.deb
§ wget [Link]
gstreamer0.10-0_0.10.36-1.5ubuntu1_amd64.deb
§ sudo dpkg -i libgstreamer*.deb
Please ask your IT department to install gstreamer 0.1 or use an older Linux system,
which provides it by default.
Table 9: Operating system versions compatible with CONVERGE and CONVERGE Studio.
Operating System CONVERGE 4.0.0 CONVERGE Studio
4.0.0
Windows Server 2003+
Windows 10+ 8+
SLED 12+* 11+
RHEL 7.0+ 7.0+
Ubuntu 13.04+* 10.04+
CONVERGE 4.0.0 supports any hardware architecture that uses the x86-64 instruction
set. CONVERGE is designed for consumer-class hardware and does not use enterprise-
class additions to that instruction set. Contact the Convergent Science Applications team
to discuss processor selection.
below. Set the mpi_control > io_hints_filename parameter in [Link] to the name of this
file. Refer to the CONVERGE Manual for more information about [Link].
romio_no_indep_rw true
cb_nodes 1
Figure 5: Example MPI hint file for CIFS.
For optimal geometry rendering, run CONVERGE Studio on a machine with OpenGL-
compatible video drivers (3.3+). Refer to the CONVERGE Studio Manual for more
information about command line options for CONVERGE Studio.
Table 11 below lists the MPI (Message Passaging Interface) support packages that can be
used to execute the solver in parallel. Other MPI packages are not supported.
Earlier versions of HPC-X, Intel MPI, MPICH, MS-MPI, and Open MPI are not supported.
CONVERGE does not check out a license when you run this utility.
For high-speed interconnects like InfiniBand and Omni-Path, we have seen latencies
ranging from about 2 µs to 25 µs. These numbers are highly dependent on system
configuration. If a high-speed interconnect is available for your system and your latency is
higher than you expect, it is possible that the MPI library is not configured to use the high-
speed interconnect. Work with your IT team to check your MPI setup.
Do I have to use one of the MPI packages that was installed with the CONVERGE
4.x.x solver?
No. We include MPI packages in the CONVERGE 4.x.x installer only for convenience. If
your IT team has set up their own MPI package in a supported version, we recommend
using that instead. To do so on Linux, load the module for your organization's MPI
environment immediately after loading the CONVERGE module. To do so on Windows,
prepend the path to your organization's MPI environment files to the Path environment
variable.
Can I copy the CONVERGE executable from the installation package to a different
directory (on Linux) without running the CONVERGE_CFD Bundle script?
No. To install CONVERGE 4.x.x on Linux, you must run the CONVERGE_CFD Bundle
script.
In CONVERGE 4.x.x, you do not need to copy or link the CONVERGE executable to your
Case Directory when you run a simulation. Instead, you set up your environment so that
the executable can be run from any directory.
You may use GT-SUITE to model Flow, FSI, or CHT coupling at a boundary. The
compatibility between CONVERGE and GT-SUITE versions are listed below in Table 13.