TELEMAC

The numerical simulation methods described on these pages use the freely available software open TELEMAC-MASCARET (in the following referred to as TELEMAC), which was started as a commercial code by the R&D group of Électricité de France (EDF). Since 2010, the TELEMAC-MASCARET Consortium took over the development (EDF R&D is still deeply involved) and freely provides the software and its source code under a GPLv3 license. Visit their website to learn more about TELEMAC.

Working on Debian Linux or one of its derivatives (see the chapter on Virtual Machines (VMs) and Linux) facilitates handling TELEMAC, because most of its core algorithms were originally developed on Linux platforms. Using Linux follow the TELEMAC installation chapter (account for approximately 2 hours for the installation).

General Introduction and Tutorial Guide

The analysis of hydro-environments with TELEMAC involves pre-processing for abstracting the fluvial landscape, setting up control files, running a TELEMAC solver, and post-processing. The first-time user faces an overwhelming number of software options for pre- and post-processing. Moreover, TELEMAC comes with a wide range of modules for two-dimensional (2d) and three-dimensional (3d) modeling of hydro-morphodynamic processes of various water bodies, from mountain rivers to coastal deltas under the influence of tides. Also, multiple sediment transport phenomena can be modeled and coupled with steady or unsteady flow conditions. Consequently, TELEMAC’s applications range is very wide and this eBook provides tutorials for a sound understanding of fundamental elements of river ecosystem modeling. To this end, this eBook features the following tutorials:

  • Generate a Selafin *.slf* geometry mesh along with boundary conditions with QGIS, the BASEmesh plugin, and BlueKenue in the pre-processing tutorial. Recommended as first introductory tutorial for beginners.

  • Setup a purely hydrodynamic, steady Telemac2d simulation in the steady 2d tutorial (Selafin *.slf* geometry). Recommended as a second tutorial for beginners.

  • Apply quasi-steady (near-census unsteady) flow conditions (e.g., important for modeling a flood hydrograph) in the unsteady Telemac2d tutorial. This tutorial builds on top of the steady Telemac2d tutorial.

  • Setup a purely hydrodynamic 3d model in the Telemac3d (Selafin) tutorial with the standard Selafin (*.slf) format.

  • Setup a purely hydrodynamic 3d model in the Telemac3d (MED and Salome) tutorial with the MED geometry format using SALOME-HYDRO. Recommended for experienced Linux users and when computational performance is critical.

  • Couple hydrodynamics (i.e., Telemac2d or Telemac3d) with morphodynamics (i.e., Sediment transport) in the Gaia tutorial.

The tutorials build on the user manuals provided by the TELEMAC developers at http://wiki.opentelemac.org.

Pre-processing

Pre-processing involves abstracting the river landscape into a computational mesh (grid) with boundary conditions. Many software tools can be used for this purpose such as:

  • QGIS and the BASEmesh plugin, which are illustrated in the QGIS pre-processing tutorial (the Author’s preferred choice).

  • The National Research Council Canada’s Blue Kenue GUI software (primarily for Windows).

  • SALOME-HYDRO for generating computational meshes in the MED files format (here illustrated in the Telemac3d tutorial).

Model Setup and Run

The centerpiece of any TELEMAC model is the control (steering or CAS) file, which can be set up with Fudaa PrePro. The model setup is explained in the above tutorial guide for TELEMAC.

Post-processing

Artelia Eau et Environnement created the PostTelemac plugin for QGIS, which is a powerful and convenient tool for visualizing and post-processing TELEMAC simulation results. The Telemac2d (steady) Post-processing illustrates the usage of the PostTelemac QGIS plugin (read more in the TELEMAC pre-processing tutorial) to create raster maps and other useful data derivatives from TELEMAC output. In addition, the Telemac3d (MED) tutorial features the usage of the ParaVis module (a ParaView derivative) in SALOME.

The TELEMAC File Structure

For any TELEMAC simulation, the following input files are mandatory:

There are many more files that are not computationally mandatory for every TELEMAC simulation, but essential for particular scenarios (e.g., unsteady flows) and modules (e.g., sediment transport with Gaia). Such optional files include:

  • Unsteady flow file (e.g., for water surface elevation or flow rates)

    • Requires a stage-discharge relationship file

    • File format: *.qsl

  • Friction data file

    • File format: *.tbl or *.txt (ASCII)

  • Restart / reference (for model validation) file

    • File format: .slf or .med

    • More information in the Telemac2d manual (section 4.1.3) (see also Hervouet et al. [HAG14]).

  • Sections file to set control sections (e.g., verify flow rates, velocity, or water surface elevation)

  • Sources (e.g., water or sediment) data file

  • Stage-discharge relation file

    • File format: *.tbl or *.txt (ASCII)

  • Zones files to describe reginal friction or other zonal properties

When hydraulic structures are integrated into a model, some of the following files are required (depending on the structure type):

  • Culverts data file

  • Weirs data file

In addition, a FORTRAN (.f) file can be created to specify special boundary conditions, custom algorithms, or the usage of either single or double precision.

Single and double precision

In hydro-morphodynamic modeling, single precision (i.e., 32-bit floats) rather than double precision (i.e., using 64-bit floats) is sufficient and much faster.

More input files can be defined to simulate oil spills, pollutant transport, wind, and tide effects.

Detailed File Descriptions

The Steering File (CAS)

The steering file is the main simulation file with information about mandatory files (e.g., the selafin geometry or the boundary), optional files, and simulation parameters. The steering file can be created or edited with a basic text editor or advanced software such as Fudaa PrePro or Blue Kenue.

Geometry Files (SLF or MED)

The geometry file in *.slf (selafin or SERAFIN) format contains binary data about the mesh with its nodes. The name format of the geometry file can be modified in the steering file with:

/steering.cas
GEOMETRY FILE            : 't2d_channel.slf'
GEOMETRY FILE FORMAT     : SLF / or MED with SALOME preferably for 3D

MED files are typically processed with either SALOME or ref}SALOME-HYDRO <salome-hydro>, which are featured in the Telemac3d (MED) tutorial.

Boundary Conditions (CLI or BND/BCD) and Liquid Boundary (QSL) Files

The boundary file in *.cli format contains information about inflow and outflow nodes (coordinates and IDs). The *.cli file can be opened and modified with any text editor, which is not recommended to avoid inconsistencies. Preferably use Fudaa PrePro or Blue Kenue for generating and/or modifying *.cli files (read more in the TELEMAC pre-processing tutorial). Here is an example (header only) for a *.cli boundary conditions file:

  2 2 2  0.000  0.000  0.000  0.000 2  0.000  0.000  0.000    101     1
  2 2 2  0.000  0.000  0.000  0.000 2  0.000  0.000  0.000    102     2
  2 2 2  0.000  0.000  0.000  0.000 2  0.000  0.000  0.000    103     3
  ...

*.bnd/*.bcd files can be created and edited either with SALOME-HYDRO or a text editor (read more in the Telemac3d (MED) tutorial). The following block box shows how a *.bnd boundary file for a simple block geometry may look like.

4
5 4 4 4 downstream
4 5 5 4 upstream
2 0 0 2 leftwall
2 0 0 2 rightwall

Users can define a liquid boundary conditions file (*.qsl) to define time-dependent (unsteady) boundary conditions (e.g., discharge, water depth, flow velocity, or tracers). The following block shows an example for a liquid boundary conditions (*.qsl) file:

# bc_unsteady.qsl
# Time-dependent inflow (discharge Q(2) and outflow (depth SL(1)
T           Q(1)     SL(2)
s           m3/s     m
0.            0.     5.0
500.        100.     5.0
5000.       150.     5.0

The boundary conditions and liquid boundary files can be added in the steering file with:

/steering.cas
BOUNDARY CONDITIONS FILE : 'bc_channel.cli'
LIQUID BOUNDARIES FILE   : 'bc_unsteady.qsl'

Stage-discharge (or WSE-Q) File (txt - ASCII)

Define a stage-discharge file to use a stage (water surface elevation WSE) - discharge relationship for boundary conditions. Such files typically apply to the downstream boundary of a model at control sections (e.g., a free overflow weir). The following block shows an example for a stage-discharge (*.txt) file:

# wse_Q.txt
#
Q(1)     Z(1)
m3/s     m
 50.     0.0
 60.     0.9
100.     1.5

To use a stage-discharge file, define the following keyword in the steering file:

/steering.cas
STAGE-DISCHARGE CURVES FILE : YES

Friction Data File (tbl/txt - ASCII)

This optional file enables the definition of bottom friction regarding the roughness law to use and associated function coefficients.

To activate and use friction data, define the following keywords in the steering file:

/steering.cas
FRICTION DATA            : YES
FRICTION DATA FILE       : 'friction.tbl'

The Results/Restart file (SLF or MED)

A restart file stems from a previous TELEMAC simulation and does not need to exist at the beginning. A good option for visualizing the results file is the PostTelemac plugin in QGIS. Restart files in MED format are typically processed with the ParaVis module in SALOME or ref}SALOME-HYDRO <salome-hydro>, which is featured in the Telemac3d (MED) tutorial.

The results/restart file can be define in the steering file as follows:

/steering.cas
RESULTS FILE             : 't2d_channel_output.slf'

The Telemac2d manual (section 4.1.3) provide more explanations on the usage of results/restart files (e.g., for speeding up simulations).