Artemis Reference v8p4
Artemis Reference v8p4
Artemis Reference v8p4
ReferenceManual
Version v8p4
December 1, 2022
Contents
3 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.1 English/French glossary 40
3.2 French/English glossary 43
Bibliography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
1. Detail list of keywords
1.1 ALPHA
Type : Real
Dimension : 0
Mnemo ALFABJ
DEFAULT VALUE : 1.0
French keyword : ALPHA
Fixes the coefficient α used in the formulation of the dissipation coefficient through breaking
proposed by Battjes & Janssen, 1978 for random waves.
1.16 BREAKING
Type : Logical
Dimension : 0
Mnemo DEFERL
DEFAULT VALUE : NO
French keyword : DEFERLEMENT
Yes, if one wants to account for breaking process (see also reals of index 18, 19, 20, 21, 22, 23,
and integer of index 12, 13).
In random wave mode, the formulation of B & J, 1978 is the only one to be used.
If this keyword is equal to YES, a call to subroutine CHECKMESH will look for errors in the
mesh, superimposed points, etc.
1.21 CURRENT
Type : Logical
Dimension : 0
Mnemo COURANT
DEFAULT VALUE : NO
French keyword : COURANT
If = TRUE: Wave refraction due to current is described using Kostense model (1988).
1.22 DEBUGGER
Type : Integer
Dimension : 1
Mnemo DEBUG
DEFAULT VALUE : 0
French keyword : DEBUGGER
If 1, calls of subroutines will be printed in the listing.
1.23 DIAMETER50
Type : Real
Dimension : 0
Mnemo DIAM50
DEFAULT VALUE : 0.10E-3
French keyword : DIAMETRE50
DIAM50 is the maximum grain diameter, in m, which defines 50 % of the total weight of
sediment. Usually, we have DIAM90 = 1.5 × DIAM50. DIAM50 is a more common value
used.
12 Chapter 1. Detail list of keywords
1.24 DIAMETER90
Type : Real
Dimension : 0
Mnemo DIAM90
DEFAULT VALUE : 0.15E-3
French keyword : DIAMETRE90
DIAM90 is the maximum grain diameter, in m, which defines 90 % of the total weight of
sediment.
1.25 DICTIONARY
Type : String
Dimension : 1
Mnemo
DEFAULT VALUE : ’artemis.dico’
French keyword : DICTIONNAIRE
Key word dictionary.
determine the free surface elevation throughout the model area. Remember to give AMPLITUDE
AND PHASE FILE and FREE SURFACE FILE.
1.39 FRICTION
Type : Logical
Dimension : 0
Mnemo FROTTE
DEFAULT VALUE : NO
French keyword : FROTTEMENT
Yes, if one wants to include dissipation through bottom friction in the computation.
1.43 GAMMA
Type : Real
Dimension : 0
Mnemo GAMMA
DEFAULT VALUE : 3.3
French keyword : GAMMA
Used with option MONODIRECTIONAL RANDOM WAVE = YES or MULTIDIRECTIONAL
RANDOM WAVE = YES. Fixes the γ value tor the JONSWAP wave energy spectrum:
• GAMMA = 1: Pierson-Moskowitz,
• GAMMA = 3.3: mean JONSWAP spectrum (default value).
1.44 GAMMAS
Type : Real
Dimension : 0
Mnemo GAMMAS
DEFAULT VALUE : 0.88
French keyword : GAMMAS
Fixes the coefficient γs used in the criterion of the critical breaking wave height. Do not confuse
with coefficient γ used in the JONSWAP spectrum.
1.45 GDALLY
Type : Real
Dimension : 0
Mnemo GDALLY
DEFAULT VALUE : 0.4
French keyword : GDALLY
Fixes the Γ coefficient used in the formulation of Dally et al., 1984, for the dissipation coeffi-
1.46 GEOMETRY FILE 17
cient in surf-breaking. Do not confuse with the coefficient γ used in the JONSWAP formulae
and coefficient gammas used to determine the breaking wave height criterion.
Used with the option FRICTION = YES. Enables to impose the hydraulic regime in the case of
an automatic calculation of the friction factor for sandy beds.
• laminar regime,
• smooth-turbulent regime,
• rough-turbulent regime,
• transient regime.
• ZERO ELEVATION: fixes the free surface level to 0. Water depths are then equal to the
difference between free surface level and bottom level,
• CONSTANT ELEVATION: fixes the free surface level to the value specified by the key-
word INITIAL WATER LEVEL. Water level are then computed as before,
• CONSTANT DEPTH: initializes the water depths to the value specified by the keyword
INITIAL DEPTH,
• SPECIAL: initial conditions on water depths are to be precised in the subroutine CONDIH.
1.54 INITIAL DEPTH 19
1.57 KDALLY
Type : Real
Dimension : 0
Mnemo KDALLY
DEFAULT VALUE : 0.1
French keyword : KDALLY
Fixes the coefficient K used in the formulation of the dissipation coefficient proposed by Dally
et al. 1984.
• 1: classical EBE,
• 2: assembled EBE,
• 3: edge-based storage.
• 1: Classical Product,
• 1: METIS,
• 2: SCOTCH,
• 3: PARMETIS,
• 4: PTSCOTCH.
1.84 PRECONDITIONING
Type : Integer
Dimension : 1
Mnemo SLVART%PRECON
DEFAULT VALUE : 2
French keyword : PRECONDITIONNEMENT
Enables to apply preconditionning the matrix system to accelerate the convergence of the solver.
• 0: no preconditionning,
• 2: diagonal preconditionning,
• 3: block-diagonal preconditionning,
Few of them can be combined (numbers 2 or 3 with the other). To combine some precondition-
nings, impose the product of the previous numbers: example 6 means preconditioning 2 and 3
applied.
• 0: mild-slope equation,
Model used for functions E1 and E2 expression: Chamberlain and Porter (1995).
1.93 S EXPONENT
Type : Real
Dimension : 0
Mnemo EXPOS
DEFAULT VALUE : 20.
French keyword : EXPOSANT S
Used with the option MULTIDIRECTIONAL RANDOM WAVE = YES. Fixes the maximum
value of exponent S in the Goda formula used to express the directional wave energy spreading.
See GODA Y., Random Seas and Design of Maritime Structures - Univ. of Tokyo Press, 1987.
28 Chapter 1. Detail list of keywords
1.96 SOLVER
Type : Integer
Dimension : 1
Mnemo SLVART%SLV
DEFAULT VALUE : 8
French keyword : SOLVEUR
Enables to choose the solver used for solving the matrix system. They are:
• 1: conjugate gradient,
• 2: conjugate residual,
• 4: minimum error,
• 7: GMRES,
• 8: direct solver.
1.105 TITLE
Type : String
Dimension : 1
Mnemo TITCAS
DEFAULT VALUE : ”
French keyword : TITRE
Title of the studied case.
1.112 VALIDATION
Type : Logical
Dimension : 1
Mnemo VALID
DEFAULT VALUE : NO
French keyword : VALIDATION
This option is primarily used for the validation documents. The REFERENCE FILE is then
32 Chapter 1. Detail list of keywords
considered as a reference which the computation is going to be compared with. The comparison
is made by the subroutine BIEF_VALIDA, which can be modified as to so as to include, for
example, a comparison with an exact solution.
• HS=wave height,
• PHAS=wave phase,
• ZF=bottom elevation,
• C=phase velocity,
• CG=group velocity,
• K=wave number,
• PHIR=real potential,
• PHII=imaginal potential,
• D=prive(1,1),
• E=prive(1,2),
• F=prive(1,3),
• G=prive(1,4),
• FX=force along X,
• FY=force along Y,
• QB=breaking rate,
• SXX=SXX stress,
• SXY=SXY stress,
• SYY=SYY stress.
The user has 4 free variables at his/her disposal to create other variables by him/herself. These
variables have to be computed in the CALRES subroutine, and the name that we want to at-
tribute has to be precibed in the NOMVAR subroutine. The 4 free variable fields are: D, E, F,
G which corresponds to the private arrays PRIVE(1,1), PRIVE(1,2), PRIVE(1,3) and PRIVE
(1,4). Contrary to the previous variables, these are conserved all through the computation, and
can be used again. Do not forget to specify the number of private arrays you want to use in the
principal programme (variable NPRIV).
1.118 ZERO
Type : Real
Dimension : 0
Mnemo SLVART%ZERO
DEFAULT VALUE : 1.E-12
French keyword : ZERO
Non active at the moment.
2. List of keywords classified according
to type
DATA
BEGINNING PERIOD FOR PERIOD SCANNING
ENDING PERIOD FOR PERIOD SCANNING
STEP FOR PERIOD SCANNING
36 Chapter 2. List of keywords classified according to type
MONODIRECTIONAL
MONODIRECTIONAL RANDOM WAVE
MULTIDIRECTIONAL
MAXIMUM ANGLE OF PROPAGATION
MINIMUM ANGLE OF PROPAGATION
MULTIDIRECTIONAL RANDOM WAVE
NUMBER OF DIRECTIONS
S EXPONENT
2.2.2 INPUT
DATA
BINARY DATA FILE 1
BINARY DATA FILE 1 FORMAT
BINARY DATA FILE 2
BINARY DATA FILE 2 FORMAT
BOTTOM TOPOGRAPHY FILE
BOTTOM TOPOGRAPHY SMOOTHING
BOUNDARY CONDITIONS FILE
FORMATTED DATA FILE 1
FORMATTED DATA FILE 2
FORTRAN FILE
GEOMETRY FILE
GEOMETRY FILE FORMAT
REFERENCE FILE
REFERENCE FILE FORMAT
VALIDATION
2.3 GENERAL PARAMETERS 37
2.2.3 OUTPUT
FREE SURFACE
AMPLITUDE AND PHASE FILE
AMPLITUDE AND PHASE FILE FORMAT
FIRST TIME IN THE FREE SURFACE FILE
FREE SURFACE ANIMATION
FREE SURFACE FILE
FREE SURFACE FILE FORMAT
NUMBER OF TIME STEPS
TIME STEP
LISTING
INFORMATIONS ABOUT SOLVER
LISTING PRINTOUT
LISTING PRINTOUT PERIOD
VARIABLES TO BE PRINTED
RESULTS
BINARY RESULTS FILE
FORMATTED RESULTS FILE
GRAPHIC PRINTOUT PERIOD
NUMBER OF PRIVATE VARIABLES
RESULTS FILE
RESULTS FILE FORMAT
VARIABLES FOR GRAPHIC PRINTOUTS
2.3.1 LOCATION
ORIGIN COORDINATES
2.3.2 TIME
ORIGINAL DATE OF TIME
ORIGINAL HOUR OF TIME
2.4 INTERNAL
CONCATENATE PARTEL OUTPUT
DICTIONARY
PARTITIONING TOOL
STEERING FILE
38 Chapter 2. List of keywords classified according to type
2.5.1 INPUT
DATA
TOMAWAC LIQUID BOUNDARY FILE
TOMAWAC LIQUID BOUNDARY FILE FORMAT
TOMAWAC OUTER SPECTRAL FILE
TOMAWAC OUTER SPECTRAL FILE FORMAT
2.5.2 OUTPUT
RESULTS
TOMAWAC OUTER RESULT FILE
TOMAWAC OUTER RESULT FILE FORMAT
2.6.1 DISSIPATION
DISSIPATION RELAXATION
MAXIMUM OF SUB-ITERATIONS
SUB-ITERATIONS ACCURACY FOR DISSIPATION
2.7.2 DISSIPATION
BATHYMETRIC BREAKING
ALPHA
BREAKING
BREAKING LAW
GAMMAS
GDALLY
KDALLY
BOTTOM FRICTION
BOTTOM FRICTION LAW
DIAMETER50
DIAMETER90
FLUID KINEMATIC VISCOSITY
FLUID SPECIFIC MASS
FRICTION
FRICTION COEFFICIENT
FRICTION FACTOR
FRICTION FACTOR IMPOSED
HYDRAULIC REGIME IMPOSED
HYDRAULIC REGIME TYPE
RIPPLES COEFFICIENT
SEDIMENT SPECIFIC WEIGHT
SKIN ROUGHNESS ONLY
2.7.3 INITIALIZATION
INITIAL CONDITIONS
INITIAL DEPTH
INITIAL WATER LEVEL
ALPHA ALPHA
AMPLITUDE AND PHASE FILE FICHIER DES PHASES ET
AMPLITUDES
AMPLITUDE AND PHASE FILE FORMAT FORMAT DU FICHIER DES PHASES ET
AMPLITUDES
AUTOMATIC CALCULATION OF PHASE CALCUL AUTOMATIQUE DE LA PHASE
AUTOMATIC TETAP CALCULATION CALCUL AUTOMATIQUE DE TETAP
BEGINNING PERIOD FOR PERIOD PERIODE DE DEBUT POUR LE
SCANNING BALAYAGE EN PERIODE
BINARY DATA FILE 1 FICHIER DE DONNEES BINAIRE 1
BINARY DATA FILE 1 FORMAT FORMAT DU FICHIER DE DONNEES
BINAIRE 1
BINARY DATA FILE 2 FICHIER DE DONNEES BINAIRE 2
BINARY DATA FILE 2 FORMAT FORMAT DU FICHIER DE DONNEES
BINAIRE 2
BINARY RESULTS FILE FICHIER DES RESULTATS BINAIRE
BOTTOM FRICTION LAW FORMULATION DU FROTTEMENT DE
FOND
BOTTOM TOPOGRAPHY FILE FICHIER DES FONDS
BOTTOM TOPOGRAPHY SMOOTHING LISSAGES DU FOND
BOUNDARY CONDITIONS FILE FICHIER DES CONDITIONS AUX
LIMITES
BREAKING DEFERLEMENT
BREAKING LAW FORMULATION DU DEFERLEMENT
CHECKING THE MESH VERIFICATION DU MAILLAGE
CONCATENATE PARTEL OUTPUT CONCATENATION SORTIE PARTEL
COORDINATES OF THE REFERENCE F COORDONNEES POUR LE SPECTRE F
SPECTRUM DE REFERENCE
CURRENT COURANT
DEBUGGER DEBUGGER
DIAMETER50 DIAMETRE50
3.1 English/French glossary 41
DIAMETER90 DIAMETRE90
DICTIONARY DICTIONNAIRE
DIRECTION OF WAVE PROPAGATION DIRECTION DE PROPAGATION DE LA
HOULE
DISSIPATION RELAXATION RELAXATION SUR LA DISSIPATION
ENDING PERIOD FOR PERIOD PERIODE DE FIN POUR LE BALAYAGE
SCANNING EN PERIODE
FIRST TIME IN THE FREE SURFACE PREMIER TEMPS DANS LE FICHIER
FILE DE SURFACE LIBRE
FLUID KINEMATIC VISCOSITY VISCOSITE CINEMATIQUE DU FLUIDE
FLUID SPECIFIC MASS MASSE VOLUMIQUE DU FLUIDE
FORMATTED DATA FILE 1 FICHIER DE DONNEES FORMATE 1
FORMATTED DATA FILE 2 FICHIER DE DONNEES FORMATE 2
FORMATTED RESULTS FILE FICHIER DES RESULTATS FORMATE
FORTRAN FILE FICHIER FORTRAN
FREE SURFACE ANIMATION ANIMATION DE LA SURFACE LIBRE
FREE SURFACE FILE FICHIER DE SURFACE LIBRE
FREE SURFACE FILE FORMAT FORMAT DU FICHIER DE SURFACE
LIBRE
FRICTION FROTTEMENT
FRICTION COEFFICIENT COEFFICIENT DE FROTTEMENT
FRICTION FACTOR FACTEUR DE FROTTEMENT
FRICTION FACTOR IMPOSED FACTEUR DE FROTTEMENT IMPOSE
GAMMA GAMMA
GAMMAS GAMMAS
GDALLY GDALLY
GEOMETRY FILE FICHIER DE GEOMETRIE
GEOMETRY FILE FORMAT FORMAT DU FICHIER DE GEOMETRIE
GRAPHIC PRINTOUT PERIOD PERIODE DE SORTIE GRAPHIQUE
GRAVITY ACCELERATION ACCELERATION DE LA PESANTEUR
HYDRAULIC REGIME IMPOSED REGIME HYDRAULIQUE IMPOSE
HYDRAULIC REGIME TYPE TYPE DU REGIME HYDRAULIQUE
INFORMATIONS ABOUT SOLVER INFORMATIONS SUR LE SOLVEUR
INITIAL CONDITIONS CONDITIONS INITIALES
INITIAL DEPTH HAUTEUR INITIALE
INITIAL WATER LEVEL COTE INITIALE
INSTANT FOR READING TOMAWAC INSTANT DE LECTURE DU SPECTRE
SPECTRUM TOMAWAC
KDALLY KDALLY
LISTING PRINTOUT SORTIE LISTING
LISTING PRINTOUT PERIOD PERIODE DE SORTIE LISTING
MATRIX STORAGE STOCKAGE DES MATRICES
MATRIX-VECTOR PRODUCT PRODUIT MATRICE-VECTEUR
MAXIMUM ANGLE OF PROPAGATION ANGLE MAXIMUM DE PROPAGATION
MAXIMUM NUMBER OF ITERATIONS MAXIMUM D’ITERATIONS POUR LE
FOR SOLVER SOLVEUR
MAXIMUM OF SUB-ITERATIONS MAXIMUM DE SOUS-ITERATIONS
42 Chapter 3. Glossary
[1]
[1] J-M. HERVOUET. Hydrodynamics of free surface flows. Modelling with the finite element
method. John Wiley & Sons, Ltd, Paris, 2007.