Telemac/gaia_cata_auto.py

   1
   2 # -*- coding: latin-1 -*-
   3
   4 from Accas import *
   5 class DateJJMMAAAA:
   6   def __init__(self):
   7     self.ntuple=3
   8
   9   def __convert__(self,valeur):
  10     if type(valeur) == types.StringType: return None
  11     if len(valeur) != self.ntuple: return None
  12     return valeur
  13
  14   def info(self):
  15     return "Date : jj/mm/aaaa "
  16
  17   __repr__=info
  18   __str__=info
  19
  20 class grma(GEOM):
  21   pass
  22
  23 import types
  24 class Tuple:
  25   def __init__(self,ntuple):
  26     self.ntuple=ntuple
  27
  28   def __convert__(self,valeur):
  29     if type(valeur) == types.StringType:
  30       return None
  31     if len(valeur) != self.ntuple:
  32       return None
  33     return valeur
  34
  35   def info(self):
  36     return "Tuple de %s elements" % self.ntuple
  37
  38
  39
  40 JdC = JDC_CATA (code = 'GAIA',
  41                 execmodul = None,
  42                 )
  43 # =======================================================================
  44 # Catalog entry for the MAP function : c_pre_interfaceBody_mesh
  45 # =======================================================================
  46
  47 VERSION_CATALOGUE="TRUNK_20201028"
  48 # -----------------------------------------------------------------------
  49 COMPUTATION_ENVIRONMENT = PROC(nom= "COMPUTATION_ENVIRONMENT",op = None,
  50 # -----------------------------------------------------------------------
  51 #   -----------------------------------
  52     GLOBAL = FACT(statut='o',
  53 #   -----------------------------------
  54 #       -----------------------------------
  55         TITLE = SIMP(statut ='f',
  56 #       -----------------------------------
  57             typ = 'TXM',
  58             defaut = '',
  59             fr = """Titre du cas etudie.
  60 Ce titre sera inscrit dans les sorties.""",
  61             ang = """Title of the case being considered.""",
  62         ),
  63 #       -----------------------------------
  64         PARALLEL_PROCESSORS = SIMP(statut ='f',
  65 #       -----------------------------------
  66             typ = 'I',
  67             defaut = [0],
  68             fr = """NOMBRE DE PROCESSEURS EN CALCUL PARALLELE
  69 0 : 1 machine, compilation sans bibliotheque de parallelisme
  70 1 : 1 machine, compilation avec bibliotheque de parallelisme
  71 2 : 2 processeurs ou machines en parallele
  72 etc...""",
  73             ang = """NUMBER OF PROCESSORS FOR PARALLEL PROCESSING
  74 0 : 1 machine, compiling without parallel library
  75 1 : 1 machine, compiling with a parallel library
  76 2 : 2 processors or machines in parallel
  77 etc....""",
  78         ),
  79 #       -----------------------------------
  80         CHECKING_THE_MESH = SIMP(statut ='o',
  81 #       -----------------------------------
  82             typ = bool,
  83             defaut = [False],
  84             fr = """Si oui on appelle le sous-programme checkmesh qui verifie
  85 la coherence du maillage, points superposes, etc.""",
  86             ang = """if this key word is equal to yes, a call to subroutine
  87 checkmesh will look for errors in the mesh, superimposed points, etc.""",
  88         ),
  89 #       -----------------------------------
  90         MAXIMUM_NUMBER_OF_BOUNDARIES = SIMP(statut ='f',
  91 #       -----------------------------------
  92             typ = 'I',
  93             defaut = 30,
  94             fr = """nombre maximal de frontieres differentes dans le maillage.
  95 Sert au dimensionnement de la memoire, a augmenter si necessaire""",
  96             ang = """maximal number of boundaries in the mesh.
  97 Used for dimensioning arrays. Can be increased if needed""",
  98         ),
  99     ),
 100 #   -----------------------------------
 101     INPUT = FACT(statut='o',
 102 #   -----------------------------------
 103 #       -----------------------------------
 104         DATA = FACT(statut='o',
 105 #       -----------------------------------
 106 #           -----------------------------------
 107             VALIDATION = SIMP(statut ='f',
 108 #           -----------------------------------
 109                 typ = bool,
 110                 defaut = False,
 111                 fr = """Option utilisee principalement pour le dossier de validation.
 112 Si ce mot-cle vaut OUI, les resultats du calcul vont alors etre
 113 compares aux valeurs du fichier de reference.
 114 La comparaison est effectuee par le sous-programme VALIDA qui peut
 115 etre modifie pour realiser, par exemple, une comparaison avec
 116 une solution exacte.""",
 117                 ang = """This option is primarily used for the validation
 118 documents. If this keyword is equal to YES, the REFERENCE FILE
 119 is then considered as a reference which the computation is
 120 going to be compared with.
 121 The comparison is made by the subroutine VALIDA, which can be
 122 modified so as to include,for example,a comparison with an
 123 exact solution.""",
 124             ),
 125 #           -----------------------------------
 126             b_VALIDATIONG = BLOC(condition="VALIDATION == True",
 127 #           -----------------------------------
 128 #               -----------------------------------
 129                 REFERENCE_FILE_FORMAT = SIMP(statut ='f',
 130 #               -----------------------------------
 131                     typ = 'TXM',
 132                     into = ['SERAFIN','SERAFIND','MED'],
 133                     defaut = 'SERAFIN',
 134                     fr = """Format du fichier de resultats du calcul precedent.
 135 Les valeurs possibles sont :
 136 - SERAFIN : format standard simple precision pour Telemac;
 137 - SERAFIND: format standard double precision pour Telemac;
 138 - MED     : format MED base sur HDF5""",
 139                     ang = """Previous computation results file format.
 140 Possible values are:
 141 - SERAFIN : classical single precision format in Telemac;
 142 - SERAFIND: classical double precision format in Telemac;
 143 - MED     : MED format based on HDF5""",
 144                 ),
 145 #               -----------------------------------
 146                 REFERENCE_FILE = SIMP(statut ='f',
 147 #               -----------------------------------
 148                     typ = ('Fichier','All Files (*)'), max='**',
 149                     defaut = '',
 150                     fr = """Nom du fichier servant a valider le calcul.
 151 Si VALIDATION = OUI, les resultats du calcul vont etre
 152 comparees aux valeurs contenues dans ce fichier.
 153 La comparaison est effectuee par le sous-programme VALIDA.""",
 154                     ang = """Name of the file used to validate the computation.
 155 If VALIDATION = YES, the results of the computation will be
 156 compared with the values of this file. The comparison is
 157 made by the subroutine VALIDA.""",
 158                 ),
 159             ),
 160         ),
 161     ),
 162 #   -----------------------------------
 163     OUTPUT = FACT(statut='o',
 164 #   -----------------------------------
 165 #       -----------------------------------
 166         RESULTS = FACT(statut='o',
 167 #       -----------------------------------
 168 #           -----------------------------------
 169             NUMBER_OF_PRIVATE_ARRAYS = SIMP(statut ='o',
 170 #           -----------------------------------
 171                 typ = 'I',
 172                 defaut = [1],
 173                 fr = """Nombre de tableaux mis a disposition de l utilisateur""",
 174                 ang = """Number of arrays for own user programming""",
 175             ),
 176         ),
 177     ),
 178 )
 179 # -----------------------------------------------------------------------
 180 INTERNAL = PROC(nom= "INTERNAL",op = None,
 181 # -----------------------------------------------------------------------
 182     UIinfo = {"groupes": ("CACHE")},
 183 #   -----------------------------------
 184     RELEASE = SIMP(statut ='f',
 185 #   -----------------------------------
 186         typ = 'TXM',
 187         defaut = 'TRUNK',
 188         fr = """Numero de version des bibliotheques utilisees par GAIA.""",
 189         ang = """Release of the libraries used by GAIA.""",
 190     ),
 191 #   -----------------------------------
 192     DICTIONARY = SIMP(statut ='f',
 193 #   -----------------------------------
 194         typ = ('Fichier','All Files (*)'),
 195         defaut = 'gaia.dico',
 196         fr = """Dictionnaire des mots cles.""",
 197         ang = """Key word dictionary.""",
 198     ),
 199 )
 200 # -----------------------------------------------------------------------
 201 GENERAL_PARAMETERS = PROC(nom= "GENERAL_PARAMETERS",op = None,
 202 # -----------------------------------------------------------------------
 203 #   -----------------------------------
 204     DEBUGGER = SIMP(statut ='f',
 205 #   -----------------------------------
 206         typ = 'I',
 207         defaut = [0],
 208         fr = """Pour imprimer la sequence des appels, mettre 1""",
 209         ang = """If 1, calls of subroutines will be printed in the listing""",
 210     ),
 211 #   -----------------------------------
 212     LOCATION = FACT(statut='o',
 213 #   -----------------------------------
 214 #       -----------------------------------
 215         ORIGIN_COORDINATES = SIMP(statut ='o',
 216 #       -----------------------------------
 217             typ = 'I', min= 2, max= 2,
 218             defaut = [0,0],
 219             fr = """Valeur en metres, utilise pour eviter les trop grands nombres,
 220 transmis dans le format Selafin mais pas d''autre traitement pour
 221 l''instant""",
 222             ang = """Value in metres, used to avoid large real numbers,
 223 added in Selafin format, but so far no other treatment""",
 224         ),
 225     ),
 226 )
 227 # -----------------------------------------------------------------------
 228 HYDRODYNAMICS = PROC(nom= "HYDRODYNAMICS",op = None,
 229 # -----------------------------------------------------------------------
 230 #   -----------------------------------
 231     TIDAL_FLATS_INFO = FACT(statut='o',
 232 #   -----------------------------------
 233 #       -----------------------------------
 234         OPTION_FOR_THE_TREATMENT_OF_TIDAL_FLATS = SIMP(statut ='o',
 235 #       -----------------------------------
 236             typ = 'I',
 237             defaut = 1,
 238             fr = """Utilise si ''BANCS DECOUVRANTS'' est vrai
 239    1 : EQUATIONS RESOLUES PARTOUT AVEC CORRECTION
 240        SUR LES BANCS DECOUVRANTS
 241    2 : GEL DES ELEMENTS DECOUVRANTS
 242 Il est conseille de choisir l''option 1 car elle permet de
 243 conserver la masse.""",
 244             ang = """Used if ''TIDAL FLATS'' is true
 245    1 : EQUATIONS SOLVED EVERYWHERE WITH CORRECTION ON TIDAL FLATS
 246    2 : DRY ELEMENTS FROZEN
 247 It is recommended to choose 1 since it ensures mass conservation.""",
 248         ),
 249 #       -----------------------------------
 250         MINIMAL_VALUE_OF_THE_WATER_HEIGHT = SIMP(statut ='o',
 251 #       -----------------------------------
 252             typ = 'R',
 253             defaut = 1.E-3,
 254             fr = """Fixe la valeur minimale de la hauteur d''eau.
 255 Est utilise lorsque le mot cle BANCS DECOUVRANTS est egal a oui.""",
 256             ang = """Sets the minimum value of the water depth.
 257 Is used when the keyword TIDAL FLATS is equal to yes.""",
 258         ),
 259 #       -----------------------------------
 260         TIDAL_FLATS = SIMP(statut ='o',
 261 #       -----------------------------------
 262             typ = bool,
 263             defaut = True,
 264             fr = """permet de supprimer les tests sur les bancs decouvrants, dans
 265 les cas ou l''on est certain qu''il n''y en aura pas.
 266 En cas de doute : oui""",
 267             ang = """When no, the specific treatments for tidal flats
 268 are by-passed.
 269 This spares time, but of course you must be sure that you
 270 have no tidal flats""",
 271         ),
 272     ),
 273 )
 274 # -----------------------------------------------------------------------
 275 MISCELLANEOUS = PROC(nom= "MISCELLANEOUS",op = None,
 276 # -----------------------------------------------------------------------
 277 #   -----------------------------------
 278     NESTOR = SIMP(statut ='f',
 279 #   -----------------------------------
 280         typ = bool,
 281         defaut = [False],
 282         fr = """Pour le couplage avec NESTOR""",
 283         ang = """For coupling with NESTOR""",
 284     ),
 285 #   -----------------------------------
 286     NESTOR_ACTION_FILE = SIMP(statut ='f',
 287 #   -----------------------------------
 288         typ = ('Fichier','All Files (*)'), max='**',
 289         defaut = '',
 290         fr = """Nom du fichier de commandes de nestor""",
 291         ang = """Name of the Nestor steering file""",
 292     ),
 293 #   -----------------------------------
 294     NESTOR_POLYGON_FILE = SIMP(statut ='f',
 295 #   -----------------------------------
 296         typ = ('Fichier','All Files (*)'), max='**',
 297         defaut = '',
 298         fr = """Nom du fichier de polygons de Nestor""",
 299         ang = """Name of the Nestor polygon file""",
 300     ),
 301 #   -----------------------------------
 302     NESTOR_RESTART_FILE = SIMP(statut ='f',
 303 #   -----------------------------------
 304         typ = ('Fichier','All Files (*)'), max='**',
 305         defaut = '',
 306         fr = """Nom du fichier de phydef-cf.cfg.ds de Nestor""",
 307         ang = """Name of the Nestor file phydef-cf.cfg.ds""",
 308     ),
 309 #   -----------------------------------
 310     NESTOR_SURFACE_REFERENCE_FILE = SIMP(statut ='f',
 311 #   -----------------------------------
 312         typ = ('Fichier','All Files (*)'), max='**',
 313         defaut = '',
 314         fr = """Nom du fichier de reference surface de Nestor""",
 315         ang = """Name of the Nestor file which contains the reference
 316          water surface""",
 317     ),
 318 )
 319 # -----------------------------------------------------------------------
 320 GENERAL = PROC(nom= "GENERAL",op = None,
 321 # -----------------------------------------------------------------------
 322 #   -----------------------------------
 323     FLUXLINE_INPUT_FILE = SIMP(statut ='f',
 324 #   -----------------------------------
 325         typ = ('Fichier','All Files (*)'),
 326         defaut = '',
 327         fr = """Nom du fichier de fluxline""",
 328         ang = """Name of the Fluxline file""",
 329     ),
 330 #   -----------------------------------
 331     FLUXLINE = SIMP(statut ='f',
 332 #   -----------------------------------
 333         typ = bool,
 334         defaut = False,
 335         fr = """FLUXLINE""",
 336         ang = """Use Fluxline to compute flux over lines""",
 337     ),
 338 #   -----------------------------------
 339     CONTROL_SECTIONS = SIMP(statut ='f',
 340 #   -----------------------------------
 341         typ = 'I', min= 3, max= 3,
 342         fr = """Couples de points (numeros globaux dans le maillage) entre
 343 lesquels les debits instantanes et cumules seront donnes.""",
 344         ang = """Couples of points (global numbers in the mesh) defining sections
 345  where the instantaneous and cumulated discharges will be given""",
 346     ),
 347 #   -----------------------------------
 348     SECONDARY_CURRENTS = SIMP(statut ='f',
 349 #   -----------------------------------
 350         typ = bool,
 351         defaut = [False],
 352         fr = """Pour prendre en compte les courants secondaires""",
 353         ang = """using the parametrisation for secondary currents""",
 354     ),
 355 #   -----------------------------------
 356     SECONDARY_CURRENTS_FILE = SIMP(statut ='f',
 357 #   -----------------------------------
 358         typ = bool,
 359         defaut = [False],
 360         fr = """Pour prendre en compte les courants secondaires avec FICHIER""",
 361         ang = """The radii needed for the parametrisation of secondary currents
 362 are read from SELAFIN file""",
 363     ),
 364 #   -----------------------------------
 365     EFFECT_OF_WAVES = SIMP(statut ='f',
 366 #   -----------------------------------
 367         typ = bool,
 368         defaut = False,
 369         fr = """Prend en compte l''effet de la houle sur le transport solide""",
 370         ang = """Takes into account the effect of waves""",
 371     ),
 372 #   -----------------------------------
 373     TYPE_OF_WAVES = SIMP(statut ='f',
 374 #   -----------------------------------
 375         typ = 'I',
 376         defaut = 2,
 377         fr = """Utilise pour calculer Uw
 378  Si Uw est calcule par Tomawac, choisir 2 (defaut)
 379  1= vagues regulieres (monochormatique)
 380  2= vagues irregulieres (spectre)""",
 381         ang = """is used to calculate Uw
 382  if Uw is calculated with Tomawac, choose 2 (default)
 383  1= regular (monochromatic) waves
 384  2= irregular (spectral) waves""",
 385     ),
 386 )
 387 # -----------------------------------------------------------------------
 388 COHESIVE_AND_NON_COHESIVE = PROC(nom= "COHESIVE_AND_NON_COHESIVE",op = None,
 389 # -----------------------------------------------------------------------
 390 #   -----------------------------------
 391     BED_MODEL = SIMP(statut ='f',
 392 #   -----------------------------------
 393         typ = 'I',
 394         defaut = 1,
 395         fr = """3 types de modeles de lit sont disponibles :
 396 1 : multicouche (couche active automatique si plusieurs classes)
 397 2 : multicouche avec consolidation
 398 3 : consolidation basee sur la theorie de Gibson""",
 399         ang = """3 kinds of bed model are available:
 400 1 : multilayers (automatic active layer if several classes)
 401 2 : multilayer with consolidation
 402 3 : consolidation model based on Gibson theory""",
 403     ),
 404 #   -----------------------------------
 405     CHARRIAGE = FACT(statut='o',
 406 #   -----------------------------------
 407 #       -----------------------------------
 408         CLASSES_SHIELDS_PARAMETERS = SIMP(statut ='f',
 409 #       -----------------------------------
 410             typ = 'R', min= 2, max= 2,
 411             defaut = [-9.,-9.],
 412             fr = """Utilise pour determiner la valeur de la contrainte critique
 413 d''entrainement (sediments non-cohesifs). En multiclasse, specifier la
 414 valeur pour chaque classe.  Donner valeur negative pour les sediments
 415 cohesifs.""",
 416             ang = """Used to determine the critical bed shear stress value
 417 (non-cohesive sediments).
 418 For multi grain size,
 419 the shields parameter needs to be specified for each class.
 420 It is necessary to give a negative value
 421 in the parameter file for cohesive sediments.""",
 422         ),
 423     ),
 424 #   -----------------------------------
 425     SUSPENSION = FACT(statut='o',
 426 #   -----------------------------------
 427 #       -----------------------------------
 428         CLASSES_SETTLING_VELOCITIES = SIMP(statut ='f',
 429 #       -----------------------------------
 430             typ = 'R', min= 2, max= 2,
 431             defaut = [-9,-9.],
 432             fr = """Fixe la valeur de vitesse de chute pour chaque sediment. Donner une
 433 valuer negative pour utiliser les formules de Stokes, Zanke ou Van
 434 Rijn (appliquées selon la taille des grains).""",
 435             ang = """Sets the value of settling velocity for every sediment. Give a
 436 negative value to use the Stokes, Zanke or Van Rijn formulae
 437 (depending on the grain size)""",
 438         ),
 439 #       -----------------------------------
 440         EQUILIBRIUM_INFLOW_CONCENTRATION = SIMP(statut ='f',
 441 #       -----------------------------------
 442             typ = bool,
 443             defaut = [False],
 444             fr = """Impose la concentration en entree du domaine dans les cas 2D.
 445 Pour les sediments non-cohesifs, la concentration d''equilibre est
 446 calculee en accord avec la formule de transport pour tous les sable.""",
 447             ang = """Imposes the equilibrium concentration at the inlet boundaries in 2D
 448 cases.
 449 For non cohesive sediments, the equilibrium near bed concentration is
 450 computed with respect to the suspension transport formula for all
 451 sands.""",
 452         ),
 453     ),
 454 #   -----------------------------------
 455     BED_MATERIAL = FACT(statut='o',
 456 #   -----------------------------------
 457 #       -----------------------------------
 458         CLASSES_SEDIMENT_DIAMETERS = SIMP(statut ='f',
 459 #       -----------------------------------
 460             typ = 'R', min= 2, max= 2,
 461             defaut = [.01,.01],
 462             fr = """Sets value of diameter dm for particular size class.""",
 463             ang = """Sets value of diameter dm for particular size class.""",
 464         ),
 465 #       -----------------------------------
 466         CLASSES_HIDING_FACTOR = SIMP(statut ='f',
 467 #       -----------------------------------
 468             typ = 'R', min= 2, max= 2,
 469             defaut = [1.,1.],
 470             fr = """Fixe la valeur du facteur de pavage par classe
 471 granulometrique""",
 472             ang = """Sets value of hiding factor for particular size class.""",
 473         ),
 474 #       -----------------------------------
 475         CLASSES_INITIAL_FRACTION = SIMP(statut ='f',
 476 #       -----------------------------------
 477             typ = 'R', min= 2, max= 2,
 478             defaut = [1.,0.],
 479             fr = """Fixe la fraction initiale de chaque classe sédimentologique
 480 dans le mélange. Attention, la somme de AVA0 sur toutes les
 481 classes doit valoir 1.""",
 482             ang = """Sets the value of the initial fraction of each sediment class.
 483 Beware that the sum over all classes must be equal to 1.""",
 484         ),
 485 #       -----------------------------------
 486         LAYERS_INITIAL_THICKNESS = SIMP(statut ='f',
 487 #       -----------------------------------
 488             typ = 'R', min= 2, max= 2,
 489             fr = """Epaisseurs initiales des sediments (m).""",
 490             ang = """Sediment layers thickness (m) for initialisation.""",
 491         ),
 492 #       -----------------------------------
 493         CLASSES_TYPE_OF_SEDIMENT = SIMP(statut ='o',
 494 #       -----------------------------------
 495             typ = 'TXM', min= 2, max= 2,
 496             fr = """Liste des types de sediment: cohesif (CO) ou non cohesif (NCO).""",
 497             ang = """ Liste of types of sediment: cohesive (CO) ou non cohesive (NCO).""",
 498         ),
 499     ),
 500 )
 501 # -----------------------------------------------------------------------
 502 BED_STRUCTURE = PROC(nom= "BED_STRUCTURE",op = None,
 503 # -----------------------------------------------------------------------
 504 #   -----------------------------------
 505     INITIALIZATION = FACT(statut='o',
 506 #   -----------------------------------
 507 #       -----------------------------------
 508         NUMBER_OF_LAYERS_FOR_INITIAL_STRATIFICATION = SIMP(statut ='f',
 509 #       -----------------------------------
 510             typ = 'I',
 511             defaut = 1,
 512             fr = """Nombre de couche du lit initial, defaut NUMSTRAT=1""",
 513             ang = """Number of layers for initial stratification, default NUMSTRAT=1""",
 514         ),
 515     ),
 516 )
 517 # -----------------------------------------------------------------------
 518 USELESS = PROC(nom= "USELESS",op = None,
 519 # -----------------------------------------------------------------------
 520 #   -----------------------------------
 521     VECTOR_LENGTH = SIMP(statut ='f',
 522 #   -----------------------------------
 523         typ = 'I',
 524         defaut = 1,
 525         fr = """longueur du vecteur pour les machines vectorielles.""",
 526         ang = """vector length on vector machines.""",
 527     ),
 528 #   -----------------------------------
 529     STEERING_FILE = SIMP(statut ='o',
 530 #   -----------------------------------
 531         typ = ('Fichier','All Files (*)'), max='**',
 532         defaut = '',
 533         fr = """Nom du fichier contenant les parametres du calcul
 534 a realiser. Il peut-etre ecrit par l''utilisateur avec EDAMOX.""",
 535         ang = """Name of the file containing the parameters
 536 of the computation. Could be written by the user with EDAMOX.""",
 537     ),
 538 )
 539 # -----------------------------------------------------------------------
 540 INPUT_OUTPUT__FILES = PROC(nom= "INPUT_OUTPUT__FILES",op = None,
 541 # -----------------------------------------------------------------------
 542 #   -----------------------------------
 543     GEOMETRY_FILE_FORMAT = SIMP(statut ='f',
 544 #   -----------------------------------
 545         typ = 'TXM',
 546         into = ['SERAFIN','SERAFIND','MED'],
 547         defaut = 'SERAFIN',
 548         fr = """Format du fichier de geometrie.
 549 Les valeurs possibles sont :
 550 - SERAFIN : format standard simple precision pour Telemac;
 551 - SERAFIND: format standard double precision pour Telemac;
 552 - MED     : format MED base sur HDF5""",
 553         ang = """Geometry file format.
 554 Possible values are:
 555 - SERAFIN : classical single precision format in Telemac;
 556 - SERAFIND: classical double precision format in Telemac;
 557 - MED     : MED format based on HDF5""",
 558     ),
 559 #   -----------------------------------
 560     NAMES = FACT(statut='o',
 561 #   -----------------------------------
 562 #       -----------------------------------
 563         GEOMETRY_FILE = SIMP(statut ='f',
 564 #       -----------------------------------
 565             typ = ('Fichier','All Files (*)'), max='**',
 566             fr = """Nom du fichier contenant le maillage du calcul a realiser.""",
 567             ang = """Name of the file containing the mesh. This file may also
 568 contain the topography and the friction coefficients.""",
 569         ),
 570 #       -----------------------------------
 571         NAMES_OF_PRIVATE_VARIABLES = SIMP(statut ='f',
 572 #       -----------------------------------
 573             typ = 'TXM', min= 2, max= 2,
 574             fr = """Noms des variables privees en 32 caracteres, 16 pour le nom
 575          16 pour l''unite. Elles correspondent au bloc PRIVE
 576          et peuvent etre lues dans le fichier de geometrie si elles
 577          y sont presentes avec leur nom""",
 578             ang = """Name of private variables in 32 characters, 16 for the name,
 579          16 for the unit. They are stored in the block PRIVE and
 580          can be read in the geometry file if they are here with their
 581          name""",
 582         ),
 583 #       -----------------------------------
 584         BEDLOAD_BOUNDARIES_FILE = SIMP(statut ='f',
 585 #       -----------------------------------
 586             typ = ('Fichier','All Files (*)'), max='**',
 587             defaut = '',
 588             fr = """Fichier de variations en temps des conditions aux limites en charriage.
 589 Les donnees de ce fichier sont sur le canal GAI\_FILES(GAILIQ)%LU.""",
 590             ang = """Variations in time of boundary conditions in bedload. Data of this file
 591 are read on channel GAI\_FILES(GAILIQ)%LU.""",
 592         ),
 593     ),
 594 )
 595 # -----------------------------------------------------------------------
 596 RESULTS = PROC(nom= "RESULTS",op = None,
 597 # -----------------------------------------------------------------------
 598 #   -----------------------------------
 599     RESULTS_FILE_FORMAT = SIMP(statut ='f',
 600 #   -----------------------------------
 601         typ = 'TXM',
 602         into = ['SERAFIN','SERAFIND','MED'],
 603         defaut = 'SERAFIN',
 604         fr = """Format du fichier de resultats.
 605 Les valeurs possibles sont :
 606 - SERAFIN : format standard simple precision pour Telemac;
 607 - SERAFIND: format standard double precision pour Telemac;
 608 - MED     : format MED base sur HDF5""",
 609         ang = """Results file format. Possible values are:
 610 - SERAFIN : classical single precision format in Telemac;
 611 - SERAFIND: classical double precision format in Telemac;
 612 - MED     : MED format based on HDF5""",
 613     ),
 614 #   -----------------------------------
 615     RESULTS_FILE = SIMP(statut ='f',
 616 #   -----------------------------------
 617         typ = ('Fichier','All Files (*)','Sauvegarde'), max='**',
 618         fr = """Nom du fichier dans lequel seront ecrits les resultats avec
 619 une periodicite donnee par le mot cle PERIODE DE SORTIE GRAPHIQUE
 620 dans telemac2d ou telemac3d.""",
 621         ang = """Name of the file into wich the computation results shall be
 622 written, the periodicity being given by the keyword
 623 GRAPHIC PRINTOUT PERIOD in telemac2d or telemac3d.""",
 624     ),
 625 #   -----------------------------------
 626     VARIABLES_TO_BE_PRINTED = SIMP(statut ='f',
 627 #   -----------------------------------
 628         typ = 'TXM', max='**',
 629         into = ["velocity along x axis (m/s)","velocity along y axis (m/s)","wawe celerity (m/s)","water depth (m)","free surface elevation (m)","bottom elevation (m)","Froude number","scalar flowrate of fluid (m2/s)","flowrate along x axis (m2/s)","flowrate along y axis (m2/s)","bed-load discharge (m2/s)","bed-load discharge along x axis (m2/s)","bed-load discharge along y axis (m2/s)","bottom evolution (m)","non erodable bottom","bed friction coefficient (m if Nikuradse)","mean bottom friction (N/m2)","wave angle with axis Oy (deg)","wave height","wave period","fraction of sediment of class i in the first layer","fraction of sediment of class i in the second layer","bed load transport rate of sediment of class i", "thicknes of bed layer i", "concentration of bed layer i ","concentration for class i","supplementary variable A","supplementary variable G","supplementary variable L","supplementary variable O"],
 630         defaut = '',
 631         fr = """Nom des variables que l''utilisateur desire ecrire sur
 632 le lisring. Meme possibilites que pour les sorties graphiques.""",
 633         ang = """Names of variables the user wants to write on the listing.
 634 Each variable is represented by a letter in the same manner as
 635 it is done in the graphic results file.""",
 636     ),
 637 #   -----------------------------------
 638     LISTING_PRINTOUT_PERIOD = SIMP(statut ='f',
 639 #   -----------------------------------
 640         typ = 'I',
 641         defaut = 1,
 642         fr = """Determine la periode en nombre de pas de temps d''impression
 643 des ''VARIABLES A IMPRIMER'' (voir ce mot-cle).
 644 La sortie des resultats est effectuee sur le fichier listing
 645 (fichier cas\_numerodeprocessus.sortie sur station de travail).""",
 646         ang = """Determines, in number of time steps, the printout period of
 647 the ''VARIABLES TO BE PRINTED''.
 648 The results are printed out on the listing file
 649 (file cas\_numerodeprocessus.sortie on a workstation).""",
 650     ),
 651 #   -----------------------------------
 652     MASS_BALANCE = SIMP(statut ='f',
 653 #   -----------------------------------
 654         typ = bool,
 655         defaut = False,
 656         fr = """Determine si oui ou non le bilan de masse est realise.""",
 657         ang = """Determines whether a check of the mass-balance over the domain
 658 is made or not""",
 659     ),
 660 #   -----------------------------------
 661     SECTIONS_OUTPUT_FILE = SIMP(statut ='f',
 662 #   -----------------------------------
 663         typ = ('Fichier','All Files (*)','Sauvegarde'),
 664         defaut = '',
 665         fr = """sections output file, written by the master""",
 666         ang = """sections output file, written by the master""",
 667     ),
 668 #   -----------------------------------
 669     C_VSM_RESULTS_FILE = SIMP(statut ='f',
 670 #   -----------------------------------
 671         typ = ('Fichier','All Files (*)','Sauvegarde'), max='**',
 672         defaut = '',
 673         fr = """Nom du fichier dans lequel seront ecrits les resultats C-VSM du
 674 calcul avec la periodicite donnee par le mot cle
 675 \telkey{C-VSM FULL PRINTOUT PERIOD}.""",
 676         ang = """Name of the file into which the C-VSM results of the computation
 677 are written, the periodicity being given by the keyword:
 678 \telkey{C-VSM FULL PRINTOUT PERIOD}.""",
 679     ),
 680 #   -----------------------------------
 681     C_VSM_RESULTS_FILE_FORMAT = SIMP(statut ='f',
 682 #   -----------------------------------
 683         typ = 'TXM',
 684         into = ['SERAFIN','SERAFIND','MED'],
 685         defaut = 'SERAFIN',
 686         fr = """Format du \telkey{FICHIER DES C-VSM}.
 687 Les valeurs possibles sont :
 688 \begin{itemize}
 689 \item SERAFIN : format standard simple precision pour \tel ;
 690 \item SERAFIND: format standard double precision pour \tel ;
 691 \item MED     : format MED double precision base sur HDF5.
 692 \end{itemize}""",
 693         ang = """Format of the \telkey{C-VSM RESULT FILE}. Possible choices are:
 694 \begin{itemize}
 695 \item SERAFIN : classical single precision format in \tel,
 696 \item SERAFIND: classical double precision format in \tel,
 697 \item MED     : MED double precision format based on HDF5.
 698 \end{itemize}""",
 699     ),
 700 )
 701 # -----------------------------------------------------------------------
 702 DATA_FILES = PROC(nom= "DATA_FILES",op = None,
 703 # -----------------------------------------------------------------------
 704 #   -----------------------------------
 705     WAVE_FILE_FORMAT = SIMP(statut ='f',
 706 #   -----------------------------------
 707         typ = 'TXM',
 708         into = ['SERAFIN','SERAFIND','MED'],
 709         defaut = 'SERAFIN',
 710         fr = """Format du fichier de houle.
 711 Les valeurs possibles sont :
 712 - SERAFIN : format standard simple precision pour Telemac;
 713 - SERAFIND: format standard double precision pour Telemac;
 714 - MED     : format MED base sur HDF5""",
 715         ang = """Wave file format.
 716 Possible values are:
 717 - SERAFIN : classical single precision format in Telemac;
 718 - SERAFIND: classical double precision format in Telemac;
 719 - MED     : MED format based on HDF5""",
 720     ),
 721 #   -----------------------------------
 722     FORTRAN_FILE = SIMP(statut ='f',
 723 #   -----------------------------------
 724         typ = ('Fichier','All Files (*)'), max='**',
 725         defaut = '',
 726         fr = """Nom du fichier FORTRAN a soumettre.""",
 727         ang = """Name of FORTRAN file to be submitted.""",
 728     ),
 729 #   -----------------------------------
 730     BOUNDARY_CONDITIONS_FILE = SIMP(statut ='f',
 731 #   -----------------------------------
 732         typ = ('Fichier','All Files (*)'), max='**',
 733         fr = """Nom du fichier contenant les types de conditions aux limites.
 734 Ce fichier est rempli de facon automatique par le mailleur au moyen de
 735 couleurs affectees aux noeuds des frontieres du domaine de calcul.""",
 736         ang = """Name of the file containing the types of boundary conditions.
 737 This file is filled automatically by the mesh generator through
 738 colours that are assigned to the computation domain boundary nodes.""",
 739     ),
 740 #   -----------------------------------
 741     WAVE_FILE = SIMP(statut ='f',
 742 #   -----------------------------------
 743         typ = ('Fichier','All Files (*)'), max='**',
 744         defaut = '',
 745         fr = """Nom d''un fichier contenant les resultats d''un calcul
 746 precedent TOMAWAC realise sur le meme maillage. La houle sera donnee,
 747 par le dernier pas de temps
 748 de ce fichier . Seules les donnees de houle de ce fichier
 749 seront conservees (hauteur de houle, periode de
 750 houle, angle de la houle).
 751 Les donnees hydrodynamiques(hauteur d''eau,vitesses) seront lues
 752 dans le fichier hydrodynamique (Verifier la compatibilite !!!)
 753 Les donnees de houle peuvent aussi etre imposees
 754 par l''utilisateur dans le sous programme USER\_FORCING\_GAIA.
 755 ou encore lues dans le fichier hydrodynamique.""",
 756         ang = """Name of a file containing the results a previous
 757 TOMAWAC computation  made on the same mesh. The wave data (wave height,
 758  wave period, wave angle ) will
 759 be given by the last record of the file.
 760 The user has to verify that both informations (wave and current data)
 761 are consistent.
 762 Remark :The wave data can also be specified in
 763  the hydrodynamic file. the user has also
 764  the possibility to give the values
 765 of the wave data in the subroutine USER\_FORCING\_GAIA.
 766 This is recommended for non-steady flow simulation.""",
 767     ),
 768 #   -----------------------------------
 769     BOTTOM_TOPOGRAPHY_FILE = SIMP(statut ='f',
 770 #   -----------------------------------
 771         typ = ('Fichier','All Files (*)'), max='**',
 772         defaut = '',
 773         fr = """Nom du fichier facultatif contenant la bathymetrie
 774 associee au maillage.""",
 775         ang = """Name of the possible file containing the bathymetric data.""",
 776     ),
 777 #   -----------------------------------
 778     SECTIONS_INPUT_FILE = SIMP(statut ='f',
 779 #   -----------------------------------
 780         typ = ('Fichier','All Files (*)'),
 781         defaut = '',
 782         fr = """sections input file, partitioned""",
 783         ang = """sections input file, partitioned""",
 784     ),
 785 )
 786 # -----------------------------------------------------------------------
 787 INITIAL_CONDITIONS = PROC(nom= "INITIAL_CONDITIONS",op = None,
 788 # -----------------------------------------------------------------------
 789 #   -----------------------------------
 790     PREVIOUS_SEDIMENTOLOGICAL_COMPUTATION_FILE_FORMAT = SIMP(statut ='f',
 791 #   -----------------------------------
 792         typ = 'TXM',
 793         into = ['SERAFIN','SERAFIND','MED'],
 794         defaut = 'SERAFIN',
 795         fr = """Format du fichier de resultats du calcul precedent.
 796 Les valeurs possibles sont :
 797 - SERAFIN : format standard simple precision pour Telemac;
 798 - SERAFIND: format standard double precision pour Telemac;
 799 - MED     : format MED base sur HDF5""",
 800         ang = """Previous computation results file format.
 801 Possible values are:
 802 - SERAFIN : classical single precision format in Telemac;
 803 - SERAFIND: classical double precision format in Telemac;
 804 - MED     : MED format based on HDF5""",
 805     ),
 806 #   -----------------------------------
 807     PREVIOUS_SEDIMENTOLOGICAL_COMPUTATION_FILE = SIMP(statut ='f',
 808 #   -----------------------------------
 809         typ = ('Fichier','All Files (*)'), max='**',
 810         defaut = '',
 811         fr = """Nom d''un fichier contenant les resultats d''un
 812 calcul precedent sedimentologique realise sur le meme maillage
 813 et dont le dernier pas de temps enregistre va fournir les
 814 conditions initiales pour une suite de de calcul.""",
 815         ang = """Name of a file containing the results of an
 816 earlier  sedimentological computation which was made
 817 on the same mesh. The last recorded time step will provide
 818 the initial conditions for the new computation.""",
 819     ),
 820 #   -----------------------------------
 821     COMPUTATION_CONTINUED = SIMP(statut ='f',
 822 #   -----------------------------------
 823         typ = bool,
 824         defaut = [False],
 825         fr = """Determine si le calcul en cours est independant de tout autre
 826 resultat ou est une reprise effectuee a partir du resultat d''un calcul
 827 precedent.
 828 NON : Il s''agit du premier passage pour ce calcul et il est necessaire
 829 de definir un jeu complet de conditions initiales
 830 OUI : Il s''agit d''une reprise de calcul :
 831 les conditions initiales sont constituees par le dernier pas de temps du
 832 FICHIER PRECEDENT SEDIMENTOLOGIQUE du fichier des parametres utilise
 833 pour soumettre le calcul.
 834 Par contre, l''ensemble des donnees du fichier des parametres
 835 peuvent etre redefinies
 836 De meme, il est necessaire de definir des conditions aux limites""",
 837         ang = """Determines whether the computation under way is an independent
 838 result or is following an earlier result.
 839 NO: It is the first run for this computation and a whole set of
 840 initial conditions should be defined.
 841 YES: It follows a former computation:
 842 the initial conditions consist in the last time step of the
 843 PREVIOUS COMPUTATION FILE
 844 in the steering file used for submitting the computation.
 845 All the data from the steering file may be defined once again, which
 846 provides an opportunity to change, for example, the time step.
 847 It is also possible to define new boundary conditions.""",
 848     ),
 849 )
 850 # -----------------------------------------------------------------------
 851 INPUT_OUTPUT__GRAPHICS_AND_LISTING = PROC(nom= "INPUT_OUTPUT__GRAPHICS_AND_LISTING",op = None,
 852 # -----------------------------------------------------------------------
 853 #   -----------------------------------
 854     VARIABLES_FOR_GRAPHIC_PRINTOUTS = SIMP(statut ='f',
 855 #   -----------------------------------
 856         typ = 'TXM', min=0, max='**',
 857         into = ["velocity along x axis (m/s)","velocity along y axis (m/s)","water depth (m)","free surface elevation (m)","bottom elevation (m)","scalar flowrate of fluid (m2/s)","flowrate along x axis (m2/s)","flowrate along y axis (m2/s)","non erodable bottom","Bed Shear stress (Totalfriction) (N/m2)","wave height","wave period","wave angle with axis Oy (deg)","bed-load discharge (kg/(m*s))","bed-load discharge along x axis (kg/(m*s))","bed-load discharge along y axis (kg/(m*s))","bottom evolution (m)","total bed roughness (m)","Skin friction correction factor","Mean grain diameter","wave orbital velocity (m/s)","fraction of non cohesive sediment of class i, in 1st layer","fraction of non cohesive sediment of class i, in 2nd layer","fraction of non cohesive sediment of class i, in k layer","solid transport load of class i","mass concentration of class i","mass concentration of class i for 2D graphic printouts          (only for 3D simulations)","sediment viscosity along x axis (m2/s) - only 3D","sediment viscosity along y axis (m2/s) - only 3D","sediment viscosity along z axis (m2/s) - only 3D","bed load transport rate (kg/(m*s))","bed load transport rate x axis","bed load transport rate y axis","bedload transport rate of class i","thickness of the k layer","concentration of bed layer k","bed load transport rate of sediment of class i","supplementary variable A","supplementary variable G","supplementary variable L","supplementary variable O","fraction of cohesive sediment of class i, in 1st layer","fraction of cohesive sediment of class i, in 2nd layer","fraction of cohesive sediment of class i, in k layer","porosity of k layer","mass of non cohesive sediment of class i, in 1st layer","mass of non cohesive sediment of class i, in 2nd layer","mass of non cohesive sediment of class i, in k layer","mass of cohesiv],
 858         defaut = ["velocity along x axis (m/s)","velocity along y axis (m/s)","water depth (m)","free surface elevation (m)","bottom elevation (m)","non erodable bottom","bottom evolution (m)"],
 859         fr = """Noms des variables que l''utilisateur veut ecrire dans
 860 le fichier des resultats.
 861 Chaque variable est representee par une lettre.
 862 Le choix des separateurs est libre. Voir CHOIX ci-dessus.
 863  On peut utiliser *, *A* signifie : toutes les fractions""",
 864         ang = """Names of variables the user wants to write
 865 into the graphic results file.
 866 Each variable is represented by a letter. See CHOIX1 above.
 867  One can use *, *A* means all fractions""",
 868     ),
 869 )
 870 # -----------------------------------------------------------------------
 871 TIME = PROC(nom= "TIME",op = None,
 872 # -----------------------------------------------------------------------
 873 #   -----------------------------------
 874     NUMBER_OF_SUB_ITERATIONS = SIMP(statut ='f',
 875 #   -----------------------------------
 876         typ = 'I',
 877         defaut = [1],
 878         fr = """permet de realiser des sous iterations au sein de la
 879 boucle en temps (En mode non permananet).
 880 Peut etre utile en non permanent lorsque le
 881 pas de temps qui est donne par le pas de sortie graphique du
 882 FICHIER DE CALCUL PRECEDENT est trop grand.""",
 883         ang = """enable to realize sub-iteration inside a time step
 884 (this key word is not used if the key word VARIABLE TIME-STEP
 885 is set equal to yes). It could be useful for a non steady case
 886 be useful for a non steady case when the time step which is fixed
 887 by the graphic printout period of the HYDRODYNAMIC FILE
 888 is too large.""",
 889     ),
 890 #   -----------------------------------
 891     ORIGINAL_HOUR_OF_TIME = SIMP(statut ='f',
 892 #   -----------------------------------
 893         typ = 'I', min= 3, max= 3,
 894         defaut = [0,0,0],
 895         fr = """Permet de fixer l''heure d''origine des temps du modele lors
 896 de la prise en compte de la force generatrice de la maree.""",
 897         ang = """Give the time of the time origin of the model when taking into
 898 account of the tide generator force.""",
 899     ),
 900 #   -----------------------------------
 901     ORIGINAL_DATE_OF_TIME = SIMP(statut ='f',
 902 #   -----------------------------------
 903         typ = 'I', min= 3, max= 3,
 904         defaut = [0,0,0],
 905         fr = """Permet de fixer la date d''origine des temps du modele lors
 906 de la prise en compte de la force generatrice de la maree.""",
 907         ang = """Give the date of the time origin of the model when taking into
 908 account the tide generating force.""",
 909     ),
 910 )
 911 # -----------------------------------------------------------------------
 912 NON_COHESIVE = PROC(nom= "NON_COHESIVE",op = None,
 913 # -----------------------------------------------------------------------
 914 #   -----------------------------------
 915     LAYERS_NON_COHESIVE_BED_POROSITY = SIMP(statut ='f',
 916 #   -----------------------------------
 917         typ = 'R', min= 2, max= 2,
 918         defaut = [0.4,0.4],
 919         fr = """la concentration volumique  du lit est definie par
 920 CSF= (1-porosite)
 921 Ce parametre est utilise pour les sediments non-cohesifs.""",
 922         ang = """The bed volume concentration CSF=(1-porosity) is used to
 923 calculate the bed evolution of non-cohesive sand transport.""",
 924     ),
 925 #   -----------------------------------
 926     CHARRIAGE = FACT(statut='o',
 927 #   -----------------------------------
 928 #       -----------------------------------
 929         BOUNDARY_CONDITIONS = FACT(statut='o',
 930 #       -----------------------------------
 931 #           -----------------------------------
 932             CLASSES_IMPOSED_SOLID_DISCHARGES_DISTRIBUTION = SIMP(statut ='f',
 933 #           -----------------------------------
 934                 typ = 'R', min= 2, max= 2,
 935                 fr = """Donne la proportion du debit solide total impose par classe.
 936 Donner un nombre par classe de non-cohesifs""",
 937                 ang = """Gives the proportion of the imposed solid discharge for each class.
 938 Give one numbre for each non-cohesive class""",
 939             ),
 940         ),
 941     ),
 942 #   -----------------------------------
 943     BEDLOAD = FACT(statut='o',
 944 #   -----------------------------------
 945 #       -----------------------------------
 946         MORPHOLOGICAL_FACTOR_ON_TIME_SCALE = SIMP(statut ='f',
 947 #       -----------------------------------
 948             typ = 'R',
 949             defaut = 1.,
 950             fr = """Coefficient d''amplification de l''echelle des temps""",
 951             ang = """amplification coefficient of time scale""",
 952         ),
 953 #       -----------------------------------
 954         MORPHOLOGICAL_FACTOR_ON_BED_EVOLUTION = SIMP(statut ='f',
 955 #       -----------------------------------
 956             typ = 'R',
 957             defaut = 1.,
 958             fr = """Coefficient d''amplification de l''evolution du lit""",
 959             ang = """amplification coefficient of bed evolution""",
 960         ),
 961 #       -----------------------------------
 962         MINIMUM_DEPTH_FOR_BEDLOAD = SIMP(statut ='f',
 963 #       -----------------------------------
 964             typ = 'R',
 965             defaut = 1.E-2,
 966             fr = """Suppression des flux de sediment de et vers les points secs""",
 967             ang = """To cancel sediment fluxes to and from dry points""",
 968         ),
 969 #       -----------------------------------
 970         BED_LOAD_FOR_ALL_SANDS = SIMP(statut ='f',
 971 #       -----------------------------------
 972             typ = bool,
 973             defaut = False,
 974             fr = """calcul avec charriage""",
 975             ang = """""",
 976         ),
 977 #       -----------------------------------
 978         BED_LOAD_TRANSPORT_FORMULA_FOR_ALL_SANDS = SIMP(statut ='f',
 979 #       -----------------------------------
 980             typ = 'I',
 981             defaut = 1,
 982             fr = """10 formules de transport solide sont implementees dans GAIA.
 983 Les formules Ne3, Ne30 et Ne9 ne doivent pas etre utilisees en cas de
 984 couplage avec la suspension.
 985 Les formules Ne4, Ne5, Ne8 and Ne9 calculent le taux de transport sous
 986 l''action combinee de la houle et du courant :
 987                  1 : MEYER-PETER (charriage)
 988                  2 : EINSTEIN-BROWN (charriage)
 989                  3 : ENGELUND-HANSEN + CHOLLET ET CUNGE (VERSION 5.3)
 990                  30: ENGELUND-HANSEN (total)
 991                  4 : BIJKER (charriage + suspension)
 992                  5 : SOULSBY - VAN RIJN (charriage + suspension)
 993                  6 : HUNZIKER (uniquement granulometrie etendue)
 994                       DE MASQUAGE DE HUNZIKER APPLIQUEE
 995                      et mot-cle HIDING-FACTOR not used
 996                  7 : VAN RIJN (bed load)
 997                  8 : BAILARD (charriage + suspension)
 998                  9 : DIBAJNIA ET WATANABE (total)
 999                         10 : WILCOCK ET CROWE (granulometrie etendue)
1000 L''utilisateur a aussi la possibilite d''imposer une autre formule de
1001 transport solide (sous-programme bedload\_qb\_user.f) en fixant la
1002 valeur du mot cle a 0 :
1003                  0 :  IMPOSEE PAR L''UTILISATEUR
1004 Attention : dans ce cas, il n''est pas possible de choisir l''option
1005 PAS DE TEMPS VARIABLE.""",
1006             ang = """10 bed-load or total load transport formulas are implemented in
1007 GAIA.
1008 The formula Ne3, Ne30 and Ne9 should not be used in the case of coupling
1009 with the suspension.
1010 The formula Ne4, Ne5, Ne8 and Ne9  model the transport under the
1011 combined action of currents and waves :
1012                  1 : MEYER-PETER (bed load)
1013                  2 : EINSTEIN-BROWN (bed load)
1014                  3 : ENGELUND-HANSEN + CHOLLET AND CUNGE (VERSION 5.3)
1015                  30: ENGELUND-HANSEN (total)
1016                  4 : BIJKER (bed load + suspension)
1017                  5 : SOULSBY - VAN RIJN (bed load + suspension)
1018                  6 : HUNZIKER (only for sand grading)
1019                      IN THIS CASE HIDING FACTOR KEYWORD DISCARDED
1020                      And Hunziker formula used
1021                  7 : VAN RIJN (bed load)
1022                  8  : BAILARD (bed load + suspension)
1023                  9 : DIBAJNIA ET WATANABE (total)
1024                         10 : WILCOCK AND CROWE (graded sediment)
1025 Users can also program other formulas (subroutine bedload\_qb\_user.f)
1026 setting this key word to zero :
1027                  0 : FORMULA PROGRAMMED BY USER
1028 Warning : it is not then possible to choose the option
1029 VARIABLE TIME-STEP""",
1030         ),
1031 #       -----------------------------------
1032         B_VALUE_FOR_THE_BIJKER_FORMULA = SIMP(statut ='f',
1033 #       -----------------------------------
1034             typ = 'R',
1035             defaut = 2.E0,
1036             fr = """Coefficient b de la formule de Bijker""",
1037             ang = """b value for the Bijker formula""",
1038         ),
1039 #       -----------------------------------
1040         MPM_COEFFICIENT = SIMP(statut ='o',
1041 #       -----------------------------------
1042             typ = 'R',
1043             defaut = 8.0E-00,
1044             fr = """""",
1045             ang = """""",
1046         ),
1047 #       -----------------------------------
1048         BOUNDARY_CONDITIONS = FACT(statut='o',
1049 #       -----------------------------------
1050 #           -----------------------------------
1051             PRESCRIBED_SOLID_DISCHARGES = SIMP(statut ='f',
1052 #           -----------------------------------
1053                 typ = 'R', min= 2, max= 2,
1054                 fr = """ Valeurs des debits solides imposes aux frontieres
1055 liquides entrantes (kg/s).
1056 Une valeur par frontiere liquide""",
1057                 ang = """Values of prescribed solid discharges
1058 at the inflow boundaries (kg/s).
1059 One value per liquid boundary""",
1060             ),
1061         ),
1062 #       -----------------------------------
1063         SLOPE_INFLUENCE = FACT(statut='o',
1064 #       -----------------------------------
1065 #           -----------------------------------
1066             FORMULA_FOR_SLOPE_EFFECT = SIMP(statut ='f',
1067 #           -----------------------------------
1068                 typ = 'I',
1069                 defaut = 1,
1070                 fr = """1 : formule de Koch et Flokstra, modifie le transport solide
1071             mot cle associe : BETA
1072         2 : formule de Soulsby, modifie la contrainte seuil, ne peut
1073             donc etre utilisee que avec une formule a seuil.
1074             mot cle associe : ANGLE DE REPOS DU SEDIMENT""",
1075                 ang = """1 : formula of Koch et Flokstra, modification of bed load
1076              linked keyword : BETA
1077          2 : formula of Soulsby, modification critical shear stress,
1078              can only be used with a threshold fomula
1079              linked keyword : FRICTION ANGLE OF THE SEDIMENT""",
1080             ),
1081 #           -----------------------------------
1082             FRICTION_ANGLE_OF_THE_SEDIMENT = SIMP(statut ='f',
1083 #           -----------------------------------
1084                 typ = 'R',
1085                 defaut = 40.,
1086                 fr = """Angle de repos du sediment, intervient pour la prise de compte
1087  de la pente sur la contrainte critique par la formule de Soulsby.
1088 Utiliser si ...=2""",
1089                 ang = """Angle of repose of the sediment. Used in the Soulsby formula to
1090 take into account the influence of bed slope on critical shear stress.
1091 Use if ...=2""",
1092             ),
1093 #           -----------------------------------
1094             FORMULA_FOR_DEVIATION = SIMP(statut ='f',
1095 #           -----------------------------------
1096                 typ = 'I',
1097                 defaut = 1,
1098                 fr = """1 : Koch et Flokstra
1099         2 : formule de Talmon et al. 1995, JHR 33(4) formules (1) et
1100 (17) mot cle associe : BETA2""",
1101                 ang = """1: Koch and Flokstra
1102          2: formula of Talmon et al. 1995, JHR 33(4) formulas (1) and
1103 (17) linked keyword : BETA2""",
1104             ),
1105 #           -----------------------------------
1106             PARAMETER_FOR_DEVIATION = SIMP(statut ='f',
1107 #           -----------------------------------
1108                 typ = 'R',
1109                 defaut = 0.85,
1110                 fr = """Parametre pour la deviation causee par effet de pente
1111  pour la formule de Talmon et al.
1112 Une valeur elevee provoque une faible deviation""",
1113                 ang = """Parameter pour la deviation pour la formule de Talmon et al.""",
1114             ),
1115 #           -----------------------------------
1116             SLOPE_EFFECT = SIMP(statut ='f',
1117 #           -----------------------------------
1118                 typ = bool,
1119                 defaut = [True ],
1120                 fr = """Prise en compte de l''effet de pente :
1121 deviation et modification du seuil critique.
1122 NON supprime les mots-cles
1123  POUR EFFET DE PENTE et  POUR LA DEVIATION""",
1124                 ang = """If yes, slope effect taken into account:
1125 deviation + modification of critical shear stress.
1126 NO will cancel the key-words
1127 FORMULA FOR SLOPE EFFECT and FORMULA FOR DEVIATION""",
1128             ),
1129 #           -----------------------------------
1130             BETA = SIMP(statut ='f',
1131 #           -----------------------------------
1132                 typ = 'R',
1133                 defaut = 1.3,
1134                 fr = """Determine la valeur du coefficient beta qui intervient dans la
1135 formulation de l''effet de pente de Koch et Flokstra.""",
1136                 ang = """Specifies the value of the beta coefficient used in the Koch
1137 and Flokstra slope effect formulation.""",
1138             ),
1139         ),
1140     ),
1141 #   -----------------------------------
1142     FRICTION = FACT(statut='o',
1143 #   -----------------------------------
1144 #       -----------------------------------
1145         RATIO_BETWEEN_SKIN_FRICTION_AND_MEAN_DIAMETER = SIMP(statut ='f',
1146 #       -----------------------------------
1147             typ = 'R',
1148             defaut = 3.0,
1149             fr = """Ratio pour le calcul du frottement de peau.
1150 rugosite de peau = ratio * diametre moyen.
1151 ( pour la granulometrie etendue, le diametre moyen utilise
1152 est une valeur moyenne par noeud calculee a partir de la fraction
1153 et du diametre moyen de chaque sediment en chaque noeud du maillage)""",
1154             ang = """ Ratio for the computation of skin friction.
1155 skin roughness = ratio * mean diameter
1156 (for the mixture of sand, the mean diameter used is a value per node
1157 which is computed thanks to the fraction and the mean diameter of each
1158 sediment for each node of the mesh)
1159 if KSPRATIO =0 : use skin friction prediction from Van Rijn (2007)
1160 for currents and the Wiberg and Harris method for waves""",
1161         ),
1162 #       -----------------------------------
1163         SKIN_FRICTION_CORRECTION = SIMP(statut ='f',
1164 #       -----------------------------------
1165             typ = 'I',
1166             defaut = 1,
1167             fr = """Correction du frottement pour le transport solide (voir aussi KSPRATIO)
1168 pour faire en sorte que le frottement de peau soit utilisé dans
1169 les formules au lieu du frottement issu de l''hydrodynamique,
1170 qui comprend souvent d''autres effets (surtout en 2D)
1171        0 : Pas de correction (TAUP= TOB), valide si la rugosite
1172            donnee a TELEMAC est physique - proche de la rugosite de peau
1173            estimee a 3d50
1174        1 : Correction pour fond plat (KSP= KSPRATIO * D50)
1175        2 : Prise en compte des rides""",
1176             ang = """Formula to modify the shear stress in sediment flow rate formulae
1177 so they use the skin bed roughness (see also KSPRATIO)
1178        0 : No correction (TAUP= TOB), valid if the roughness provided
1179            to TELEMAC is physical - close to the skin roughness, usually
1180            estimated to 3d50
1181        1 : Correction for a flat bed (KSP= KSPRATIO * D50)
1182        2 : Ripple correction factor""",
1183         ),
1184 #       -----------------------------------
1185         ADVANCED = FACT(statut='o',
1186 #       -----------------------------------
1187 #           -----------------------------------
1188             BED_ROUGHNESS_PREDICTOR_OPTION = SIMP(statut ='f',
1189 #           -----------------------------------
1190                 typ = 'I',
1191                 defaut = 1,
1192                 fr = """1 : Fond plat ks=KSPRATIO D50,
1193 2: Fond ride (methode de Wiberg et Harris),
1194 3: Dunes et megarides (methode de Van Rijn)""",
1195                 ang = """1: Flat bed, 2: Rippled bed,
1196 3: Dunes and mega ripples (Method of Van Rijn)""",
1197             ),
1198 #           -----------------------------------
1199             COMPUTE_BED_ROUGHNESS_AT_SEDIMENT_SCALE = SIMP(statut ='f',
1200 #           -----------------------------------
1201                 typ = bool,
1202                 defaut = [False],
1203                 fr = """Calcul de la rugosite de Nikuradse a l''echelle du sediment
1204 - voir OPTION DU PREDICTEUR DE RUGOSITE -. Elle peut etre
1205 differente de la rugosite utilisee pour l''hydrodynamique
1206 dans les cas avec vagues ou avec une granulometrie variable en
1207 temps et en espace. Le frottement
1208 modifie pourra eventuellement etre envoye a Telemac mais ce n''est
1209 pas encore supporte.""",
1210                 ang = """Compute a bed roughness at the sediment scale - see
1211 BED ROUGHNESS PREDICTOR OPTION -. It can be different from
1212 the hydrodynamics roughness due to the action of waves or to
1213 a space-time varying grain size distribution. This roughness
1214 could be sent to Telemac but it is not supported yet.""",
1215             ),
1216         ),
1217     ),
1218 #   -----------------------------------
1219     SUSPENSION = FACT(statut='o',
1220 #   -----------------------------------
1221 #       -----------------------------------
1222         SETTLING_LAG = SIMP(statut ='f',
1223 #       -----------------------------------
1224             typ = bool,
1225             defaut = False,
1226             fr = """Uses the velocity profile based on the Miles approximation""",
1227             ang = """Uses the velocity profile based on the Miles approximation""",
1228         ),
1229 #       -----------------------------------
1230         SUSPENSION_FOR_ALL_SANDS = SIMP(statut ='f',
1231 #       -----------------------------------
1232             typ = bool,
1233             defaut = False,
1234             fr = """Active la suspension pour tous les sables. Il n''est pas possible
1235 d''avoir un comportement different entre classe de sable. La vase
1236 est toujours consideree en suspension.""",
1237             ang = """Activate suspension for all the sands in the simulation. It is not
1238 possible to have a different behaviour between sand classes. Mud
1239 is always considered in suspension.""",
1240         ),
1241 #       -----------------------------------
1242         SUSPENSION_TRANSPORT_FORMULA_FOR_ALL_SANDS = SIMP(statut ='f',
1243 #       -----------------------------------
1244             typ = 'I',
1245             defaut = 1,
1246             fr = """Different formules sont proposees pour le calcul de la concentration
1247 d''equilibre:
1248 1 : formule de Zyserman et Fredsoe
1249 2 : methode de Bijker. La concentration au fond
1250    est reliee au taux de transport par charriage
1251 3 : formule de Van Rijn (1987)
1252 4 : formule de Soulsy\_van Rijn""",
1253             ang = """Different choice to compute the equilibrium near-bed concentration
1254 1 : Zysderman and Fredsoe, equilibrium formula
1255 2: Bijker method. The near bed concentration
1256 is related to the bedload . This option cannot be used
1257 without bedload transport
1258 3: Van Rijn formula
1259 4: Soulsby\_van Rijn formula""",
1260         ),
1261     ),
1262 #   -----------------------------------
1263     BED_MATERIAL = FACT(statut='o',
1264 #   -----------------------------------
1265 #       -----------------------------------
1266         ACTIVE_LAYER_THICKNESS = SIMP(statut ='f',
1267 #       -----------------------------------
1268             typ = 'R',
1269             defaut = [10000.],
1270             fr = """Epaisseur de reference pour la stratification du lit. La
1271 composition de la premiere couche sert a calculer le transport
1272 solide. Utiliser une tres grande valeur pour ne pas avoir de
1273 stratification.""",
1274             ang = """Thickness for bed stratification. Composition of first
1275 layer is used to compute bed load transport rate. If you do not want
1276 a stratification, use a large value""",
1277         ),
1278 #       -----------------------------------
1279         HIDING_FACTOR_FORMULA = SIMP(statut ='f',
1280 #       -----------------------------------
1281             typ = 'I',
1282             defaut = [0],
1283             fr = """4 formules pour le hiding factor sont programmees dans GAIA
1284      0: const => il faut donner le HIDING FACTOR PAR CLASSE
1285      1: Egiazaroff
1286      2: Ashida \& Michiue
1287       :
1288      4: Karim, Holly \& Yang""",
1289             ang = """4 hiding factor formulas are implemented in GAIA
1290      0: const => need to give CLASSES HIDING FACTOR
1291      1: Egiazaroff
1292      2: Ashida \& Michiue
1293       :
1294      4: Karim, Holly \& Yang""",
1295         ),
1296 #       -----------------------------------
1297         CONSTANT_ACTIVE_LAYER_THICKNESS = SIMP(statut ='f',
1298 #       -----------------------------------
1299             typ = bool,
1300             defaut = True,
1301             fr = """epaisseur de couche active constante ou non""",
1302             ang = """constant active layer thickness or not""",
1303         ),
1304 #       -----------------------------------
1305         D90_SAND_DIAMETER_FOR_ONLY_ONE_CLASS = SIMP(statut ='f',
1306 #       -----------------------------------
1307             typ = 'R', min= 2, max= 2,
1308             defaut = [.01],
1309             fr = """Fixe la valeur de D90 pour des simulations avec une
1310  seule classe de sable. Pour des simulations avec plusieurs
1311  classes de sable, D90 est calcule par GAIA.""",
1312             ang = """Sets the value of diameter d90 for simulations with one sand class.
1313  With multiple sand classes, D90 is computed by GAIA.""",
1314         ),
1315     ),
1316 #   -----------------------------------
1317     BED_STRUCTURE = FACT(statut='o',
1318 #   -----------------------------------
1319 #       -----------------------------------
1320         ADVANCED = FACT(statut='o',
1321 #       -----------------------------------
1322 #           -----------------------------------
1323             SEDIMENT_SLIDE = SIMP(statut ='f',
1324 #           -----------------------------------
1325                 typ = bool,
1326                 defaut = [False],
1327                 fr = """Prise en compte de la pente d''equilibre du sable donnee par le
1328 mot-cle ANGLE DE FROTTEMENT DU SEDIMENT""",
1329                 ang = """If yes, the key-word FRICTION ANGLE OF THE SEDIMENT is taken
1330 into account for slope stability""",
1331             ),
1332         ),
1333     ),
1334 )
1335 # -----------------------------------------------------------------------
1336 INITIAL_CONDITION = PROC(nom= "INITIAL_CONDITION",op = None,
1337 # -----------------------------------------------------------------------
1338 #   -----------------------------------
1339     SETTING = FACT(statut='o',
1340 #   -----------------------------------
1341 #       -----------------------------------
1342         SUSPENSION = FACT(statut='o',
1343 #       -----------------------------------
1344 #           -----------------------------------
1345             INITIAL_SUSPENDED_SEDIMENTS_CONCENTRATION_VALUES = SIMP(statut ='o',
1346 #           -----------------------------------
1347                 typ = 'R', min=0, max='**',
1348                 defaut = [0.,0.],
1349                 fr = """Fixe les valeurs initiales de concentration des sediments en
1350 suspension.""",
1351                 ang = """Sets the initial values of suspended sediment concentration.""",
1352             ),
1353         ),
1354     ),
1355 )
1356 # -----------------------------------------------------------------------
1357 BOUNDARY_CONDITIONS = PROC(nom= "BOUNDARY_CONDITIONS",op = None,
1358 # -----------------------------------------------------------------------
1359 #   -----------------------------------
1360     SETTING = FACT(statut='o',
1361 #   -----------------------------------
1362 #       -----------------------------------
1363         SUSPENSION = FACT(statut='o',
1364 #       -----------------------------------
1365 #           -----------------------------------
1366             PRESCRIBED_SUSPENDED_SEDIMENTS_CONCENTRATION_VALUES = SIMP(statut ='o',
1367 #           -----------------------------------
1368                 typ = 'R', max='**',
1369                 fr = """Valeurs de concentration des sediment en suspension imposees aux
1370 frontieres liquides entrantes. Les valeurs sont imposees a la premiere
1371 frontiere, puis la deuxieme etc. suivant la meme logique que pour les
1372 traceurs.""",
1373                 ang = """Suspended sediment concentration values prescribed at the inflow
1374 boundaries. Determines the imposed value of sediments at the first
1375 boundary, then at the second and so on, with the same logic as tracers.""",
1376             ),
1377 #           -----------------------------------
1378             VERTICAL_PROFILES_OF_SUSPENDED_SEDIMENTS = SIMP(statut ='f',
1379 #           -----------------------------------
1380                 typ = 'TXM', min=0, max='**',
1381                 into = ["User defined","Constant","Constant or Rouse if sediment", "Normalized Rouse profile and imposed conc", "Modified Rouse profile accounting for molecular viscosity"],
1382                 fr = """Permet de specifier le type de profil de concentration des
1383 sediments sur la verticale (uniquement pour des simulations 3D).
1384 Les choix possibles sont :
1385 \begin{itemize}
1386 \item 0 : Programmation utilisateur ;
1387 \item 1 : Constant ;
1388 \item 2 : Rouse equilibrium concentration ;
1389 \item 3 : Rouse (normalise) et concentration imposee.
1390 \item 4 : Rouse modifie avec viscosite moleculaire.
1391 \end{itemize}""",
1392                 ang = """Specifies the type of profiles of sediment concentration on the
1393 vertical (only for 3D simulations). Possible choices are:
1394 \begin{itemize}
1395 \item 0: user defined,
1396 \item 1: constant,
1397 \item 2: Rouse equilibrium, constant (diluted sediment)
1398 or Rouse (sediment),
1399 \item 3: Rouse (normalized) and imposed concentration.
1400 \item 4: Rouse modified with molecular viscosity.
1401 \end{itemize}""",
1402             ),
1403 #           -----------------------------------
1404             SUSPENDED_SEDIMENTS_CONCENTRATION_VALUES_AT_THE_SOURCES = SIMP(statut ='o',
1405 #           -----------------------------------
1406                 typ = 'R', min=0, max='**',
1407                 fr = """Valeurs des sediments en suspension a chacune des sources.
1408 toutes les sources pour le premier sediment
1409 puis toutes les sources du deuxieme sediment, etc.
1410 Par exemple, s''il y a 3 sediments en suspension (SED1, SED2 et SED3)
1411 et 2 sources (S1 et S2), la syntaxe suivante est utilisee :\\
1412 S1\_SED1;S1\_SED2;S1\_SED3;S2\_SED1;S2\_SED2;S2\_SED3\\
1413 10.0; 10.0; 0.0;  0.0; 10.0; 10.0""",
1414                 ang = """Values of the suspended sediments at the sources.
1415 All sources for the first suspended sediment, then
1416 all sources for the second suspended sediment, etc.
1417 For example, if there are 3 suspended sediments (SED1, SED2 and SED3)
1418 and 2 sources (S1 and S2), the following syntax is used:\\
1419 S1\_SED1;S1\_SED2;S1\_SED3;S2\_SED1;S2\_SED2;S2\_SED3\\
1420 10.0; 10.0; 0.0;  0.0; 10.0; 10.0""",
1421             ),
1422         ),
1423     ),
1424 )
1425 # -----------------------------------------------------------------------
1426 NUMERICAL_PARAMETERS = PROC(nom= "NUMERICAL_PARAMETERS",op = None,
1427 # -----------------------------------------------------------------------
1428 #   -----------------------------------
1429     MAXIMUM_NUMBER_OF_ITERATIONS_FOR_POSITIVE_THICKNESS = SIMP(statut ='f',
1430 #   -----------------------------------
1431         typ = 'I',
1432         defaut = [50],
1433         fr = """Seulement pour le charriage elements finis.
1434 Parametres de positive\_depths.
1435 Ancienne valeur par defaut = 10 jusqu en version 8.1.""",
1436         ang = """Only for bedload in finite elements.
1437 Parameter for positive\_depths.
1438 Old default value = 10 until release 8.1.""",
1439     ),
1440 #   -----------------------------------
1441     BEDLOAD = FACT(statut='o',
1442 #   -----------------------------------
1443 #       -----------------------------------
1444         UPWINDING_FOR_BEDLOAD = SIMP(statut ='f',
1445 #       -----------------------------------
1446             typ = 'R',
1447             defaut = 0.5E0,
1448             fr = """Parametre pour la résolution VF de equation d Exner,
1449 0.5 = Centre (precis), 1 = Decentrage amont (stable car diffusif)""",
1450             ang = """Parameter for FV solving the Exner equation,
1451 0.5 = Centered (precise), 1 = Upwind (stable because diffusive)""",
1452         ),
1453     ),
1454 #   -----------------------------------
1455     ADVECTION_INFO = FACT(statut='o',
1456 #   -----------------------------------
1457 #       -----------------------------------
1458         SUSPENSION = FACT(statut='o',
1459 #       -----------------------------------
1460 #           -----------------------------------
1461             SCHEME_FOR_ADVECTION_OF_SUSPENDED_SEDIMENTS = SIMP(statut ='o',
1462 #           -----------------------------------
1463                 typ = 'TXM',
1464                 into = ["NO ADVECTION","CHARACTERISTICS","EXPLICIT + SUPG","EXPLICIT LEO POSTMA","EXPLICIT + MURD SCHEME N","EXPLICIT + MURD SCHEME PSI","N-SCHEME FOR TIDAL FLATS","N-SCHEME FOR TIDAL FLATS","ERIA SCHEME - ONLY IN 2D"],
1465                 defaut = "EXPLICIT + MURD SCHEME PSI",
1466                 fr = """Choix du schema de convection pour les sediments en suspension,
1467 ERIA fonctionne uniquement en 2D. A donner en suivant l''ordre
1468 des sediments en suspension""",
1469                 ang = """Choice of the advection scheme for the suspended sediments,
1470 ERIA works only in 3D. The order of the chosen scheme must follow
1471 the order of the suspended sediments.""",
1472             ),
1473 #           -----------------------------------
1474             SCHEME_OPTION_FOR_ADVECTION_OF_SUSPENDED_SEDIMENTS = SIMP(statut ='f',
1475 #           -----------------------------------
1476                 typ = 'I',
1477                 defaut = 4,
1478                 fr = """Si schema PSI ou N : 1=explicite 2=predicteur-correcteur
1479 3=predicteur-correcteur deuxieme ordre en temps
1480 4=implicite""",
1481                 ang = """If N or PSI SCHEME: 1=explicit 2=predictor-corrector
1482 3= predictor-corrector second-order in time 4= implicit""",
1483             ),
1484         ),
1485     ),
1486 #   -----------------------------------
1487     SOLVER = FACT(statut='o',
1488 #   -----------------------------------
1489 #       -----------------------------------
1490         SUSPENSION = FACT(statut='o',
1491 #       -----------------------------------
1492 #           -----------------------------------
1493             SCHEME_FOR_DIFFUSION_OF_SUSPENDED_SEDIMENTS_IN_3D = SIMP(statut ='f',
1494 #           -----------------------------------
1495                 typ = 'TXM',
1496                 into = ["NO DIFFUSION","IMPLICIT","VERTICAL DIFFUSION ONLY"],
1497                 defaut = "IMPLICIT",
1498                 fr = """Permet de specifier si l''on utilise ou non la diffusion
1499 des sediments pour des simulations 3d.
1500 Les choix possibles sont :
1501 \begin{itemize}
1502 \item 0 : pas de diffusion,
1503 \item 1 : implicite;
1504 \item 2 : diffusion verticale seulement.
1505 \end{itemize}""",
1506                 ang = """Monitors the choice of the diffusion scheme
1507 for sediments in 3D simulations.
1508 Possible choices are:
1509 \begin{itemize}
1510 \item 0: no diffusion,
1511 \item 1: implicit,
1512 \item 2: vertical diffusion only.
1513 \end{itemize}""",
1514             ),
1515 #           -----------------------------------
1516             SOLVER_FOR_DIFFUSION_OF_SUSPENSION = SIMP(statut ='f',
1517 #           -----------------------------------
1518                 typ = 'TXM', min= 2, max= 2,
1519                 into = ["conjugate gradient","conjugate residual","conjugate gradient on a normal equation","minimum error","squared conjugate gradient","cgstab","gmres","direct solver"],
1520                 defaut = ["conjugate gradient"],
1521                 fr = """Permet de choisir le solveur utilise pour la resolution de
1522 la suspension.
1523 Les choix possibles sont :
1524 \begin{itemize}
1525 \item 1 : gradient conjugue ;
1526 \item 2 : residu conjugue ;
1527 \item 3 : gradient conjugue sur equation normale ;
1528 \item 4 : erreur minimale ;
1529 \item 5 : gradient conjugue carre ;
1530 \item 6 : CGSTAB ;
1531 \item 7 : GMRES ;
1532 \item 8 : solveur direct.
1533 \end{itemize}""",
1534                 ang = """Choice of the solver for suspension resolution.
1535 Possible choices are:
1536 \begin{itemize}
1537 \item 1: conjugate gradient,
1538 \item 2: conjugate residual,
1539 \item 3: conjugate gradient on a normal equation,
1540 \item 4: minimum error,
1541 \item 5: squared conjugate gradient,
1542 \item 6: CGSTAB,
1543 \item 7: GMRES,
1544 \item 8: direct solver.
1545 \end{itemize}""",
1546             ),
1547 #           -----------------------------------
1548             SOLVER_OPTION_FOR_DIFFUSION_OF_SUSPENSION = SIMP(statut ='f',
1549 #           -----------------------------------
1550                 typ = 'I',
1551                 defaut = 5,
1552                 fr = """Dimension de l''espace de Krylov pour la methode GMRES (7).""",
1553                 ang = """Dimension of Krylov space for the GMRES method (7).""",
1554             ),
1555 #           -----------------------------------
1556             MAXIMUM_NUMBER_OF_ITERATIONS_FOR_SOLVER_FOR_SUSPENSION = SIMP(statut ='f',
1557 #           -----------------------------------
1558                 typ = 'I',
1559                 defaut = 60,
1560                 fr = """Limite le nombre d''iterations du solveur a chaque pas
1561 de temps pour le calcul de la diffusion de la suspension.""",
1562                 ang = """Limits the number of solver iterations for the diffusion of
1563 sediments.""",
1564             ),
1565 #           -----------------------------------
1566             ACCURACY_FOR_DIFFUSION_OF_SUSPENSION = SIMP(statut ='f',
1567 #           -----------------------------------
1568                 typ = 'R',
1569                 defaut = [1.E-8],
1570                 fr = """Fixe la precision demandee pour le calcul de la diffusion
1571 de la suspension. Une seule valeur est acceptee pour tous les
1572 solveurs.""",
1573                 ang = """Sets the accuracy needed for the computation of
1574 the diffusion of suspension. It is not possible to set different
1575 values for different solvers, only one is accepted.""",
1576             ),
1577 #           -----------------------------------
1578             PRECONDITIONING_FOR_DIFFUSION_OF_SUSPENSION = SIMP(statut ='f',
1579 #           -----------------------------------
1580                 typ = 'TXM',
1581                 into = ["no preconditioning","diagonal","diagonal condensed","diagonal with absolute values","Crout","Gauss-Seidel EBE","Matrix defined by the user","diagonal and Crout","direct solver on the vertical","diagonal condensed and Crout","diagonal and direct solver on the vertical"],
1582                 defaut = "diagonal",
1583                 fr = """Permet de preconditionner le systeme relatif
1584 a la diffusion de la suspension. Les choix possibles sont :
1585 \begin{itemize}
1586 \item 0 : aucun ;
1587 \item 2 : diagonal ;
1588 \item 3 : diagonal avec matrice condensee en 3D;
1589 \item 5 : diagonal avec valeurs absolues en 3D ;
1590 \item 7 : Crout ;
1591 \item 11 : Gauss-Seidel EBE en 3D;
1592 \item 13 : matrice fournie par l''utilisateur en 3D ;
1593 \item 14 : diagonal et Crout ;
1594 \item 17 : solveur direct sur la verticale en 3D;
1595 \item 21 : diagonal condensee et Crout en 3D;
1596 \item 34 : diagonal et solveur direct sur la verticale en 3D.
1597 \end{itemize}""",
1598                 ang = """Choice of preconditioning for the diffusion of sediments.
1599 Possible choices are:
1600 \begin{itemize}
1601 \item 0: no preconditioning,
1602 \item 2: diagonal,
1603 \item 3: diagonal with the condensed matrix in 3D,
1604 \item 5: diagonal with absolute values in 3D,
1605 \item 7: Crout,
1606 \item 11: Gauss-Seidel EBE in 3D,
1607 \item 13: matrix defined by the user in 3D,
1608 \item 14: diagonal and Crout,
1609 \item 17: direct solver on the vertical in 3D,
1610 \item 21: diagonal condensed and Crout in 3D,
1611 \item 34: diagonal and direct solver on the vertical in 3D.
1612 \end{itemize}""",
1613             ),
1614         ),
1615     ),
1616 #   -----------------------------------
1617     AUTOMATIC_DIFFERENTIATION = FACT(statut='o',
1618 #   -----------------------------------
1619 #       -----------------------------------
1620         AD_NUMBER_OF_DERIVATIVES = SIMP(statut ='f',
1621 #       -----------------------------------
1622             typ = 'I',
1623             defaut = [0],
1624             fr = """Definit le nombre de derivees utilisateurs, dans le cadre
1625 de la differentiation algorithmique.""",
1626             ang = """Defines the number of user derivatives, within the framework
1627 of the algorithmic differentiation.""",
1628         ),
1629 #       -----------------------------------
1630         AD_NAMES_OF_DERIVATIVES = SIMP(statut ='f',
1631 #       -----------------------------------
1632             typ = 'TXM', min= 2, max= 2,
1633             fr = """Noms des derivees utilisateurs en 32 caracteres,
1634          16 pour le nom, 16 pour l''unite""",
1635             ang = """Name of user derivatives in 32 characters,
1636          16 for the name, 16 for the unit.""",
1637         ),
1638 #       -----------------------------------
1639         AD_NUMBER_OF_DIRECTIONS = SIMP(statut ='f',
1640 #       -----------------------------------
1641             typ = 'I',
1642             defaut = [1],
1643             fr = """Definit le nombre de directions de differentiateurs.""",
1644             ang = """Defines the number of directions for the differentiators""",
1645         ),
1646 #       -----------------------------------
1647         AD_SYMBOLIC_LINEAR_SOLVER = SIMP(statut ='f',
1648 #       -----------------------------------
1649             typ = bool,
1650             defaut = False,
1651             fr = """Permet le solveur lineaire symbolique pour l AD.""",
1652             ang = """Enables the symbolic linear solver for AD.""",
1653         ),
1654 #       -----------------------------------
1655         AD_LINEAR_SOLVER_RESET_DERIVATIVES = SIMP(statut ='f',
1656 #       -----------------------------------
1657             typ = bool,
1658             defaut = True,
1659             fr = """Remet a zero les derivees pour l AD.""",
1660             ang = """Resets the derivatives for AD.""",
1661         ),
1662 #       -----------------------------------
1663         AD_LINEAR_SOLVER_DERIVATIVE_CONVERGENCE = SIMP(statut ='f',
1664 #       -----------------------------------
1665             typ = bool,
1666             defaut = True,
1667             fr = """Solveur lineaire iteratif : test de convergence des derivees
1668 pour l AD.""",
1669             ang = """Iterative linear solvers: derivative convergence test for AD.""",
1670         ),
1671     ),
1672 )
1673 # -----------------------------------------------------------------------
1674 SEDIMENT_INFO = PROC(nom= "SEDIMENT_INFO",op = None,
1675 # -----------------------------------------------------------------------
1676 #   -----------------------------------
1677     SETTLING_VELOCITY = FACT(statut='o',
1678 #   -----------------------------------
1679 #       -----------------------------------
1680         ADVECTION_DIFFUSION_SCHEME_WITH_SETTLING_VELOCITY = SIMP(statut ='f',
1681 #       -----------------------------------
1682             typ = 'I',
1683             defaut = 0,
1684             fr = """Choix de schema vertical pour la diffusion et le depot du
1685 sediment (uniquement pour le 3D):
1686 \begin{itemize}
1687 \item 0 : Diffusion implicite ;
1688 \item 1 : Schema implicite de convection-diffusion
1689 (tridiagonal matrix solver) ;
1690 \item 2 : Convection faible  \telfile{sed\_fall.f}
1691 \end{itemize}""",
1692             ang = """Choice of the vertical scheme for diffusion and settling of
1693 sediment (only in 3D):
1694 \begin{itemize}
1695 \item 0: Implicit-diffusion scheme,
1696 \item 1: Implicit-convection scheme (Tridiagonal matrix solver),
1697 \item 2: \telfile{set\_fall.f}
1698 \end{itemize}""",
1699         ),
1700     ),
1701 )
1702 # -----------------------------------------------------------------------
1703 COHESIVE = PROC(nom= "COHESIVE",op = None,
1704 # -----------------------------------------------------------------------
1705 #   -----------------------------------
1706     INITIALIZATION = FACT(statut='o',
1707 #   -----------------------------------
1708 #       -----------------------------------
1709         SUSPENSION = FACT(statut='o',
1710 #       -----------------------------------
1711 #           -----------------------------------
1712             LAYERS_CRITICAL_EROSION_SHEAR_STRESS_OF_THE_MUD = SIMP(statut ='f',
1713 #           -----------------------------------
1714                 typ = 'R', min= 2, max= 2,
1715                 defaut = [0.5,1.],
1716                 fr = """Taux critique d erosion de la vase needs to be defined
1717         for each layer (N par m2)""",
1718                 ang = """Critical erosion shear stress of the mud per layer (N per m2)""",
1719             ),
1720         ),
1721     ),
1722 #   -----------------------------------
1723     SETTLING_VELOCITY = FACT(statut='o',
1724 #   -----------------------------------
1725 #       -----------------------------------
1726         HINDERED_SETTLING = SIMP(statut ='f',
1727 #       -----------------------------------
1728             typ = bool,
1729             defaut = False,
1730             fr = """Decide si la formulation entravee doit etre utilisee
1731 pour calculer la vitesse de chute de la vase.""",
1732             ang = """Decides if hindered formulation is to be used to
1733 compute settling velocity for mud.""",
1734         ),
1735 #       -----------------------------------
1736         HINDERED_SETTLING_FORMULA = SIMP(statut ='f',
1737 #       -----------------------------------
1738             typ = 'I',
1739             defaut = 1,
1740             fr = """Type de vitesse de chute entravee :
1741 \begin{itemize}
1742 \item 1 : Whitehouse et al. (2000) - fonctionne ;
1743 \item 2 : Winterwerp (1999) - ne fonctionne pas actuellement.
1744 \end{itemize}""",
1745             ang = """Type of hindered settling:
1746 \begin{itemize}
1747 \item 1: Whitehouse et al. (2000) - working,
1748 \item 2: Winterwerp (1999) - not currently working.
1749 \end{itemize}""",
1750         ),
1751 #       -----------------------------------
1752         WEAK_SOIL_CONCENTRATION_FOR_MUD = SIMP(statut ='f',
1753 #       -----------------------------------
1754             typ = 'R',
1755             defaut = 0.0,
1756             fr = """Concentration limite en kg/m$^3$ au-dela de laquelle
1757 la couche de vase fluide devient solide.
1758 Cette valeur est demandee lorsque
1759 \telkey{VITESSE DE CHUTE ENTRAVEE} = OUI.""",
1760             ang = """The sediment concentration at which sediment
1761 forms a weak soil in kg/m$^3$. These values are needed when
1762 \telkey{HINDERED SETTLING} = YES.""",
1763         ),
1764 #       -----------------------------------
1765         THRESHOLD_CONCENTRATION_FOR_HINDERED_SETTLING = SIMP(statut ='f',
1766 #       -----------------------------------
1767             typ = 'R',
1768             defaut = 0.0,
1769             fr = """Concentration de sediment a laquelle la chute entravee est
1770 initiee. Ces valeurs sont necessaires lorsque
1771 \telkey{VITESSE DE CHUTE ENTRAVEE} = OUI.""",
1772             ang = """The sediment concentration at which hindered settling is
1773 initiated. These values are needed when
1774 \telkey{HINDERED SETTLING} = YES.""",
1775         ),
1776 #       -----------------------------------
1777         FLOCCULATION = SIMP(statut ='f',
1778 #       -----------------------------------
1779             typ = bool,
1780             defaut = False,
1781             fr = """Decide si la formulation entravee doit etre utilisee
1782 pour calculer la vitesse de chute pour la vase.""",
1783             ang = """Decides if hindered formulation is to be used to
1784 compute settling velocity for mud.""",
1785         ),
1786 #       -----------------------------------
1787         FLOCCULATION_FORMULA = SIMP(statut ='f',
1788 #       -----------------------------------
1789             typ = 'I',
1790             defaut = 1,
1791             fr = """Formule pour floculation :
1792 \begin{itemize}
1793 \item 1: Van Leussen ;
1794 \item 2: Soulsby et  al. (2013).
1795 \end{itemize}""",
1796             ang = """Type of flocculation formula:
1797 \begin{itemize}
1798 \item 1: Van Leussen,
1799 \item 2: Soulsby et  al. (2013).
1800 \end{itemize}""",
1801         ),
1802 #       -----------------------------------
1803         FLOCCULATION_COEFFICIENT = SIMP(statut ='f',
1804 #       -----------------------------------
1805             typ = 'R',
1806             defaut = 0.3,
1807             fr = """Coefficient intervenant dans la modelisation de l''influence de
1808 la turbulence sur la floculation, il intervient plus precisement dans
1809 le terme de formation des flocs par les contraintes turbulentes
1810 (coefficient $a$ de la formule de Van Leussen).
1811 Valeur a imposer si
1812 \telkey{INFLUENCE DE LA TURBULENCE SUR LA VITESSE DE CHUTE}
1813 = OUI.""",
1814             ang = """When the influence of turbulence on the settling velocity
1815 is modelled, this coefficient traduces the formation of flocs by
1816 turbulence (coefficient $a$ of Van Leussen formula).
1817 Value to be imposed if
1818 \telkey{INFLUENCE OF TURBULENCE ON SETTLING VELOCITY} = YES.""",
1819         ),
1820 #       -----------------------------------
1821         COEFFICIENT_RELATIVE_TO_FLOC_DESTRUCTION = SIMP(statut ='f',
1822 #       -----------------------------------
1823             typ = 'R',
1824             defaut = 0.09,
1825             fr = """Coefficient intervenant dans la modelisation de l''influence de
1826 la turbulence sur la floculation, il intervient plus precisement dans
1827 le terme de destruction des flocs par les contraintes turbulentes
1828 (coefficient $b$ de la formulede Van Leussen).
1829 Valeur a imposer si
1830 \telkey{INFLUENCE DE LA TURBULENCE SUR LA VITESSE DE CHUTE}
1831 = OUI.""",
1832             ang = """When the influence of turbulence on the settling velocity
1833 is modelled, this coefficient traduces the breaking of flocs by
1834 turbulence (coefficient $b$ of Van Leussen formula).
1835 Value to be imposed if
1836 \telkey{INFLUENCE OF TURBULENCE ON SETTLING VELOCITY} = YES.""",
1837         ),
1838     ),
1839 #   -----------------------------------
1840     SUSPENSION = FACT(statut='o',
1841 #   -----------------------------------
1842 #       -----------------------------------
1843         CLASSES_CRITICAL_SHEAR_STRESS_FOR_MUD_DEPOSITION = SIMP(statut ='f',
1844 #       -----------------------------------
1845             typ = 'R', min= 2, max= 2,
1846             defaut = [1000.,1000.],
1847             fr = """Contrainte critique de depot (Pa)""",
1848             ang = """Critical shear stress for deposition (Pa)""",
1849         ),
1850 #       -----------------------------------
1851         LAYERS_PARTHENIADES_CONSTANT = SIMP(statut ='f',
1852 #       -----------------------------------
1853             typ = 'R', min= 2, max= 2,
1854             defaut = [1.E-3,1.E-3],
1855             fr = """constante de la loi d''erosion de la vase (Kg/m2/s)""",
1856             ang = """constant of the Krone and Partheniades erosion law (Kg/m2/s)""",
1857         ),
1858     ),
1859 #   -----------------------------------
1860     BED_STRUCTURE = FACT(statut='o',
1861 #   -----------------------------------
1862 #       -----------------------------------
1863         INITIALIZATION = FACT(statut='o',
1864 #       -----------------------------------
1865 #           -----------------------------------
1866             LAYERS_MUD_CONCENTRATION = SIMP(statut ='f',
1867 #           -----------------------------------
1868                 typ = 'R', min= 2, max= 2,
1869                 fr = """Concentration du lit de vase en g/ l - defini par couches""",
1870                 ang = """Concentrations of the mud-bed in g per l (per layer)""",
1871             ),
1872         ),
1873     ),
1874 #   -----------------------------------
1875     CONSOLIDATION = FACT(statut='o',
1876 #   -----------------------------------
1877 #       -----------------------------------
1878         NUMBER_OF_LAYERS_OF_THE_CONSOLIDATION_MODEL = SIMP(statut ='f',
1879 #       -----------------------------------
1880             typ = 'I',
1881             defaut = [1],
1882             fr = """Structure verticale du lit cohesif- le nombre de couche doit
1883        etre inferieur a 10""",
1884             ang = """Vertical bed structure - The number of layers should be less
1885        than 10""",
1886         ),
1887 #       -----------------------------------
1888         LAYERS_MASS_TRANSFER = SIMP(statut ='f',
1889 #       -----------------------------------
1890             typ = 'R', min= 2, max= 2,
1891             fr = """Coefficients de transfert de masse du modele
1892 de tassement multicouche en s-1""",
1893             ang = """Mass transfert coefficients of
1894 the multilayer consolidation model in s-1""",
1895         ),
1896     ),
1897 )
1898 # -----------------------------------------------------------------------
1899 NUMERICAL = PROC(nom= "NUMERICAL",op = None,
1900 # -----------------------------------------------------------------------
1901 #   -----------------------------------
1902     ZERO = SIMP(statut ='f',
1903 #   -----------------------------------
1904         typ = 'R',
1905         defaut = 1.E-10,
1906         fr = """Fixe le zero de GAIA utilise pour les clippings.""",
1907         ang = """Sets the zero of GAIA used for clipping values.""",
1908     ),
1909 #   -----------------------------------
1910     FINITE_VOLUMES = SIMP(statut ='f',
1911 #   -----------------------------------
1912         typ = bool,
1913         defaut = [False],
1914         fr = """Methodes volumes finis ou pas""",
1915         ang = """Set finite volumes method or not""",
1916     ),
1917 #   -----------------------------------
1918     MATRIX_VECTOR_PRODUCT = SIMP(statut ='f',
1919 #   -----------------------------------
1920         typ = 'I',
1921         defaut = [1],
1922         fr = """""",
1923         ang = """""",
1924     ),
1925 #   -----------------------------------
1926     MATRIX_STORAGE = SIMP(statut ='f',
1927 #   -----------------------------------
1928         typ = 'I',
1929         defaut = [1],
1930         fr = """""",
1931         ang = """""",
1932     ),
1933 )
1934 # -----------------------------------------------------------------------
1935 PHYSICS = PROC(nom= "PHYSICS",op = None,
1936 # -----------------------------------------------------------------------
1937 #   -----------------------------------
1938     CLASSES_SEDIMENT_DENSITY = SIMP(statut ='f',
1939 #   -----------------------------------
1940         typ = 'R', min= 2, max= 2,
1941         defaut = [2650.,2650.],
1942         fr = """Fixe la valeur de la masse volumique du sediment par classe en Kg/m3""",
1943         ang = """Sets the value of the sediment density for each class en Kg/m3""",
1944     ),
1945 #   -----------------------------------
1946     WATER_VISCOSITY = SIMP(statut ='f',
1947 #   -----------------------------------
1948         typ = 'R',
1949         defaut = 1.E-6,
1950         fr = """Definit la viscosite cinematique de l''eau.
1951          M/S2""",
1952         ang = """Specifies the water kinematic viscosity.
1953          M/S2""",
1954     ),
1955 )
1956 # -----------------------------------------------------------------------
1957 SUSPENSION = PROC(nom= "SUSPENSION",op = None,
1958 # -----------------------------------------------------------------------
1959 #   -----------------------------------
1960     CORRECTION_ON_CONVECTION_VELOCITY = SIMP(statut ='f',
1961 #   -----------------------------------
1962         typ = bool,
1963         defaut = [False],
1964         fr = """Modification du champ convecteur 2D pour prise en compte du
1965 gradient vertical de vitesse et concentration""",
1966         ang = """Modification of 2D convection velocities  to account for
1967 velocity and concentration profiles""",
1968     ),
1969 #   -----------------------------------
1970     THETA_IMPLICITATION_FOR_SUSPENSION = SIMP(statut ='f',
1971 #   -----------------------------------
1972         typ = 'R',
1973         defaut = [1.],
1974         fr = """facteur implicitation du terme de depot et de la diffusion.
1975  si teta =0, tout le terme de depot est traite de maniere explicite.
1976  Valide seulement pour le modèle 2D.""",
1977         ang = """ implicitation factor for the deposition flux and the diffusion.
1978  for teta =0, the deposition flux is only explicit.
1979  Only valid for the 2D model.""",
1980     ),
1981 #   -----------------------------------
1982     TURBULENCE = FACT(statut='o',
1983 #   -----------------------------------
1984 #       -----------------------------------
1985         COEFFICIENT_FOR_DIFFUSION_OF_SUSPENDED_SEDIMENTS = SIMP(statut ='o',
1986 #       -----------------------------------
1987             typ = 'R', min=0, max='**',
1988             defaut = [1.E-6],
1989             fr = """Fixe la valeur du coefficient de diffusion des sediments en
1990 suspension en 2D.
1991 L''influence de ce parametre sur l''evolution des sediments dans
1992 le temps est importante. C'' est un scalaire (une seule valeur pour
1993 tous les sediments.""",
1994             ang = """Sets the value of the suspended sediments diffusivity in 2D.
1995 This value may have a significant effect on the evolution of
1996 sediments in time. It is a scalar (one value for all sediments).""",
1997         ),
1998 #       -----------------------------------
1999         COEFFICIENT_FOR_HORIZONTAL_DIFFUSION_OF_SUSPENDED_SEDIMENTS = SIMP(statut ='f',
2000 #       -----------------------------------
2001             typ = 'R', min=0, max='**',
2002             fr = """Fixe les valeurs de coefficients de diffusion horizontal des
2003 sediments, en 3D.  L''influence de ce parametre sur l''evolution des
2004 sediments dans le temps est importante.
2005 C'' est un tableau avec une valeur par sediment en suspension,
2006  separation par un point virgule.""",
2007             ang = """Sets the values of the horizontal diffusion of sediments in 3D.
2008 These values may have a significant effect on the evolution of
2009 sediments in time.
2010 It is an array, with one value per suspended sediment, separated by
2011  semicolons.""",
2012         ),
2013     ),
2014 )
2015 # -----------------------------------------------------------------------
2016 SUSPENSIONS = PROC(nom= "SUSPENSIONS",op = None,
2017 # -----------------------------------------------------------------------
2018 #   -----------------------------------
2019     TURBULENCE = FACT(statut='o',
2020 #   -----------------------------------
2021 #       -----------------------------------
2022         COEFFICIENT_FOR_VERTICAL_DIFFUSION_OF_SUSPENDED_SEDIMENTS = SIMP(statut ='f',
2023 #       -----------------------------------
2024             typ = 'R', min=0, max='**',
2025             fr = """Fixe les valeurs de coefficients de diffusion vertical des
2026 sediments, en 3D.  L''influence de ce parametre sur l''evolution des
2027  sediments dans le temps est importante.
2028 C'' est un tableau avec une valeur par sediemnts en suspension,
2029 separation par un point virgule.""",
2030             ang = """Sets the values of the vertical diffusion of sediments in 3D.
2031 These values may have a significant effect on the evolution of
2032 sediments in time.
2033 It is an array, with one value per suspended sediment, separated by
2034  semicolons.""",
2035         ),
2036     ),
2037 )
2038 # -----------------------------------------------------------------------
2039 SEDIMENTOLOGY = PROC(nom= "SEDIMENTOLOGY",op = None,
2040 # -----------------------------------------------------------------------
2041 #   -----------------------------------
2042     GENERAL = FACT(statut='o',
2043 #   -----------------------------------
2044 #       -----------------------------------
2045         SECONDARY_CURRENTS_ALPHA_COEFFICIENT = SIMP(statut ='f',
2046 #       -----------------------------------
2047             typ = 'R',
2048             defaut = 1.0E-00,
2049             fr = """(-)""",
2050             ang = """Alpha coefficient of secondary current(-),
2051 Should be chosen between 0.75 (rough bottom) and 1 (smooth bottom)""",
2052         ),
2053     ),
2054 )
2055 # -----------------------------------------------------------------------
2056 BED_MATERIAL = PROC(nom= "BED_MATERIAL",op = None,
2057 # -----------------------------------------------------------------------
2058 #   -----------------------------------
2059     C_VSM = FACT(statut='o',
2060 #   -----------------------------------
2061 #       -----------------------------------
2062         VERTICAL_GRAIN_SORTING_MODEL = SIMP(statut ='f',
2063 #       -----------------------------------
2064             typ = 'I',
2065             defaut = [0],
2066             fr = """(-)""",
2067             ang = """Defines the model of the vertical grain sorting:
2068         0 = HR-VSM = Layer Model (Classic Hirano / Ribberink approach)
2069         1 = C-VSM (Continous Vertical Grain Sorting Model)""",
2070         ),
2071 #       -----------------------------------
2072         C_VSM_MAXIMUM_SECTIONS = SIMP(statut ='f',
2073 #       -----------------------------------
2074             typ = 'I',
2075             defaut = [200],
2076             fr = """(-)""",
2077             ang = """Defines the maximum discretisation of the
2078          Continous Vertical Sorting Model:
2079          Should be bigger than 8xNumber of Fractions.
2080          The bigger the higher the RAM requirements,
2081          but the faster and accurater the
2082          bookkeeping of the sediments.""",
2083         ),
2084 #       -----------------------------------
2085         C_VSM_FULL_PRINTOUT_PERIOD = SIMP(statut ='f',
2086 #       -----------------------------------
2087             typ = 'I',
2088             defaut = [0],
2089             fr = """(-)""",
2090             ang = """Number of Timesteps to next printout
2091          of the full C-VSM. These printouts are highly
2092          time and disc consuming.
2093          0 = Coupled to GRAPHIC PRINTOUT PERIOD
2094          >0 = Own printout period for the C-VSM""",
2095         ),
2096 #       -----------------------------------
2097         C_VSM_PRINTOUT_SELECTION = SIMP(statut ='f',
2098 #       -----------------------------------
2099             typ = 'TXM', min=13, max=13,
2100             defaut = '0;0;0;0;0;0;0;0;0;0;0;0;0',
2101             fr = """(-)""",
2102             ang = """Printout the C-VSM for the whole model as 3D
2103          \telkey{C-VSM RESULTS FILE}
2104          or / and for some nodes as
2105          \telkey{C-VSM NODE FILE}
2106          Give Up to 100 INTEGER numbers separated by ";"
2107          0 = Full model .-> VSPRES
2108          N = 1,2...NPOINT; 2D-ID of a SELFIN MESH POINT ->*\_VSP.CSV""",
2109         ),
2110 #       -----------------------------------
2111         ACTIVE_LAYER_THICKNESS_FORMULA = SIMP(statut ='f',
2112 #       -----------------------------------
2113             typ = 'I',
2114             defaut = [0],
2115             fr = """(-)""",
2116             ang = """MODEL FOR ACTIVE LAYER THICKNESS
2117          0 = ELAY0 (Keyword: ACTIVE LAYER THICKNESS)
2118          1 = Hunziker \& G$\ddot{u}$nther
2119          2 = Fredsoe \& Deigaard (1992)
2120          3 = van RIJN (1993)
2121          4 = Wong (2006)
2122          5 = Malcherek (2003)
2123          6 = $3*d50$ within last time steps ALT""",
2124         ),
2125     ),
2126 )
2127 TEXTE_NEW_JDC = "\
2128 COMPUTATION_ENVIRONMENT();\
2129 GENERAL_PARAMETERS();\
2130 HYDRODYNAMICS();\
2131 MISCELLANEOUS();\
2132 GENERAL();\
2133 COHESIVE_AND_NON_COHESIVE();\
2134 BED_STRUCTURE();\
2135 USELESS();\
2136 INPUT_OUTPUT__FILES();\
2137 RESULTS();\
2138 DATA_FILES();\
2139 INITIAL_CONDITIONS();\
2140 INPUT_OUTPUT__GRAPHICS_AND_LISTING();\
2141 TIME();\
2142 NON_COHESIVE();\
2143 INITIAL_CONDITION();\
2144 BOUNDARY_CONDITIONS();\
2145 NUMERICAL_PARAMETERS();\
2146 SEDIMENT_INFO();\
2147 COHESIVE();\
2148 NUMERICAL();\
2149 PHYSICS();\
2150 SUSPENSION();\
2151 SUSPENSIONS();\
2152 SEDIMENTOLOGY();\
2153 BED_MATERIAL();\
2154 "
2155 Ordre_Des_Commandes = (
2156 'COMPUTATION_ENVIRONMENT',
2157 'INTERNAL',
2158 'GENERAL_PARAMETERS',
2159 'HYDRODYNAMICS',
2160 'MISCELLANEOUS',
2161 'GENERAL',
2162 'COHESIVE_AND_NON_COHESIVE',
2163 'BED_STRUCTURE',
2164 'USELESS',
2165 'INPUT_OUTPUT__FILES',
2166 'RESULTS',
2167 'DATA_FILES',
2168 'INITIAL_CONDITIONS',
2169 'INPUT_OUTPUT__GRAPHICS_AND_LISTING',
2170 'TIME',
2171 'NON_COHESIVE',
2172 'INITIAL_CONDITION',
2173 'BOUNDARY_CONDITIONS',
2174 'NUMERICAL_PARAMETERS',
2175 'SEDIMENT_INFO',
2176 'COHESIVE',
2177 'NUMERICAL',
2178 'PHYSICS',
2179 'SUSPENSION',
2180 'SUSPENSIONS',
2181 'SEDIMENTOLOGY',
2182 'BED_MATERIAL')
2183 try:
2184     import TelApy
2185     source = "eficas"
2186 except Exception as excpt:
2187     source = "Telemac"
2188 enum = source+'.gaia_enum_auto'
2189 dicoCasEn = source+'.gaia_dicoCasEnToCata'
2190 dicoCasFr = source+'.gaia_dicoCasFrToCata'