Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • otm/telemac-mascaret
1 result
Show changes
Commits on Source (75)
Hide whitespace changes
Inline Side-by-side
Showing
with 394 additions and 82 deletions
NEWS.txt
View file @ ef067927
Latest changes
==============
PYTHON: major improvement of the merge functionnality from run_telfile.py
regarding performance and memory consumption.
HERMES: huge speedup when reading and writing large SELAFIN files.
PYTHON: add a new "timeit" decorator to benchmark a Python function using a
performance counter.
TELEMAC-2D: fix the initialisation of work arrays to 0 before calling VECTOR
for a few subroutines
TELEMAC-3D: fix the initialisation of work arrays to 0 before calling VECTOR
for a few subroutines
GRETEL: fix date and time not written in the 3D result file in parallel
GAIA: fix the index of the EBOR%ADR table given as input to the BEDLOAD_EVOL
subroutine in bedload_main.f because this table is filled with NSICLA and not
NSAND.
PYTHON: several fixes to TelemacFile
- The nplan property now uses the same convention as in Fortran and therefore
returns 0 for a 2D mesh instead of 1.
- The ipobo array is now correctly read from a SELAFIN file even if no
boundary condition file has been given to the constructor.
TELEMAC-2D: new default value for ACCURACY FOR DIFFUSION OF TRACERS = 1.E-8
like in TELEMAC-3D (old default = 1.E-6)
TELEMAC-2D: new default value for SCHEME FOR ADVECTION OF TRACERS = 13 (NERD)
and 3rd component of TYPE OF ADVECTION (for tracers) to have a mass-conservative
advection scheme which works with tidal flats
(old choice = 1 i.e. characteristics)
TELEMAC-2D/TELEMAC-3D: new default value for TREATMENT OF NEGATIVE DEPTHS
= 2 (flux control) to always have positive depths, old default = 1 (smoothing)
Mandatory options to use this choice are now automatically set with a
warning message if using this new default choice
PYTHON: fix the calculation of normals and tangents in polyline_integrals,
which was not carried out properly for each segment.
PYTHON: fix generate_atm.py for v8p5 name conventions
BIEF: MUMPS is no longer limited to versions 4.10 and 5.2.1. The warning
is now only displayed for versions lower than 4.10.
TELEMAC-3D: fix index error to clip rain temperature
TELEMAC-3D: fix if 3 subdomains join at the same node on a solid boundary
in parallel
TELEMAC-2D: Deleted boolean keywords, features activated by files
- COMPUTATION CONTINUED (when PREVIOUS COMPUTATION FILE)
- VALIDATION (when REFERENCE FILE)
- RESTART MODE (when RESTART FILE)
- OIL SPILL MODEL (when OIL SPILL STEERING FILE)
- FLUXLINE (when FLUXLINE INPUT FILE)
- BREACH (when BREACHES DATA FILE)
- VELOCITY FOR DELWAQ (when VELOCITY DELWAQ FILE)
- DIFFUSIVITY FOR DELWAQ (when DIFFUSIVITY DELWAQ FILE)
- TEMPERATURE FOR DELWAQ (when TEMPERATURE DELWAQ FILE)
- SALINITY FOR DELWAQ (when SALINITY DELWAQ FILE)
TELEMAC-3D: Deleted boolean keywords, features activated by files
- COMPUTATION CONTINUED (when PREVIOUS COMPUTATION FILE)
- 2D CONTINUATION (when FILE FOR 2D CONTINUATION)
- VALIDATION (when REFERENCE FILE)
- RESTART MODE (when RESTART FILE)
- OIL SPILL MODEL (when OIL SPILL STEERING FILE)
- VELOCITY FOR DELWAQ (when VELOCITY DELWAQ FILE)
- DIFFUSION FOR DELWAQ (when DIFFUSIVITY DELWAQ FILE)
- TEMPERATURE FOR DELWAQ (when TEMPERATURE DELWAQ FILE)
- SALINITY FOR DELWAQ (when SALINITY DELWAQ FILE)
GAIA: Deleted boolean keywords, features activated by files
- COMPUTATION CONTINUED (PREVIOUS SEDIMENTOLOGICAL COMPUTATION FILE)
- VALIDATION (when REFERENCE FILE)
- RESTART MODE (when RESTART FILE)
- FLUXLINE (when FLUXLINE INPUT FILE)
WAQTEL/KHIONE: Deleted keyword:
- VALIDATION
TELEMAC-3D: new default vertical turbulence model: Nezu & Nakagawa model
(mixing length) rather than old constant viscosity
and default mixing length model is Nezu & Nagawa = 3 (old = Prandtl = 1)
TELEMAC-2D/TELEMAC-3D: same default values for 2 keywords
LATITUDE OF ORIGIN POINT and SPATIAL PROJECTION TYPE in 2D and 3D
TELEMAC-3D: change the dimension of keyword SUPG OPTION
1 single integer replaces the previous 4 integer array (default = 1)
as only the 1st component was used
TOMAWAC: Provide a unique file to read water depth AND current.
This unique file is the one defined by CURRENT FILE keyword.
TOMAWAC: Correct the water depth at the initialisation of a hotstart in
case TELEMAC-2D would provide a water depth null in its file.
TELEMAC-2D: fix use of work arrays in preres_telemac2d to store celerity and
free surface rather than FU and FV as preres_telemac2d is called early in the
time loop when coupling with GAIA
TELEMAC-3D: wrong tests when coupling with GAIA with a 3rd module
TELEMAC-2D FV / GAIA: fix erosion and deposition source terms
TELEMAC-2D: fix initialization of YASMO variable in prosou
......
configs/systel.edf.cfg
View file @ ef067927
......@@ -56,13 +56,7 @@ libs_med: -lm -L$MEDHOME/lib -lmed
#
incs_mumps: -I$MUMPSHOME/include
flags_mumps: -DHAVE_MUMPS
libs_mumps: -L$MUMPSHOME/lib -ldmumps -lmumps_common -lpord
-L$SCALAPACKHOME/lib -lscalapack
-lblas
libs_mumps_mkl: -L$MUMPSHOME/lib -ldmumps -lmumps_common -lpord
-lmkl_scalapack_lp64 -lmkl_blacs_intelmpi_lp64
-lmkl_intel_lp64 -lmkl_intel_thread -lmkl_core -lmkl_def
-lpthread -lm -ldl
libs_mumps: -L$MUMPSHOME/lib -ldmumps
#
# AED info
#
......@@ -320,6 +314,7 @@ obj_flags: -O2 -fPIC [fflags_intel] [flags_mpi] [flags_med] [flags_mumps] [flags
lib_flags: -fPIC -shared [fflags_intel]
#
exe_flags: -fPIC
fc: mpiifort
cmd_lib: [fc] [lib_flags] -o <libname> <objs>
#
cmd_obj_c: icc -c [cflags] <srcName> -o <objName>
......@@ -344,6 +339,7 @@ obj_flags: -O0 -fPIC [fflags_intel] [fflags_debug_intel] [flags_mpi] [flags_med]
lib_flags: -fPIC -shared [fflags_intel] -g
#
exe_flags: -fPIC [fflags_debug_intel]
fc: mpiifort
cmd_lib: [fc] [lib_flags] -o <libname> <objs>
#
cmd_obj_c: icc -c [cflags] <srcName> -o <objName>
......@@ -468,10 +464,10 @@ hpc_runcode: [hpc_runcode_edf]
obj_flags: -O2 -fPIC [fflags_intel] [flags_mpi] [flags_med] [flags_mumps] [flags_aed] [flags_gotm]
lib_flags: -fPIC -shared -qopenmp [fflags_intel]
#
fc: mpiifort
exe_flags: -fPIC -qopenmp
cmd_lib: [fc] [lib_flags] -o <libname> <objs>
#
libs_all: [libs_mumps_mkl] [libs_med] [libs_metis] [libs_aed] [libs_gotm]
cmd_obj_c: icc -c [cflags] <srcName> -o <objName>
cflags: -fPIC
#
......@@ -493,10 +489,10 @@ hpc_runcode: [hpc_runcode_edf]
obj_flags: -O0 -fPIC [fflags_intel] [fflags_debug_intel] [flags_mpi] [flags_med] [flags_mumps] [flags_aed] [flags_gotm]
lib_flags: -fPIC -shared -qopenmp [fflags_intel] -g
#
fc: mpiifort
exe_flags: -fPIC [fflags_debug_intel] -qopenmp
cmd_lib: [fc] [lib_flags] -o <libname> <objs>
#
libs_all: [libs_mumps_mkl] [libs_med] [libs_metis] [libs_aed] [libs_gotm]
cmd_obj_c: icc -c [cflags] <srcName> -o <objName>
cflags: -fPIC
#
......
documentation/artemis/user/latex/corpus.tex
View file @ ef067927
......@@ -2519,10 +2519,29 @@ trigonometrically and then the islands in the opposite direction.
The following values are given for each point:
LIHBOR, LIUBOR, LIVBOR, HBOR, UBOR, VBOR, AUBOR, LITBOR, TBOR, ATBOR, BTOR, N, K
LIHBOR, LIUBOR, LIVBOR, HB, TETAP, ALFAP, RP, LITBOR, TBOR, ATBOR, BTOR, N, K
LIHBOR is the code for the type of boundary. It is described in {\S} 6.1.
HB is the incident wave height.
TETAP is the angle of incident wave attack with respect to outward normal,
expressed in degrees in the clockwise direction. It should be noted that the
sign of this value is of no importance, since it only appears in the
calculation in cosine form.
ALFAP is the value of the phase shift produced by the wall (positive if the
reflected wave is delayed in relation to the incident wave), expressed in
degrees.
If ALFAP~=~0., the coefficient RP corresponds exactly to the definition of the
reflection coefficient, i.e.\ H$_{total}$ = H$_{incident}$ (1 + RP).
RP is the reflection coefficient (between 0. and 1., 1. corresponding to a
perfectly reflecting wall and 0. to a completely absorbing wall).
If wanting to use TETAP and ALFAP, codes for LIUBOR and LIVBOR have to be set to
5 (KENT) or 6 (KENTU), i.e. prescribed values, otherwise they are reset to 0.
N represents the general number of the edge point.
K represents the point number in the edge point numbering system.
......@@ -2578,7 +2597,11 @@ It must be stressed that in the case of a solid, the user must estimate
beforehand and as well as possible the angle of incident wave (or of main
incident wave constituent), even if this value is calculated by \artemis{}.
All the characteristics of the wall are determined in the subroutine BORH\@. The
All the characteristics of the wall are determined in the subroutine BORH\@.
Since release 7.3, they can also be directly defined in the
\telkey{BOUNDARY CONDITIONS FILE}.
Anyway, modifications in BORH subroutine have priority to information contained
in the \telkey{BOUNDARY CONDITIONS FILE}. The
values of the following parameters are specified for each solid boundary
(identified by the number of the boundary nodes):
......@@ -2598,7 +2621,12 @@ values of the following parameters are specified for each solid boundary
H${}_{incidente}$ (1 + RP).
\end{itemize}
In the absence of any special programming in BORH, solid walls are all
If only defined in the \telkey{BOUNDARY CONDITIONS FILE}, in order to take TETAP
and ALFAP into account, codes for LIUBOR and LIVBOR have to be set to 5 (KENT)
or 6 (KENTU), i.e. prescribed values.
Otherwise, TETAP and ALFAP values are reset to 0.
Besides, in the absence of any special programming in BORH, solid walls are all
considered as being perfectly reflecting and do not produce any phase shift
(RP=1, TETAP=ALFAP=0).
......
documentation/data/biblio.bib
View file @ ef067927
......@@ -4662,3 +4662,14 @@ year = {1984}
doi = {10.21957/15dz0m2t},
}
@InProceedings{Stadler2015,
author = {Stadler, L.},
title = {Calculating correct water and sediment fluxes in TELEMAC2D and SISYPHE},
booktitle = {XXII TELEMAC-MASCARET User Conference},
year = {2015},
editor = {Moulinec, C. and Emerson, D.~R.},
pages = {107--112},
month = {October 13-16},
address = {UK},
organization = {STFC Daresbury Laboratory}
}
documentation/gaia/user/latex/1-IntroductionGaia.tex
View file @ ef067927
......@@ -148,9 +148,16 @@ For the current version of \gaia{}, the decoupled approach is implemented.
\end{itemize}
For a \textit{hotstart} from a fully developed hydrodynamic, the following information must be included in the \telemac{2D} or \telemac{3D} steering files:
\begin{itemize}
\item \telkey{COMPUTATION CONTINUED} (logical type, set to {\ttfamily = NO} by default)
%\item \telkey{COMPUTATION CONTINUED} (logical type, set to {\ttfamily = NO} by default)
\item the keyword \telkey{PREVIOUS COMPUTATION FILE} with the file name
providing initial conditions.
\end{itemize}
The file name is provided with the keyword \telkey{PREVIOUS COMPUTATION FILE}. Optionally, \telkey{INITIAL TIME SET TO ZERO} (logical type, set to {\ttfamily = NO} by default).
Since release 9.0, if this file is present in the steering file, the
continuation step is automatically activated without setting the keyword
\telkey{COMPUTATION CONTINUED} (which has been deleted).
Optionally, give \telkey{INITIAL TIME SET TO ZERO} (logical type, set to
{\ttfamily = NO} by default).
The time step used for morphodynamic computation is the same used for hydrodynamics. It is specified in the \telemac{2D} or \telemac{3D} steering file. For suspended load, the advection-diffusion equation obeys the same Courant number criteria on the time step as the hydrodynamics, and therefore needs to be solved at each time-step. Typically the morphodynamic scale induced by bed load is much smaller, than the hydrodynamic scale. This leads to very small bed level changes in a hydrodynamic time step.
......
documentation/gaia/user/latex/3_1-SedimentTransportProcessesBedAndStratigraphy_bedload.tex
View file @ ef067927
......@@ -604,11 +604,16 @@ The sediment discharge is the mass of sedimentary material, both particulate and
\subsection{Useful graphical printouts for continuing a computation}
%-------------------------------------------------------------------------------
As for the module \telemac{2D}, in \gaia{} it is possible to continue a computation, taking a time step of a previous computation, on the same mesh as initial state.
As well as for the hydrodynamic part, it is necessary to declare two keywords in the steering file:
As well as for the hydrodynamic part, it is necessary to declare the following
keyword in the steering file:
\begin{enumerate}
\item \telkey{COMPUTATION CONTINUED}, which must be set equal to YES
%\item \telkey{COMPUTATION CONTINUED}, which must be set equal to YES
\item \telkey{PREVIOUS SEDIMENTOLOGICAL COMPUTATION FILE}, to give the name of the file that will supply the initial state.
\end{enumerate}
Since release 9.0, if this file is present in the steering file, the
continuation step is automatically activated without setting the keyword
\telkey{COMPUTATION CONTINUED} (which has been deleted).
When continuing a computation it is important that the previous sedimentological computation file contains the appropriate variables in order to properly continue the computation. Below some advices are introduced:
\begin{WarningBlock}{Note:}
......
documentation/gaia/user/latex/HowTos.tex
View file @ ef067927
......@@ -210,7 +210,6 @@ GAIA STEERING FILE = 'run_bifurcation_gai.cas'
/ INITIAL CONDITIONS
/---------------------------------------------------------------------
/
COMPUTATION CONTINUED = YES
PREVIOUS COMPUTATION FILE = 'res_bifurcation_hotstart_tel.slf'
...
\end{lstlisting}
......@@ -291,7 +290,13 @@ Similarly, the keyword \telkey{LISTING PRINTOUT PERIOD} (integer type, {\ttfamil
%-------------------------------------------------------------------------------
\section{Compute sediment fluxes through a given section(s)}
%-------------------------------------------------------------------------------
Use the keywords {\ttfamily FLUXLINE} (logical type, set to {\ttfamily NO} by default) and {\ttfamily FLUXLINE INPUT FILE} (character type).
%Use the keywords {\ttfamily FLUXLINE} (logical type, set to {\ttfamily NO} by default) and {\ttfamily FLUXLINE INPUT FILE} (character type).
Use the keyword {\ttfamily FLUXLINE INPUT FILE} (character type).
Since release 9.0, if this file is present in the steering file, the computation
of fluxes over lines with the FLUXLINE method is automatically done without
activating the keyword \telkey{FLUXLINE} (which has been deleted).
The format of the {\ttfamily FLUXLINE INPUT FILE} includes (see Figure~\ref{fig:fluxline_example}):
\begin{itemize}
......@@ -678,6 +683,8 @@ single precision format.
The first approach is described here below.
By default, as for \telemac{2D} or \telemac{3D}, \gaia reads the last record of
the previous computation result file.
The result file must contain the sediment masses in the bed or they can be
retreived using the ratios, porosity and thickness.
Using the keyword \telkey{RECORD NUMBER FOR RESTART} allows specifying
the number of the iteration to be read (default = -1 means the last record is
taken).
......@@ -693,15 +700,21 @@ If some variables are missing from the continuation file,
they are then fixed automatically at zero.
In order to use the continuation file, it is necessary to enter
two keywords in the steering file:
%two keywords in the steering file:
the keyword \telkey{PREVIOUS SEDIMENTOLOGICAL COMPUTATION FILE} with
the name of the file that will supply the initial state.
\begin{itemize}
\item The keyword \telkey{COMPUTATION CONTINUED} must have the value YES
(default value = NO),
%\begin{itemize}
%\item The keyword \telkey{COMPUTATION CONTINUED} must have the value YES
%(default value = NO),
%
%\item The keyword \telkey{PREVIOUS SEDIMENTOLOGICAL COMPUTATION FILE} must
%provide the name of the file that will supply the initial state.
%\end{itemize}
\item The keyword \telkey{PREVIOUS SEDIMENTOLOGICAL COMPUTATION FILE} must
provide the name of the file that will supply the initial state.
\end{itemize}
Since release 9.0, if this file is present in the steering file, the
continuation step is automatically activated without setting the keyword
\telkey{COMPUTATION CONTINUED} (which has been deleted).
N.B.: the mesh for which the results are computed must be exactly the same
as the one to be used in continuing the computation.
......@@ -725,11 +738,19 @@ files (or MED format) for the keyword \telkey{RESTART FILE FORMAT}
(default = SERAFIND):
\begin{itemize}
\item In the first computation, the keyword \telkey{RESTART MODE} is set to
YES (default = NO),
which generates a specific file containing the full information at one or a
%\item In the first computation, the keyword \telkey{RESTART MODE} is set to
%YES (default = NO),
%which generates a specific file containing the full information at one or a
%few time step(s) of the simulation.
%The name of this file is given by the keyword \telkey{RESTART FILE},
\item In the first computation, the name of the \telkey{RESTART FILE} is to be
given.
It then generates a specific file containing the full information at one or a
few time step(s) of the simulation.
The name of this file is given by the keyword \telkey{RESTART FILE},
Since release 9.0, if this file is present in the steering file, the writing
of this file is automatically done without activating the keyword
\telkey{RESTART MODE} (which has been deleted),
\item In the second computation, this specific file must be used as
\telkey{PREVIOUS SEDIMENTOLOGICAL COMPUTATION FILE} specifying the
......
documentation/telemac2d/user/graphics/fluxline_example.png 0 → 100644
View file @ ef067927
documentation/telemac2d/user/graphics/fluxline_example.png

260 KiB

documentation/telemac2d/user/latex/appendix4.tex
View file @ ef067927
......@@ -9,19 +9,29 @@ through the following keywords:
\telkey{DELWAQ PRINTOUT PERIOD}\\
\telkey{DELWAQ STEERING FILE}\\
\telkey{DIFFUSIVITY DELWAQ FILE}\\
\telkey{DIFFUSIVITY FOR DELWAQ}\\
%\telkey{DIFFUSIVITY FOR DELWAQ}\\
\telkey{EXCHANGE AREAS DELWAQ FILE}\\
\telkey{EXCHANGES BETWEEN NODES DELWAQ FILE}\\
\telkey{NODES DISTANCES DELWAQ FILE}\\
\telkey{SALINITY DELWAQ FILE}\\
\telkey{SALINITY FOR DELWAQ}\\
%\telkey{SALINITY FOR DELWAQ}\\
\telkey{TEMPERATURE DELWAQ FILE}\\
\telkey{TEMPERATURE FOR DELWAQ}\\
%\telkey{TEMPERATURE FOR DELWAQ}\\
\telkey{VELOCITY DELWAQ FILE}\\
\telkey{VELOCITY FOR DELWAQ}\\
%\telkey{VELOCITY FOR DELWAQ}\\
\telkey{VERTICAL FLUXES DELWAQ FILE}\\
\telkey{VOLUMES DELWAQ FILE}\\
\end{tabular}
\\
Since release 9.0, if \telkey{VELOCITY DELWAQ FILE},
\telkey{DIFFUSIVITY DELWAQ FILE}, \telkey{TEMPERATURE DELWAQ FILE}
or \telkey{SALINITY DELWAQ FILE} are present in the steering file,
there is no need to define keywords \telkey{VELOCITY FOR DELWAQ},
\telkey{DIFFUSIVITY FOR DELWAQ}, \telkey{TEMPERATURE FOR DELWAQ} or
\telkey{SALINITY FOR DELWAQ} (they have been deleted) anymore to trigger the
writing of part or whole files for DELWAQ.
\\
More information about these keywords can be found in the \telemac{2D} reference
manual. For more information, please refer to the DELWAQ user documentation.
documentation/telemac2d/user/latex/chap12.tex
View file @ ef067927
......@@ -325,11 +325,17 @@ The following essential information should be specified in the \telemac{2D}
\telkey{STEERING FILE} to run an oil spill propagation model:
\begin{itemize}
\item The use of the oil spill model must be declared:
\telkey{OIL SPILL MODEL} = YES (default = NO),
\item The name of the oil spill steering file which contains the oil
characteristics: \telkey{OIL SPILL STEERING FILE},
%\item The use of the oil spill model must be declared:
%\telkey{OIL SPILL MODEL} = YES (default = NO),
%
%\item The name of the oil spill steering file which contains the oil
%characteristics: \telkey{OIL SPILL STEERING FILE},
\item The use of the oil spill model must be declared by giving the name of the
\telkey{OIL SPILL STEERING FILE} which contains the oil characteristics.
Since release 9.0, if this file is present in the steering file, the
modelling of oil spill is automatically activated without setting the keyword
\telkey{OIL SPILL MODEL} (which has been deleted),
\item The number of oil particles to be released during the oil spill episode:
\newline \telkey{MAXIMUM NUMBER OF DROGUES},
......@@ -380,12 +386,14 @@ This file contains all information on oil calculation based on the composition
considered by the user:
\begin{itemize}
\item The number of non-soluble components in oil,
\item The number of non-soluble components in oil (by default, the maximum
number allowed is 10),
\item The parameters of these components such as the mass fraction (\%)
and boiling point of each component (K),
\item The number of soluble components in oil,
\item The number of soluble components in oil (by default, the maximum number
allowed is 10),
\item The parameters of these components such as the mass fraction (\%),
boiling point of each component (K), solubility (kg.m$^{-3}$) and the
......@@ -421,6 +429,15 @@ interrupted and an error message is displayed:
''WARNING::THE SUM OF EACH COMPONENT MASS FRACTION IS NOT EQUAL TO 1.''
''PLEASE, MODIFY THE INPUT STEERING FILE''
\item If wanting to use more than 10 unsoluble components or 10 soluble
components, the hard-coded 10 size in subroutine
\telfile{\$HOMETEL/sources/utils/parallel/declarations\_parallel.F}
has to be increased for several arrays
\telfile{MASS\_COMPO}, \telfile{TB\_COMPO}, \telfile{SOL\_COMPO},
\telfile{MASS\_HAP}, \telfile{TB\_HAP}, \telfile{SOL\_HAP}
in the TYPE \telfile{OIL\_TYPE}.
A full recompilation is then required (compile\_telemac.py --clean).
\end{itemize}
\end{WarningBlock}
......
documentation/telemac2d/user/latex/chap13.tex
View file @ ef067927
......@@ -69,7 +69,8 @@ On line 11, the level of the weir is specified for each couple of points
and at line 13 the discharge coefficient noted m.
All these data are repeated for all weirs.
The formulae used to calculate the discharge for each point are the following:
The formulae used to calculate the discharge for each point are the following
(Poleni's equation):
\begin{itemize}
\item unsubmerged weir: $Q=\mu \sqrt{2g}\ {\left(upstream-weir\right)}^{\frac{3}{2}}$,
......@@ -79,7 +80,7 @@ The formulae used to calculate the discharge for each point are the following:
\left(downstream-weir\right)\sqrt{\left(upstream-weir\right)},\]
\item the weir is not submerged if:
\[upstream\ level<\frac{weir\ level+2 \times upstream\ level}{3}.\]
\[downstream\ level<\frac{weir\ level+2 \times upstream\ level}{3}.\]
\end{itemize}
Depending on the shape and roughness of the weir, the value of $\mu$
is between 0.4 and 0.5.
......@@ -181,7 +182,13 @@ AA=1 -- automatic angle; AA=0 -- user-set angle.
\subsection{General overview}
\telemac{2D} allows simulating dykes breaching by suddenly or gradually
lowering the altitude of some points.
This feature is enabled using the logical keyword \telkey{BREACH} (default = NO).
%This feature is enabled using the logical keyword \telkey{BREACH} (default = NO).
This feature is enabled by giving a name to the \telkey{BREACHES DATA FILE}.
Since release 9.0, if this file is present in the steering file, the
breaches modelling is automatically activated without setting the keyword
\telkey{BREACH} (which has been deleted).
The different kinds of breach developments are completely controlled by user
via the \telkey{BREACHES DATA FILE}.
Regardless the kind of breach development, to model this phenomenon,
......
documentation/telemac2d/user/latex/chap14.tex
View file @ ef067927
......@@ -74,7 +74,8 @@ This calculates a set of tables depending on the latitude of each point.
To do this, it uses the Cartesian coordinates of each point provided
in the geometry file, and the latitude of origin point of the mesh
provided by the user in the steering file with the keyword
\telkey{LATITUDE OF ORIGIN POINT} (default value = 48 degrees).
\telkey{LATITUDE OF ORIGIN POINT} (default value = 0 degrees since release 9.0,
like in \telemac{3D}, old default value = 48 degrees until release 8.5).
By default, \telemac{2D} assumes that the mesh coordinates are given
in Cartesian coordinates.
......@@ -194,8 +195,12 @@ When using a reference file, the keyword \telkey{REFERENCE FILE FORMAT}
specifies the format of this binary file ('SERAFIN ' by default).
The \telfile{BIEF\_VALIDA} subroutine is called at each time step
when the keyword \telkey{VALIDATION} has the value YES,
%when the keyword \telkey{VALIDATION} has the value YES,
when the \telkey{REFERENCE FILE} is defined,
enabling a comparison to be done with the validation solution at each time step.
Since release 9.0, if this file is present in the steering file, the validation
step is automatically activated without setting the keyword \telkey{VALIDATION}
(which has been deleted).
By default, the \telfile{BIEF\_VALIDA} subroutine only does a comparison
with the last time step.
The results of this comparison are given in the output listing.
......
documentation/telemac2d/user/latex/chap16.tex
View file @ ef067927
......@@ -187,9 +187,9 @@ The possibilities are:
\begin{itemize}
\item 0: no treatment. The negative depths are left unchanged,
\item 1: smoothing of negative depth (default value),
\item 1: smoothing of negative depth (old default value until release 8.5),
\item 2: ''Flux control'', by segment,
\item 2: ''Flux control'', by segment (default value since release 9.0),
\item 3: ''Flux control'' ERIA, by triangular element.
\end{itemize}
......@@ -202,6 +202,9 @@ keywords:
\item \telkey{CONTINUITY CORRECTION} = YES,
\item \telkey{SUPG OPTION} for water depth = 0 (no SUPG upwinding on depth).
\end{itemize}
Since release 9.0, these 3 keywords are automatically set to those expected
values as soon as \telkey{TREATMENT OF NEGATIVE DEPTHS} is set to 2 or 3
(flux control).
When using option 1, it is possible to set the limit value for the smoothing
using the keyword \telkey{THRESHOLD FOR NEGATIVE DEPTHS}
......
documentation/telemac2d/user/latex/chap3.tex
View file @ ef067927
......@@ -475,6 +475,9 @@ The name of this file is given by the keyword \telkey{REFERENCE FILE} and its
format is specified by the keyword \telkey{REFERENCE FILE FORMAT} (default
value: 'SERAFIN '), see subsection \ref{subs:binfile}.
Since release 9.0, if this file is present in the steering file, the validation
step is automatically activated without setting the keyword \telkey{VALIDATION}
(which has been deleted).
\subsection{The results file}
......
documentation/telemac2d/user/latex/chap4.tex
View file @ ef067927
......@@ -133,15 +133,21 @@ However, it is possible to provide the initial value for this by using
the keyword \telkey{INITIAL VALUES OF TRACERS}.
In order to use the continuation file, it is necessary to enter
two keywords in the steering file:
%two keywords in the steering file:
the keyword \telkey{PREVIOUS COMPUTATION FILE} with
the name of the file that will supply the initial state.
\begin{itemize}
\item The keyword \telkey{COMPUTATION CONTINUED} must have the value YES
(default value = NO),
%\begin{itemize}
%\item The keyword \telkey{COMPUTATION CONTINUED} must have the value YES
%(default value = NO),
%
%\item The keyword \telkey{PREVIOUS COMPUTATION FILE} must provide
%the name of the file that will supply the initial state.
%\end{itemize}
\item The keyword \telkey{PREVIOUS COMPUTATION FILE} must provide
the name of the file that will supply the initial state.
\end{itemize}
Since release 9.0, if this file is present in the steering file, the
continuation step is automatically activated without setting the keyword
\telkey{COMPUTATION CONTINUED} (which has been deleted).
N.B.: the mesh for which the results are computed must be exactly the same
as the one to be used in continuing the computation.
......@@ -169,11 +175,19 @@ to improve the accuracy of calculations, using double precision format SERAFIN
files (or MED format):
\begin{itemize}
\item In the first computation, the keyword \telkey{RESTART MODE} is set to
YES (default = NO),
which generates a specific file containing the full information at one or a
%\item In the first computation, the keyword \telkey{RESTART MODE} is set to
%YES (default = NO),
%which generates a specific file containing the full information at one or a
%few time step(s) of the simulation.
%The name of this file is given by the keyword \telkey{RESTART FILE}.
\item In the first computation, the name of the \telkey{RESTART FILE} is to be
given.
It then generates a specific file containing the full information at one or a
few time step(s) of the simulation.
The name of this file is given by the keyword \telkey{RESTART FILE}.
Since release 9.0, if this file is present in the steering file, the writing
of this file is automatically done without activating the keyword
\telkey{RESTART MODE} (which has been deleted),
\item In the second computation, this specific file must be used as
\telkey{PREVIOUS COMPUTATION FILE} specifying the \telkey{PREVIOUS COMPUTATION
......
documentation/telemac2d/user/latex/chap5.tex
View file @ ef067927
......@@ -204,12 +204,52 @@ The printouts will be in the file named by the keyword
\section{Computation of fluxes over lines (FLUXLINE)}
It is possible to compute fluxes over lines by using
\telkey{FLUXLINE} = YES (default = NO).
The input file with data on cross-sections has to be given
with the keyword \telkey{FLUXLINE INPUT FILE}.
The format of this ASCII file is:
%It is possible to compute fluxes over lines by using
%\telkey{FLUXLINE} = YES (default = NO).
%The input file with data on cross-sections has to be given
%with the keyword \telkey{FLUXLINE INPUT FILE}.
To compute fluxes over lines by using the FLUXLINE method, the input file with
data on cross-sections has to be given with the keyword
\telkey{FLUXLINE INPUT FILE}.
Since release 9.0, if this file is present in the steering file, the computation
of fluxes over lines with the FLUXLINE method is automatically done without
activating the keyword \telkey{FLUXLINE} (which has been deleted).
%The format of this ASCII file is:
%\begin{itemize}
%\item the first line contains the number of lines to be read $n$,
%\item and then $n$ lines of 9 floating numbers describing each fluxline.
%\end{itemize}
The format of the ASCII file \telkey{FLUXLINE INPUT FILE} includes
(see Figure~\ref{fig:fluxline_example}):
\begin{itemize}
\item the first line contains the number of lines to be read $n$,
\item and then $n$ lines of 9 floating numbers describing each fluxline.
\item The number of fluxlines (integer),
\item The definition of the fluxlines, given by:
\begin{itemize}
\item The specification of two points of the fluxline (\texttt{fluxline\_x1, fluxline\_y1, fluxline\_x2, fluxline\_y2}) which give the direction of the fluxline but not the limits, followed by
\item The definition of the bounding box (\texttt{box\_x1, box\_y1, box\_x2, box\_y2}) inside which the computation of the flux line is carried out,
\item An integer (value not used).
\end{itemize}
\end{itemize}
An example of the \telkey{FLUXLINE INPUT FILE} is given below:
\begin{lstlisting}[frame=trBL]
5
94.0 31.2 99.0 31.2 95.0 31.0 98.0 31.6 1
94.0 42.5 99.0 42.5 96.0 42.0 98.0 43.0 1
101.0 42.5 107.0 42.5 104.0 42.0 106.0 43.0 1
101.0 31.2 107.0 31.2 104.0 31.0 106.0 31.6 1
100.0 45.0 102.0 48.0 100.0 46.0 102.0 47.5 1
\end{lstlisting}
\begin{figure}[H]
\begin{center}
\includegraphics[scale=0.25,angle=0]{graphics/fluxline_example.png}
\caption{Description of a single fluxline and edge fluxes (red).}\label{fig:fluxline_example}
\end{center}
\end{figure}
Further details can be found in \cite{Stadler2015}.
documentation/telemac2d/user/latex/chap6.tex
View file @ ef067927
......@@ -458,8 +458,12 @@ common with \waqtel, see \waqtel user manual) are among WINDX, WINDY, WINDS,
WINDD, PATM, TAIR.
The name of the variables can be changed in the
\telkey{BINARY ATMOSPHERIC DATA FILE} by running:\\
run\_telfile.py alter --rename 'old name var=new name var' name\_bin\_meteo\_file \\
run\_telfile.py alter --rename 'old name var=new name var'
name\_bin\_meteo\_file\_old name\_bin\_meteo\_file\_new \\
one variable by one variable e.g.
(WIND VELOCITY U has to be replaced by WINDX, WIND VELOCITY V has to be replaced
by WINDY, SURFACE PRESSURE has to be replaced by PATM and AIR TEMPERATURE has to
be replaced by TAIR).
Reference times are to be added in the keywords
\telkey{ORIGINAL DATE OF TIME} and \telkey{ORIGINAL HOUR OF TIME}
and \telkey{FREE FORMAT FOR ATMOSPHERIC DATA FILE} let to its default value
......
documentation/telemac2d/user/latex/chap7.tex
View file @ ef067927
......@@ -158,7 +158,7 @@ possibilities:
\item 2: Centred semi implicit scheme + SUPG
(Streamline Upwind Petrov Galerkin),
\item 3: Upwind explicit finite volume
\item 3: Upwind explicit Leo Postma scheme
(referenced as 8 before release 6.0), mass-conservative,
\item 4: N distributive scheme, mass-conservative,
......@@ -179,7 +179,8 @@ possibilities:
\end{itemize}
Schemes 3 and 4 on the one hand, and 13 and 14 on the other hand, are equal
in 2D (they are not in 3D) and correspond to the so called NERD scheme.
in 2D (they are not in 3D).
Schemes 13 and 14 correspond to the so called NERD scheme.
The stability of the N and the PSI scheme (type of advection 4 and 5)
is conditioned by a Courant number lower than 1.
......@@ -256,7 +257,12 @@ mandatory for a distributive scheme with tidal flats (13, 14 or 15).
\end{itemize}
\end{WarningBlock}
The default value for \telkey{TYPE OF ADVECTION} is 1;5;1;1, which corresponds
%The default value for \telkey{TYPE OF ADVECTION} is 1;5;1;1, which corresponds
The default value for \telkey{TYPE OF ADVECTION} is 1;5;13;1 since release 9.0.
It corresponds to the use of the method of characteristics for velocity
components + $k-\epsilon$ or Spalart-Allmaras variables, NERD scheme for tracers
and an appropriate conservative scheme selected by the code for water depth.
Previous default value was 1;5;1;1 until release 8.5, which corresponded
to the use of the method of characteristics in all cases, except for the depth
for which the appropriate conservative scheme is selected by the code.
Note that the value 5 in second position does not mean
......@@ -272,7 +278,8 @@ The keyword \telkey{TYPE OF ADVECTION} will be soon replaced
by the following keywords (already active):
\begin{itemize}
\item \telkey{SCHEME FOR ADVECTION OF VELOCITIES} (default = 1),
\item \telkey{SCHEME FOR ADVECTION OF TRACERS} (default = 1),
\item \telkey{SCHEME FOR ADVECTION OF TRACERS} (default = 13 since release 9.0,
old default = 1 until release 8.5),
\item \telkey{SCHEME FOR ADVECTION OF K-EPSILON} (default = 1).
\end{itemize}
The keyword for advection of water depth is not necessary, since the scheme is
......@@ -354,8 +361,11 @@ As the mass-lumping is applied only on time derivatives,
it does not change steady state results.\\
If using \telkey{OPTION FOR THE TREATMENT OF TIDAL FLATS} = 1 (default value)
and \telkey{TREATMENT OF NEGATIVE DEPTHS} = 2 (flux control),
and \telkey{TREATMENT OF NEGATIVE DEPTHS} = 2 or 3 (flux control),
the keyword \telkey{MASS-LUMPING ON H} must be equal to 1.
Since release 9.0, \telkey{TREATMENT OF NEGATIVE DEPTHS} = 2 (flux control) is
the default option and when chosen to 2 or 3, \telkey{MASS-LUMPING ON H} is
automatically set to 1. as warned in the listing.
The keyword \telkey{MASS-LUMPING ON TRACERS} is read but automatically replaced
by the value of \telkey{MASS-LUMPING ON H} to ensure tracer mass conservation.
......@@ -682,7 +692,8 @@ Accuracy is specified with the following keywords:
of the propagation step (default value = 10$^{-4}$),
\item \telkey{ACCURACY FOR DIFFUSION OF TRACERS}: defines the accuracy required
during the computation of tracer diffusion (default value = 10$^{-6}$),
during the computation of tracer diffusion (default value = 10$^{-8}$ since
release 9.0, old default value = 10$^{-6}$ until release 8.5),
\item \telkey{ACCURACY OF K}: defines the accuracy required during the diffusion
and source terms step of the turbulent energy transport equation
......@@ -745,9 +756,13 @@ The keyword \telkey{CONTINUITY CORRECTION} helps in correcting the velocity
at these points so that the overall continuity is verified.
This correction has enabled the error to be divided by as much as 1,000.
The default value is NO.
\\
When using \telkey{TREATMENT OF NEGATIVE DEPTH} = 2 or 3 with tidal flats,
it is mandatory to activate \telkey{CONTINUITY CORRECTION} = YES.
Since release 9.0, \telkey{TREATMENT OF NEGATIVE DEPTHS} = 2 (flux control) is
the default option and when chosen to 2 or 3, \telkey{CONTINUITY CORRECTION} is
automatically set to YES as warned in the listing.
\subsection{Preconditioning}
......@@ -944,17 +959,20 @@ The user can modify the porosity value determined by the processing in the
The treatment of the negative depths can be specified using the keyword
\telkey{TREATMENT OF NEGATIVE DEPTHS}.
Value 1 (default value) is the previously only option consisting in smoothing
the negative depths in a conservative way.
Value 1 (old default value until release 8.5) is the previously only option
consisting in smoothing the negative depths in a conservative way.
The option 2 (since release 6.0) is a flux limitation
that ensures strictly positive depths.
So is option 3 for ERIA advection scheme.
Since release 9.0, 2 (= flux control) is the default choice for keyword
\telkey{TREATMENT OF NEGATIVE DEPTHS}.
This must be preferably coupled with the advection schemes able to cope
with tidal flats (+ \telkey{MASS-LUMPING ON H} = 1.
+ \telkey{CONTINUITY CORRECTION} = YES
+ \telkey{SUPG OPTION} for water depth = 0, i.e. no SUPG upwinding on depth).
This option is however recommended when conservative tracers are modelled
using distributive schemes (\telkey{SCHEME FOR ADVECTION OF TRACERS} = 4 or 5):
using distributive schemes (N, PSI, NERD, LIPS, ERIA, i.e.
\telkey{SCHEME FOR ADVECTION OF TRACERS} = 3, 4, 5, 13, 14 or 15):
it allows to obtain a perfect mass balance. Value 0 means no treatment.
The numerical advection schemes (keywords \telkey{TYPE OF ADVECTION}
......@@ -967,7 +985,7 @@ LIPS scheme,
\end{itemize}
\begin{WarningBlock}{Note:}
NERD schemes (13 and 14) require the keywords
NERD schemes (= 13 or 14 as the same in 2D) require the keywords
\telkey{TIDAL FLATS} = YES (default)
+ \telkey{OPTION FOR THE TREATMENT OF TIDAL FLATS} = 1 (default)
+ \telkey{TREATMENT OF NEGATIVE DEPTHS} = 2 and then
......
documentation/telemac2d/user/latex/chap9.tex
View file @ ef067927
......@@ -108,7 +108,9 @@ in the part concerning the tracer (see \ref{subs:pres:compl:val}).
\end{itemize}
The keyword \telkey{TREATMENT OF FLUXES AT THE BOUNDARIES} enables,
during the convection step (with the SUPG, PSI and N schemes), to set a
during the advection step (with distributive type advection schemes
such as Leo Postma = N in 2D, PSI, NERD, ERIA or their variants
like Predictor-Corrector and LIPS), to set a
priority among the tracer flux across the boundary and tracer value at that wall.
Option 2 ("Priority to fluxes") will then induce a change in the tracer
prescribed value, so that the flux is correct.
......@@ -139,7 +141,8 @@ The user can also use the real keyword
\telkey{IMPLICITATION COEFFICIENT OF TRACERS} (default value = 0.6) in order to
configure the implicitation values in the cases of semi-implicit schemes.
If an advection scheme for tracers is a distributive scheme
(e.g.: 3, N = 4, PSI = 5, NERD = 13, 14 or ERIA = 15),
(e.g.: Leo Postma = N in 2D, PSI, NERD or ERIA = 15, or their variants
like Predictor-Corrector or LIPS),
\telkey{IMPLICITATION COEFFICIENT OF TRACERS} is prescribed at 0. (explicit).
When solving the tracer transport equations, the user can choose
......
documentation/telemac3d/user/latex/apdx_delwaq.tex
View file @ ef067927
......@@ -8,20 +8,30 @@ through the following keywords:
\telkey{BOTTOM SURFACES DELWAQ FILE}\\
\telkey{DELWAQ PRINTOUT PERIOD}\\
\telkey{DELWAQ STEERING FILE}\\
\telkey{DIFFUSION FOR DELWAQ}\\
%\telkey{DIFFUSION FOR DELWAQ}\\
\telkey{DIFFUSIVITY DELWAQ FILE}\\
\telkey{EXCHANGE AREAS DELWAQ FILE}\\
\telkey{EXCHANGES BETWEEN NODES DELWAQ FILE}\\
\telkey{NODES DISTANCES DELWAQ FILE}\\
\telkey{SALINITY DELWAQ FILE}\\
\telkey{SALINITY FOR DELWAQ}\\
%\telkey{SALINITY FOR DELWAQ}\\
\telkey{TEMPERATURE DELWAQ FILE}\\
\telkey{TEMPERATURE FOR DELWAQ}\\
%\telkey{TEMPERATURE FOR DELWAQ}\\
\telkey{VELOCITY DELWAQ FILE}\\
\telkey{VELOCITY FOR DELWAQ}\\
%\telkey{VELOCITY FOR DELWAQ}\\
\telkey{VERTICAL FLUXES DELWAQ FILE}\\
\telkey{VOLUMES DELWAQ FILE}\\
\end{tabular}
\\
Since release 9.0, if \telkey{VELOCITY DELWAQ FILE},
\telkey{DIFFUSIVITY DELWAQ FILE}, \telkey{TEMPERATURE DELWAQ FILE}
or \telkey{SALINITY DELWAQ FILE} are present in the steering file,
there is no need to define keywords \telkey{VELOCITY FOR DELWAQ},
\telkey{DIFFUSION FOR DELWAQ}, \telkey{TEMPERATURE FOR DELWAQ} or
\telkey{SALINITY FOR DELWAQ} (they have been deleted) anymore to trigger the
writing of part or whole files for DELWAQ.
\\
More information about these keywords can be found in the \telemac{3D} reference
manual. For more information, please refer to the DELWAQ user documentation.

Moyen d'essai PAM - EDF R&D