Telemac/tomawac_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 = 'TOMAWAC',
  41                 execmodul = None,
  42                 )
  43 # =======================================================================
  44 # Catalog entry for the MAP function : c_pre_interfaceBody_mesh
  45 # =======================================================================
  46
  47 VERSION_CATALOGUE="TRUNK_20210323"
  48 # -----------------------------------------------------------------------
  49 COMPUTATION_ENVIRONMENT = PROC(nom= "COMPUTATION_ENVIRONMENT",op = None,
  50 # -----------------------------------------------------------------------
  51 #   -----------------------------------
  52     OUTPUT = FACT(statut='o',
  53 #   -----------------------------------
  54 #       -----------------------------------
  55         LISTING = FACT(statut='f',
  56 #       -----------------------------------
  57 #           -----------------------------------
  58             PERIOD_FOR_LISTING_PRINTOUTS = SIMP(statut ='f',
  59 #           -----------------------------------
  60                 typ = 'I',
  61                 defaut = 1,
  62                 fr = """Determine la periodicite,
  63 en nombre de pas de temps
  64 des messages du code sur le fichier listing""",
  65                 ang = """Determines the period,
  66 in number of time step
  67 of the software messages in the listing file.""",
  68             ),
  69         ),
  70 #       -----------------------------------
  71         RESULTS = FACT(statut='o',
  72 #       -----------------------------------
  73 #           -----------------------------------
  74             VARIABLES_FOR_2D_GRAPHIC_PRINTOUTS = SIMP(statut ='o',
  75 #           -----------------------------------
  76                 typ = 'TXM', min=0, max='**',
  77                 into = ["Total variance  (m2)","Spectral significant wave height  (m)","Mean wave direction  (deg)","Mean directional spreading  (deg)","Sea bottom level  (m)","Water depth  (m)","Current along X  (m/s)","Current along Y  (m/s)","Wind along X  (m/s)","Wind along Y  (m/s)","Driving force along X  (m/s2)","Driving force along Y  (m/s2)","Radiation stress along xx  (m3/s2)","Radiation stress along yy  (m3/s2)","Radiation stress along xy  (m3/s2)","Bottom celerity  (m/s)","Wave power (per meter along wave crest)  (kW/m)","Mean frequency FMOY  (Hz)","Mean frequency FM01  (Hz)","Mean frequency FM02  (Hz)","Discrete peak frequency  (Hz)","Peak frequency by Read method of order 5  (Hz)","Peak frequency by Read method of order 8  (Hz)","Surface friction velocity u*  (m/s)","Surface drag coefficient CD  (-)","Surface roughness length Z0  (m)","Surface wave stress  (kg/(m.s2))","Mean period Tmoy  (s)","Mean period Tm01  (s)","Mean period Tm02  (s)","Discrete peak period  (s)","Peak period by Read method of order 5  (s)","Peak period by Read method of order 8  (s)","Private table  (?)","Breaking waves rate (-)","White capping rate  (-)"],
  78                 defaut = ["Spectral significant wave height  (m)","Mean wave direction  (deg)"],
  79                 fr = """Noms des variables que l''utilisateur veut ecrire dans
  80 le FICHIER DES RESULTATS 2D. Les variables disponibles sont :
  81 M0   : variance totale
  82 HM0  : Hauteur significative spectrale
  83 DMOY : Direction moyenne de houle
  84 SPD  : Etalement directionnel moyen
  85 ZF   : Cote du fond
  86 WD   : Hauteur d''eau
  87 UX   : Courant suivant X
  88 UY   : Courant suivant Y
  89 VX   : Vent suivant X
  90 VY   : Vent suivant Y
  91 FX   : Force motrice suivant X
  92 FY   : Force motrice suivant Y
  93 SXX  : Contrainte de radiation suivant xx
  94 SYY  : Contrainte de radiation suivant yy
  95 SXY  : Contrainte de radiation suivant xy
  96 UWB  : Vitesse orbitale au fond
  97 POW  : Puissance lineique de houle (par metre de crete)
  98 FMOY : Frequence moyenne FMOY
  99 FM01 : Frequence moyenne FM01
 100 FM02 : Frequence moyenne FM02
 101 FPD  : Frequence de pic discrete
 102 FPR5 : Frequence de pic de Read ordre 5
 103 FPR8 : Frequence de pic de Read ordre 8
 104 US   : Vitesse de frottement en surface u*
 105 CD   : Coefficient de trainee en surface CD
 106 Z0   : Longueur de rugosite en surface Z0
 107 WS   : Contrainte de houle en surface
 108 TMOY : Periode moyenne Tmoy
 109 TM01 : Periode moyenne Tm01
 110 TM02 : Periode moyenne Tm02
 111 TPD  : Periode de pic discrete
 112 TPR5 : Periode de pic de Read ordre 5
 113 TPR8 : Periode de pic de Read ordre 8
 114 PRI  : tableau prive
 115 BETA : coefficient de deferlement
 116 BETAWC : coefficient de moutonnement
 117 **Mots-cles associes :**
 118 FICHIER DES RESULTATS 2D
 119 NUMERO DE LA PREMIERE ITERATION POUR LES SORTIES GRAPHIQUES
 120 PERIODE POUR LES SORTIES GRAPHIQUES""",
 121                 ang = """Codes of the variables the user wants to write into the 2D
 122 RESULTS FILE. The available variables are as follows
 123 \begin{itemize}
 124 \item M0   : Total variance
 125 \item HM0  : Spectral significant wave height
 126 \item DMOY : Mean wave direction
 127 \item SPD  : Mean directional spreading
 128 \item ZF   : Sea bottom level
 129 \item WD   : Water depth
 130 \item UX   : Current along X
 131 \item UY   : Current along Y
 132 \item VX   : Wind along X
 133 \item VY   : Wind along Y
 134 \item FX   : Driving force along X
 135 \item FY   : Driving force along Y
 136 \item SXX  : Radiation stress along xx
 137 \item SYY  : Radiation stress along yy
 138 \item SXY  : Radiation stress along xy
 139 \item UWB  : Bottom celerity
 140 \item POW  : Wave power (per meter along wave crest)
 141 \item FMOY : Mean frequency FMOY
 142 \item FM01 : Mean frequency FM01
 143 \item FM02 : Mean frequency FM02
 144 \item FPD  : Discrete peak frequency
 145 \item FPR5 : Peak frequency by Read method of order 5
 146 \item FPR8 : Peak frequency by Read method of order 8
 147 \item US   : Surface friction velocity u*
 148 \item CD   : Surface drag coefficient CD
 149 \item Z0   : Surface roughness length Z0
 150 \item WS   : Surface wave stress
 151 \item TMOY : Mean period Tmoy
 152 \item TM01 : Mean period Tm01
 153 \item TM02 : Mean period Tm02
 154 \item TPD  : Discrete peak period
 155 \item TPR5 : Peak period by Read method of order 5
 156 \item TPR8 : Peak period by Read method of order 8
 157 \item PRI  : Private table
 158 \item BETA : Breaking waves coefficient
 159 \item BETAWC : White Capping coefficient
 160 \end{itemize}
 161  \begin{CommentBlock}{Related keywords}
 162 2D RESULTS FILE\\
 163 NUMBER OF FIRST ITERATION FOR GRAPHIC PRINTOUTS\\
 164 PERIOD FOR GRAPHIC PRINTOUTS
 165 \end{CommentBlock}""",
 166             ),
 167 #           -----------------------------------
 168             PERIOD_FOR_GRAPHIC_PRINTOUTS = SIMP(statut ='o',
 169 #           -----------------------------------
 170                 typ = 'I',
 171                 defaut = 1,
 172                 fr = """Determine la periode d''impression,
 173 en nombre de pas de temps
 174 des VARIABLES POUR LES SORTIES GRAPHIQUES dans le FICHIER DES
 175 RESULTATS 2D et le FICHIER DES RESULTATS PONCTUELS.
 176 **Mots-cles associes :**
 177 VARIABLES POUR LES SORTIES GRAPHIQUES 2D
 178 ABSCISSES DES POINTS DE SORTIE DU SPECTRE
 179 ORDONNEES DES POINTS DE SORTIE DU SPECTRE
 180 FICHIER DES RESULTATS 2D
 181 FICHIER DES RESULTATS PONCTUELS
 182 NUMERO DE LA PREMIERE ITERATION POUR LES SORTIES GRAPHIQUES""",
 183                 ang = """Determines the printing period,
 184 in number of time step
 185 of the VARIABLES FOR 2D GRAPHIC PRINTOUTS in the 2D
 186 RESULTS FILE and the PUNCTUAL RESULTS FILE.
 187 \\
 188  \begin{CommentBlock}{Related keywords}
 189 VARIABLES FOR 2D GRAPHIC PRINTOUTS\\
 190 ABSCISSAE OF SPECTRUM PRINTOUT POINTS\\
 191 ORDINATES OF SPECTRUM PRINTOUT POINTS\\
 192 2D RESULTS FILE\\
 193 PUNCTUAL RESULTS FILE\\
 194 NUMBER OF FIRST ITERATION FOR GRAPHIC PRINTOUTS\\
 195 \end{CommentBlock}""",
 196             ),
 197 #           -----------------------------------
 198             NUMBER_OF_FIRST_ITERATION_FOR_GRAPHICS_PRINTOUTS = SIMP(statut ='f',
 199 #           -----------------------------------
 200                 typ = 'I',
 201                 defaut = 0,
 202                 fr = """Determine le nombre d''iterations sur le pas de temps
 203 ou sur la frequence moyenne a partir duquel debute
 204 l ecriture des resultats dans le FICHIER DES RESULTATS 2D et le
 205 FICHIER DES RESULTATS PONCTUELS
 206 **Mots-cles associes :**
 207 PERIODE POUR LES SORTIES GRAPHIQUES
 208 VARIABLES POUR LES SORTIES GRAPHIQUES 2D
 209 ABSCISSES DES POINTS DE SORTIE DU SPECTRE
 210 ORDONNEES DES POINTS DE SORTIE DU SPECTRE
 211 FICHIER DES RESULTATS 2D
 212 FICHIER DES RESULTATS PONCTUELS""",
 213                 ang = """Determines the number of iterations over mean angular
 214 frequency from which the results are first written into the 2D RESULTS
 215 FILE and the PUNCTUAL RESULTS FILE.
 216 \\
 217  \begin{CommentBlock}{Related keywords}
 218 PERIOD FOR GRAPHIC PRINTOUTS\\
 219 VARIABLES FOR 2D GRAPHIC PRINTOUTS\\
 220 ABSCISSAE OF SPECTRUM PRINTOUT POINTS\\
 221 ORDINATES OF SPECTRUM PRINTOUT POINTS\\
 222 2D RESULTS FILE\\
 223 PUNCTUAL RESULTS FILE
 224 \end{CommentBlock}""",
 225             ),
 226 #           -----------------------------------
 227             ED_RESULTS_FILE = SIMP(statut ='o',
 228 #           -----------------------------------
 229                 typ = ('Fichier','All Files (*)','Sauvegarde'),
 230                 defaut = '',
 231                 fr = """Nom du fichier dans lequel seront ecrits les resultats du calcul
 232 bidimensionnels.
 233 Mots-cles associes
 234 VARIABLES POUR LES SORTIES GRAPHIQUES 2D
 235 PERIODE OUR LES SORTIES GRAPHIQUES
 236 NUMERO DE LA PREMIERE ITERATION POUR LES SORTIES GRAPHIQUES""",
 237                 ang = """Name of the file into which the results of the two-dimensional
 238 computation will be written.
 239 \\
 240  \begin{CommentBlock}{Related keywords}
 241 VARIABLES FOR 2D GRAPHIC PRINTOUTS\\
 242 PERIOD FOR GRAPHIC PRINTOUTS\\
 243 NUMBER OF FIRST ITERATION FOR GRAPHIC PRINTOUTS
 244 \end{CommentBlock}""",
 245             ),
 246 #           -----------------------------------
 247             ED_RESULTS_FILE_FORMAT = SIMP(statut ='o',
 248 #           -----------------------------------
 249                 typ = 'TXM',
 250                 into = ['SERAFIN','SERAFIND','MED'],
 251                 defaut = 'SERAFIN',
 252                 fr = """Format du fichier de geometrie.
 253 Les valeurs possibles sont :
 254 - SERAFIN : format standard simple precision pour Telemac;
 255 - SERAFIND: format standard double precision pour Telemac;
 256 - MED     : format MED base sur HDF5""",
 257                 ang = """Geometry file format.
 258 Possible values are:
 259 \begin{itemize}
 260 \item SERAFIN : classical single precision format in Telemac;
 261 \item SERAFIND: classical double precision format in Telemac;
 262 \item MED     : MED format based on HDF5
 263 \end{itemize}""",
 264             ),
 265 #           -----------------------------------
 266             PUNCTUAL_RESULTS_FILE = SIMP(statut ='f',
 267 #           -----------------------------------
 268                 typ = ('Fichier','All Files (*)','Sauvegarde'),
 269                 defaut = '',
 270                 fr = """Nom du fichier dans lequel seront ecrits les spectres
 271 ponctuels.
 272 **Mots-cles associes :**
 273 FORMAT DU FICHIER DE SPECTRE
 274 ABSCISSES DES POINTS DE SORTIE DU SPECTRE
 275 ORDONNEES DES POINTS DE SORTIE DU SPECTRE
 276 PERIODE POUR LES SORTIES GRAPHIQUES
 277 NUMERO DE LA PREMIERE ITERATION POUR LES SORTIES GRAPHIQUES""",
 278                 ang = """Name of the file into which the punctual spectra will be
 279 written.
 280 \\
 281  \begin{CommentBlock}{Related keywords}
 282 SPECTRUM FILE FORMAT\\
 283 ABSCISSAE OF SPECTRUM PRINTOUT POINTS\\
 284 ORDINATES OF SPECTRUM PRINTOUT POINTS\\
 285 PERIOD FOR GRAPHIC PRINTOUTS\\
 286 NUMBER OF FIRST ITERATION FOR GRAPHIC PRINTOUTS
 287 \end{CommentBlock}""",
 288             ),
 289 #           -----------------------------------
 290             SPECTRUM_FILE_FORMAT = SIMP(statut ='f',
 291 #           -----------------------------------
 292                 typ = 'TXM',
 293                 into = ['SERAFIN','SERAFIND','MED'],
 294                 defaut = 'SERAFIN',
 295                 fr = """Format du fichier de spectre
 296 Les valeurs possibles sont :
 297 - SERAFIN : format standard simple precision pour Telemac;
 298 - SERAFIND: format standard double precision pour Telemac;
 299 - MED     : format MED base sur HDF5""",
 300                 ang = """Spectrum results file format.
 301 Possible values are:
 302 \begin{itemize}
 303 \item SERAFIN : classical single precision format in Telemac;
 304 \item SERAFIND: classical double precision format in Telemac;
 305 \item MED     : MED format based on HDF5
 306 \end{itemize}""",
 307             ),
 308 #           -----------------------------------
 309             ABSCISSAE_OF_SPECTRUM_PRINTOUT_POINTS = SIMP(statut ='f',
 310 #           -----------------------------------
 311                 typ = 'R', min=0, max='**',
 312                 fr = """Tableau donnant les abscisses des points de sortie Seraphin du
 313 spectre et de dimension maximale 99. Les points de sortie du spectre
 314 sont les points 2D les plus proches des coordonnees specifiees
 315 **Mots-cles associes :**
 316 ORDONNEES DES POINTS DE SORTIE DU SPECTRE
 317 FICHIER DES RESULTATS PONCTUELS""",
 318                 ang = """Array providing the abscissae of the Seraphin spectrum printout
 319 points with a maximum dimension of 99. The chosen spectrum points are
 320 the closest 2D points to the specified co-ordinates.
 321 \\
 322  \begin{CommentBlock}{Related keywords}
 323 ORDINATES OF SPECTRUM PRINTOUT POINTS\\
 324 PUNCTUAL RESULTS FILE
 325 \end{CommentBlock}""",
 326             ),
 327 #           -----------------------------------
 328             ORDINATES_OF_SPECTRUM_PRINTOUT_POINTS = SIMP(statut ='f',
 329 #           -----------------------------------
 330                 typ = 'R', min=0, max='**',
 331                 fr = """Tableau donnant les ordonnees des points de sortie Seraphin du
 332 spectre et de dimension max 99.Les points de sortie du spectre
 333 sont les points 2D les plus proches des coordonnees specifiees
 334 **Mots-cles associes :**
 335 ABSCISSES DES POINTS DE SORTIE DU SPECTRE
 336 FICHIER DES RESULTATS PONCTUELS""",
 337                 ang = """Array providing the ordinates of the Seraphin spectrum printout
 338 points with a maximum dimension of 99. The spectrum printout points are
 339 the closest 2D points to the specified co-ordinates
 340 \\
 341  \begin{CommentBlock}{Related keywords}
 342 ABSCISSAE OF SPECTRUM PRINTOUT POINTS\\
 343 PUNCTUAL RESULT FILE
 344 \end{CommentBlock}""",
 345             ),
 346 #           -----------------------------------
 347             ZD_SPECTRA_RESULTS_FILE = SIMP(statut ='f',
 348 #           -----------------------------------
 349                 typ = ('Fichier','All Files (*)','Sauvegarde'),
 350                 defaut = '',
 351                 fr = """Nom du fichier dans lequel seront ecrits les spectres
 352 frequentiels ponctuels (integres selon les directions).
 353 **Mots-cles associes :**
 354 FICHIER DES RESULTATS PONCTUELS
 355 ABSCISSES DES POINTS DE SORTIE DU SPECTRE
 356 ORDONNEES DES POINTS DE SORTIE DU SPECTRE
 357 PERIODE POUR LES SORTIES GRAPHIQUES
 358 NUMERO DE LA PREMIERE ITERATION POUR LES SORTIES GRAPHIQUES""",
 359                 ang = """Name of the file into which the frequential punctual
 360 spectra (integrated according to the directions) will be written.
 361 \\
 362  \begin{CommentBlock}{Related keywords}
 363 PUNCTUAL RESULTS FILE\\
 364 ABSCISSAE OF SPECTRUM PRINTOUT POINTS\\
 365 ORDINATES OF SPECTRUM PRINTOUT POINTS\\
 366 PERIOD FOR GRAPHIC PRINTOUTS\\
 367 NUMBER OF FIRST ITERATION FOR GRAPHIC PRINTOUTS
 368 \end{CommentBlock}""",
 369             ),
 370 #           -----------------------------------
 371             GLOBAL_RESULT_FILE = SIMP(statut ='f',
 372 #           -----------------------------------
 373                 typ = ('Fichier','All Files (*)','Sauvegarde'),
 374                 defaut = '',
 375                 fr = """Nom du fichier dans lequel sera ecrit le tableau F (spectre
 376 de variance) en fin de calcul dans le but de faire une suite de calcul.
 377 **Mots-cles associes :**
 378 FORMAT DU FICHIER DES RESULTATS GLOBAUX""",
 379                 ang = """Name of the file in which the table F (density spectrum)
 380 is written at the end of the computation in order to realise a next
 381 computation.
 382 \\
 383  \begin{CommentBlock}{Related keywords}
 384 GLOBAL RESULT FILE FORMAT
 385 \end{CommentBlock}""",
 386             ),
 387 #           -----------------------------------
 388             GLOBAL_RESULT_FILE_FORMAT = SIMP(statut ='f',
 389 #           -----------------------------------
 390                 typ = 'TXM',
 391                 into = ['SERAFIN','SERAFIND','MED'],
 392                 defaut = 'SERAFIN',
 393                 fr = """Format du fichier de resultats du calcul precedent.
 394 Les valeurs possibles sont :
 395 - SERAFIN : format standard simple precision pour Telemac;
 396 - SERAFIND: format standard double precision pour Telemac;
 397 - MED     : format MED base sur HDF5""",
 398                 ang = """Previous computation results file format.
 399 Possible values are:
 400 \begin{itemize}
 401 \item SERAFIN : classical single precision format in Telemac;
 402 \item SERAFIND: classical double precision format in Telemac;
 403 \item MED     : MED format based on HDF5
 404 \end{itemize}""",
 405             ),
 406 #           -----------------------------------
 407             FILE_WITH_COORDINATES_OF_SPECTRA_TO_WRITE = SIMP(statut ='f',
 408 #           -----------------------------------
 409                 typ = ('Fichier','All Files (*)'),
 410                 defaut = '',
 411                 fr = """Fichier texte au format DAT de Salome avec les coordonnées
 412 des spectres a ecrire.""",
 413                 ang = """Text file following the DAT format of Salome with the
 414 coordinates of the spectra to output.""",
 415             ),
 416         ),
 417     ),
 418 #   -----------------------------------
 419     INPUT = FACT(statut='o',
 420 #   -----------------------------------
 421 #       -----------------------------------
 422         NAMES_OF_VARIABLES = SIMP(statut ='f',
 423 #       -----------------------------------
 424             typ = 'TXM', min= 5, max= 5,
 425             defaut = 'VELOCITY U      M/S;VELOCITY V      M/S;WIND ALONG X    M/S;WIND ALONG Y    M/S;WATER DEPTH     M',
 426             fr = """Nom des variables dans les fichiers au format SERAFIN
 427         1: Vitesse U
 428         2: Vitesse V
 429         3: Vitesse du vent suivant X
 430         4: Vitesse du vent suivant Y
 431         5: Profondeur""",
 432             ang = """Names of variables in SERAFIN format files
 433 \begin{itemize}
 434        \item 1: Velocity U
 435        \item 2: Velocity V
 436        \item 3: Wind velocity along X
 437        \item 4: Wind velocity along Y
 438        \item 5: Depth
 439 \end{itemize}""",
 440         ),
 441 #       -----------------------------------
 442         CURRENT_FILE = FACT(statut='o',
 443 #       -----------------------------------
 444 #           -----------------------------------
 445             CURRENTS_FILE_FORMAT = SIMP(statut ='f',
 446 #           -----------------------------------
 447                 typ = 'TXM',
 448                 into = ["Selafin, TELEMAC type","User format (couuti.f)"],
 449                 defaut = ["Selafin, TELEMAC type"],
 450                 fr = """Choix du type de format du fichier des courants :
 451 \begin{itemize}
 452 \item 3 = selafin du type TELEMAC
 453 \item 4 = format utilisateur (Modifier alors  la procedure couuti.f)
 454 \end{itemize}
 455 **Mots-cles associes :**
 456 FICHIER DES COURANTS BINAIRE
 457 FICHIER DES COURANTS FORMATE""",
 458                 ang = """Selection of the type of currents file format :
 459 \begin{itemize}
 460 \item 3 = selafin, TELEMAC type
 461 \item 4 = user format (the couuti.f procedure should then be amended)
 462 \end{itemize}
 463 \begin{CommentBlock}{Related keywords}
 464 CURRENTS BINARY FILE\\
 465 CURRENTS FORMATTED FILE\\
 466 \end{CommentBlock}""",
 467             ),
 468 #           -----------------------------------
 469             TIME_INCREMENT_NUMBER_IN_TELEMAC_FILE = SIMP(statut ='f',
 470 #           -----------------------------------
 471                 typ = 'I',
 472                 defaut = 1,
 473                 fr = """Indique le numero du pas de temps du fichier de resultats
 474 TELEMAC (fichier des courants) correspondant a l instant desire
 475 pour recuperer la donnee.
 476 **Mots-cles associes :**
 477 RANG DE LA DONNEE TELEMAC A RECUPERER
 478 RECUPERATION DE DONNEES TELEMAC""",
 479                 ang = """Indicates the number of the time increment in the TELEMAC
 480 results file (currents file) corresponding to the desired time for data
 481 recovery.
 482 \\
 483  \begin{CommentBlock}{Related keywords}
 484 RANK OF THE TELEMAC DATA ITEM TO BE RECOVERED\\
 485 RECOVERY OF TELEMAC DATA ITEM
 486 \end{CommentBlock}""",
 487             ),
 488 #           -----------------------------------
 489             TIME_UNIT_IN_CURRENTS_FILE = SIMP(statut ='f',
 490 #           -----------------------------------
 491                 typ = 'R',
 492                 defaut = 1.,
 493                 fr = """Unite donnee en secondes, par exemple 3600. si le temps
 494 est donne en heures""",
 495                 ang = """Unit given in seconds, for example 3600. if time
 496 is given in hours""",
 497             ),
 498 #           -----------------------------------
 499             TIME_SHIFT_IN_CURRENTS_FILE = SIMP(statut ='f',
 500 #           -----------------------------------
 501                 typ = 'R',
 502                 defaut = 0.,
 503                 fr = """Sera retranche au temps lu dans le fichier.
 504 L''unite est celle du fichier""",
 505                 ang = """Will be withdrawn from the time read in the file.
 506  The unit is that of the file""",
 507             ),
 508 #           -----------------------------------
 509             BINARY_CURRENTS_FILE = SIMP(statut ='f',
 510 #           -----------------------------------
 511                 typ = ('Fichier','All Files (*)'),
 512                 defaut = '',
 513                 fr = """Nom du fichier de donnees de courant (si binaire).
 514 **Mots-cles associes :**
 515 PRISE EN COMPTE D''UN COURANT STATIONNAIRE
 516 PRISE EN COMPTE DE LA MAREE
 517 FICHIER DES COURANTS FORMATE
 518 FORMAT DU FICHIER DES COURANTS""",
 519                 ang = """Name of the current data file (if binary).
 520 \\
 521  \begin{CommentBlock}{Related keywords}
 522 CONSIDERATION OF A STATIONARY CURRENT\\
 523 CONSIDERATION OF TIDE\\
 524 FORMATTED CURRENTS FILE\\
 525 CURRENTS FILE FORMAT
 526 \end{CommentBlock}""",
 527             ),
 528 #           -----------------------------------
 529             FORMATTED_CURRENTS_FILE = SIMP(statut ='f',
 530 #           -----------------------------------
 531                 typ = ('Fichier','All Files (*)'),
 532                 defaut = '',
 533                 fr = """Nom du fichier de donnees de courant (si formate).
 534 **Mots-cles associes :**
 535 PRISE EN COMPTE D''UN COURANT STATIONNAIRE
 536 PRISE EN COMPTE DE LA MAREE
 537 FICHIER DES COURANTS BINAIRE
 538 FORMAT DU FICHIER DES COURANTS""",
 539                 ang = """Name of the current data file (if formatted).
 540 \\
 541  \begin{CommentBlock}{Related keywords}
 542 CONSIDERATION OF A STATIONARY CURRENT\\
 543 CONSIDERATION OF TIDE\\
 544 BINARY CURRENTS FILE\\
 545 CURRENTS FILE FORMAT
 546 \end{CommentBlock}""",
 547             ),
 548 #           -----------------------------------
 549             BINARY_CURRENTS_FILE_FORMAT = SIMP(statut ='f',
 550 #           -----------------------------------
 551                 typ = 'TXM',
 552                 into = ['SERAFIN','SERAFIND','MED'],
 553                 defaut = 'SERAFIN',
 554                 fr = """Format du fichier binaire des courants.
 555 Les valeurs possibles sont :
 556 - SERAFIN : format standard simple precision pour Telemac;
 557 - SERAFIND: format standard double precision pour Telemac;
 558 - MED     : format MED base sur HDF5""",
 559                 ang = """Currents binary file format.
 560 Possible values are:
 561 \begin{itemize}
 562 \item SERAFIN : classical single precision format in Telemac;
 563 \item SERAFIND: classical double precision format in Telemac;
 564 \item MED     : MED format based on HDF5
 565 \end{itemize}""",
 566             ),
 567         ),
 568 #       -----------------------------------
 569         WIND_FILE = FACT(statut='o',
 570 #       -----------------------------------
 571 #           -----------------------------------
 572             WINDS_FILE_FORMAT = SIMP(statut ='f',
 573 #           -----------------------------------
 574                 typ = 'TXM',
 575                 into = ["Selafin, TELEMAC type","User format (venuti.f)"],
 576                 defaut = ["Selafin, TELEMAC type"],
 577                 fr = """Choix du type de format du fichier des vents :
 578 3 = selafin du type TELEMAC
 579 4 = format utilisateur (Modifier alors  la procedure venuti.f)
 580 **Mots-cles associes :**
 581 FICHIER DES VENTS BINAIRE
 582 FICHIER DES VENTS FORMATE""",
 583                 ang = """Selection of winds file format type :
 584 \begin{itemize}
 585 \item 3 = selafin, TELEMAC type
 586 \item 4 = user format (the venuti.f procedure should then be amended)
 587 \end{itemize}
 588  \begin{CommentBlock}{Related keywords}
 589 WINDS FILE TYPE\\
 590 WINDS FILE\\
 591 \end{CommentBlock}""",
 592             ),
 593 #           -----------------------------------
 594             TIME_UNIT_IN_WINDS_FILE = SIMP(statut ='f',
 595 #           -----------------------------------
 596                 typ = 'R',
 597                 defaut = 1.,
 598                 fr = """Unite donnee en secondes, par exemple 3600. si le temps
 599 est donne en heures""",
 600                 ang = """Unit given in seconds, for example 3600. if time
 601 is given in hours""",
 602             ),
 603 #           -----------------------------------
 604             TIME_SHIFT_IN_WINDS_FILE = SIMP(statut ='f',
 605 #           -----------------------------------
 606                 typ = 'R',
 607                 defaut = 0.,
 608                 fr = """Sera retranche au temps lu dans le fichier.
 609 L''unite est celle du fichier""",
 610                 ang = """Will be withdrawn from the time read in the file.
 611  The unit is that of the file""",
 612             ),
 613 #           -----------------------------------
 614             BINARY_WINDS_FILE = SIMP(statut ='f',
 615 #           -----------------------------------
 616                 typ = ('Fichier','All Files (*)'),
 617                 defaut = '',
 618                 fr = """Nom du fichier de donnees de vent (si binaire).
 619 **Mots-cles associes :**
 620 PRISE EN COMPTE DU VENT
 621 FICHIER DES VENTS FORMATE
 622 FORMAT DU FICHIER DES VENTS""",
 623                 ang = """Name of wind data file (if binary).
 624 \\
 625  \begin{CommentBlock}{Related keywords}
 626 CONSIDERATION OF WIND\\
 627 FORMATTED WINDS FILE\\
 628 WINDS FILE FORMAT
 629 \end{CommentBlock}""",
 630             ),
 631 #           -----------------------------------
 632             BINARY_WINDS_FILE_FORMAT = SIMP(statut ='f',
 633 #           -----------------------------------
 634                 typ = 'TXM',
 635                 into = ['SERAFIN','SERAFIND','MED'],
 636                 defaut = 'SERAFIN',
 637                 fr = """Format du fichier binaire des vents.
 638 Les valeurs possibles sont :
 639 - SERAFIN : format standard simple precision pour Telemac;
 640 - SERAFIND: format standard double precision pour Telemac;
 641 - MED     : format MED base sur HDF5""",
 642                 ang = """wind data binary file format.
 643 Possible values are:
 644 \begin{itemize}
 645 \item SERAFIN : classical single precision format in Telemac;
 646 \item SERAFIND: classical double precision format in Telemac;
 647 \item MED     : MED format based on HDF5
 648 \end{itemize}""",
 649             ),
 650 #           -----------------------------------
 651             FORMATTED_WINDS_FILE = SIMP(statut ='f',
 652 #           -----------------------------------
 653                 typ = ('Fichier','All Files (*)'),
 654                 defaut = '',
 655                 fr = """Nom du fichier de donnees de vent (si formate).
 656 **Mots-cles associes :**
 657 PRISE EN COMPTE DU VENT
 658 FICHIER DES VENTS BINAIRE
 659 FORMAT DU FICHIER DES VENTS""",
 660                 ang = """Name of wind data file (if formatted).
 661 \\
 662  \begin{CommentBlock}{Related keywords}
 663 CONSIDERATION OF WIND\\
 664 BINARY WINDS FILE\\
 665 WINDS FILE FORMAT
 666 \end{CommentBlock}""",
 667             ),
 668         ),
 669 #       -----------------------------------
 670         TIDAL_FILE = FACT(statut='o',
 671 #       -----------------------------------
 672 #           -----------------------------------
 673             TIDAL_WATER_LEVEL_FILE_FORMAT = SIMP(statut ='f',
 674 #           -----------------------------------
 675                 typ = 'TXM',
 676                 into = ["Selafin, TELEMAC type","User format (maruti.f)"],
 677                 defaut = ["Selafin, TELEMAC type"],
 678                 fr = """Choix du type de format du fichier du niveau de la maree :
 679 3 = selafin du type TELEMAC
 680 4 = format utilisateur (Modifier alors  la procedure maruti.f)
 681 **Mots-cles associes :**
 682 PRISE EN COMPTE DE LA MAREE
 683 FICHIER DU NIVEAU DE LA MAREE BINAIRE
 684 FICHIER DU NIVEAU DE LA MAREE FORMATE
 685 PERIODE D ACTUALISATION DE LA MAREE""",
 686                 ang = """Selection of the type of tidal water level file format :
 687 \begin{itemize}
 688 \item 3 = selafin, TELEMAC type
 689 \item 4 = user format (the maruti.f procedure should then be amended)
 690 \end{itemize}
 691  \begin{CommentBlock}{Related keywords}
 692 CONSIDERATION OF TIDE\\
 693 BINARY TIDAL WATER LEVEL FILE\\
 694 FORMATTED TIDAL WATER LEVEL FILE\\
 695 TIDE REFRESHING PERIOD
 696 \end{CommentBlock}""",
 697             ),
 698 #           -----------------------------------
 699             RANK_OF_THE_WATER_LEVEL_DATA_IN_THE_TELEMAC_FILE = SIMP(statut ='f',
 700 #           -----------------------------------
 701                 typ = 'I',
 702                 defaut = 4,
 703                 fr = """Rang de la variable donnant le niveau de la maree
 704 dans le fichier TELEMAC
 705 **Mots-cles associes :**
 706 PRISE EN COMPTE DE LA MAREE
 707 FICHIER DU NIVEAU DE LA MAREE BINAIRE
 708 FICHIER DU NIVEAU DE LA MAREE FORMATE
 709 PERIODE D ACTUALISATION DE LA MAREE""",
 710                 ang = """Rank of the water level data in the TELEMAC file
 711 \\
 712  \begin{CommentBlock}{Related keywords}
 713 CONSIDERATION OF TIDE\\
 714 BINARY TIDAL WATER LEVEL FILE\\
 715 FORMATTED TIDAL WATER LEVEL FILE\\
 716 TIDE REFRESHING PERIOD
 717 \end{CommentBlock}""",
 718             ),
 719 #           -----------------------------------
 720             TIME_UNIT_IN_TIDAL_WATER_LEVEL_FILE = SIMP(statut ='f',
 721 #           -----------------------------------
 722                 typ = 'R',
 723                 defaut = 1.,
 724                 fr = """Unite donnee en secondes, par exemple 3600. si le temps
 725 est donne en heures""",
 726                 ang = """Unit given in seconds, for example 3600. if time
 727 is given in hours""",
 728             ),
 729 #           -----------------------------------
 730             TIME_SHIFT_IN_TIDAL_WATER_LEVEL_FILE = SIMP(statut ='f',
 731 #           -----------------------------------
 732                 typ = 'R',
 733                 defaut = 0.,
 734                 fr = """Sera retranche au temps lu dans le fichier.
 735 L''unite est celle du fichier""",
 736                 ang = """Will be withdrawn from the time read in the file.
 737  The unit is that of the file""",
 738             ),
 739 #           -----------------------------------
 740             BINARY_TIDAL_WATER_LEVEL_FILE = SIMP(statut ='f',
 741 #           -----------------------------------
 742                 typ = ('Fichier','All Files (*)'),
 743                 defaut = '',
 744                 fr = """Nom du fichier de donnees du niveau d''eau (si binaire).
 745 **Mots-cles associes :**
 746 PRISE EN COMPTE DE LA MAREE
 747 FICHIER DU NIVEAU DE LA MAREE FORMATE
 748 FORMAT DU FICHIER DU NIVEAU DE LA MAREE
 749 PERIODE D ACTUALISATION DE LA MAREE""",
 750                 ang = """Name of the water level data file (if binary).
 751 \\
 752  \begin{CommentBlock}{Related keywords}
 753 CONSIDERATION OF TIDE\\
 754 FORMATTED TIDAL WATER LEVEL FILE\\
 755 TIDAL WATER LEVEL FILE FORMAT\\
 756 TIDE REFRESHING PERIOD
 757 \end{CommentBlock}""",
 758             ),
 759 #           -----------------------------------
 760             BINARY_TIDAL_WATER_FILE_FORMAT = SIMP(statut ='f',
 761 #           -----------------------------------
 762                 typ = 'TXM',
 763                 into = ['SERAFIN','SERAFIND','MED'],
 764                 defaut = 'SERAFIN',
 765                 fr = """Format du fichier de la maree binaire.
 766 Les valeurs possibles sont :
 767 - SERAFIN : format standard simple precision pour Telemac;
 768 - SERAFIND: format standard double precision pour Telemac;
 769 - MED     : format MED base sur HDF5""",
 770                 ang = """binary tidal water file format.
 771 Possible values are:
 772 \begin{itemize}
 773 \item SERAFIN : classical single precision format in Telemac;
 774 \item SERAFIND: classical double precision format in Telemac;
 775 \item MED     : MED format based on HDF5
 776 \end{itemize}""",
 777             ),
 778 #           -----------------------------------
 779             FORMATTED_TIDAL_WATER_LEVEL_FILE = SIMP(statut ='f',
 780 #           -----------------------------------
 781                 typ = ('Fichier','All Files (*)'),
 782                 defaut = '',
 783                 fr = """Nom du fichier de donnees du niveau d''eau (si formate).
 784 **Mots-cles associes :**
 785 PRISE EN COMPTE D UN COURANT
 786 FICHIER DES COURANTS BINAIRE
 787 FORMAT DU FICHIER DES COURANTS
 788 PERIODE D ACTUALISATION DE LA MAREE""",
 789                 ang = """Name of the tidal data file (if formatted).
 790 \\
 791  \begin{CommentBlock}{Related keywords}
 792 CONSIDERATION OF TIDE\\
 793 BINARY TIDAL WATER LEVEL FILE\\
 794 TIDAL WATER LEVEL FILE FORMAT\\
 795 TIDE REFRESHING PERIOD
 796 \end{CommentBlock}""",
 797             ),
 798         ),
 799 #       -----------------------------------
 800         DATA = FACT(statut='o',
 801 #       -----------------------------------
 802 #           -----------------------------------
 803             GEOMETRY_FILE = SIMP(statut ='o',
 804 #           -----------------------------------
 805                 typ = ('Fichier','All Files (*)'),
 806                 defaut = '',
 807                 fr = """Nom du fichier contenant le maillage du calcul a realiser.
 808 **Mots-cles associes :**
 809 FORMAT DU FICHIER DE GEOMETRIE""",
 810                 ang = """Name of the file containing the mesh of the computation to be
 811 made.
 812 \\
 813  \begin{CommentBlock}{Related keywords}
 814 GEOMETRY FILE FORMAT
 815 \end{CommentBlock}""",
 816             ),
 817 #           -----------------------------------
 818             GEOMETRY_FILE_FORMAT = SIMP(statut ='o',
 819 #           -----------------------------------
 820                 typ = 'TXM',
 821                 into = ['SERAFIN','SERAFIND','MED'],
 822                 defaut = 'SERAFIN',
 823                 fr = """Format du fichier de geometrie.
 824 Les valeurs possibles sont :
 825 - SERAFIN : format standard simple precision pour Telemac;
 826 - SERAFIND: format standard double precision pour Telemac;
 827 - MED     : format MED base sur HDF5""",
 828                 ang = """Geometry file format.
 829 Possible values are:
 830 \begin{itemize}
 831 \item SERAFIN : classical single precision format in Telemac;
 832 \item SERAFIND: classical double precision format in Telemac;
 833 \item MED     : MED format based on HDF5
 834 \end{itemize}""",
 835             ),
 836 #           -----------------------------------
 837             FORTRAN_FILE = SIMP(statut ='f',
 838 #           -----------------------------------
 839                 typ = 'FichierOuRepertoire',
 840                 defaut = '',
 841                 fr = """Nom du fichier FORTRAN a soumettre.""",
 842                 ang = """Name of FORTRAN file to be submitted.""",
 843             ),
 844 #           -----------------------------------
 845             BOUNDARY_CONDITIONS_FILE = SIMP(statut ='o',
 846 #           -----------------------------------
 847                 typ = ('Fichier','All Files (*)'),
 848                 defaut = '',
 849                 fr = """Nom du fichier contenant les types de conditions aux limites.
 850 Ce fichier est rempli de facon automatique par le mailleur au moyen de
 851 couleurs affectees aux noeuds des frontieres du domaine de calcul.""",
 852                 ang = """Name of the file containing the types of boundary conditions.
 853 This file is automatically filled by the grid generator by means of
 854 colours that are assigned to the boundary nodes in the computational
 855 domain.""",
 856             ),
 857 #           -----------------------------------
 858             BOTTOM_TOPOGRAPHY_FILE = SIMP(statut ='f',
 859 #           -----------------------------------
 860                 typ = ('Fichier','All Files (*)'),
 861                 defaut = '',
 862                 fr = """Nom du fichier eventuel contenant la bathymetrie associee au
 863 maillage au format SINUSX.
 864 Si ce mot-cle est utilise; c''est cette bathymetrie qui sera utilisee
 865 pour le calcul.""",
 866                 ang = """Name of any file containing the bathymetric data associated to
 867 the SINUSX-formatted grid. It this keyword is used, these bathymetric
 868 data shall be used for the computation.""",
 869             ),
 870 #           -----------------------------------
 871             BOTTOM_SMOOTHINGS = SIMP(statut ='f',
 872 #           -----------------------------------
 873                 typ = 'I',
 874                 defaut = 0,
 875                 fr = """Nombre de lissages effectues sur la topographie.
 876 Chaque lissage, effectue a l''aide d''une matrice de masse,
 877 est conservatif. A utiliser lorsque les donnees de bathymetrie
 878 donnent des resultats trop irreguliers apres interpolation.
 879 Voir aussi le sous-programme CORFON""",
 880                 ang = """Number of smoothings made on bottom features. Each smoothing,
 881 being made by means of a mass matrix, is conservative. To be used when
 882 the bathymetric data yield too irregular data after interpolation.
 883 Also refer to the CORFON subroutine.""",
 884             ),
 885 #           -----------------------------------
 886             NEXT_COMPUTATION = SIMP(statut ='f',
 887 #           -----------------------------------
 888                 typ = bool,
 889                 defaut = False,
 890                 fr = """Indique si on fait une suite de calcul.
 891 **Mots-cles associes :**
 892 FICHIER DU CALCUL PRECEDENT""",
 893                 ang = """Indicates whether a next compution is done.
 894 \\
 895  \begin{CommentBlock}{Related keywords}
 896 PREVIOUS COMPUTATION FILE
 897 \end{CommentBlock}""",
 898             ),
 899 #           -----------------------------------
 900             b_NEXT_COMPUTATIONG = BLOC(condition="NEXT_COMPUTATION == True",
 901 #           -----------------------------------
 902 #               -----------------------------------
 903                 PREVIOUS_COMPUTATION_FILE = SIMP(statut ='o',
 904 #               -----------------------------------
 905                     typ = ('Fichier','All Files (*)'),
 906                     defaut = '',
 907                     fr = """Nom d''un fichier contenant les resultats d''un calcul precedent
 908 realise sur le meme maillage et qui va fournir les conditions
 909 initiales pour une suite de calcul.
 910 **Mots-cles associes :**
 911 BINAIRE DU FICHIER DU CALCUL PRECEDENT""",
 912                     ang = """Name of the file containing the global results of a previous
 913 computation realised with the same mesh. This file gives the initial
 914 conditions for a next computation.
 915 \\
 916  \begin{CommentBlock}{Related keywords}
 917 BINARY OF THE PREVIOUS COMPUTATION FILE
 918 \end{CommentBlock}""",
 919                 ),
 920 #               -----------------------------------
 921                 PREVIOUS_COMPUTATION_FILE_FORMAT = SIMP(statut ='o',
 922 #               -----------------------------------
 923                     typ = 'TXM',
 924                     into = ['SERAFIN','SERAFIND','MED'],
 925                     defaut = 'SERAFIN',
 926                     fr = """Format du fichier de resultats du calcul precedent.
 927 Les valeurs possibles sont seulement:
 928 - SERAFIN : format standard simple precision pour Telemac;
 929 - SERAFIND: format standard double precision pour Telemac;
 930 - MED     : format MED base sur HDF5""",
 931                     ang = """Previous computation results file format.
 932 Possible values are only:
 933 \begin{itemize}
 934 \item SERAFIN : classical single precision format in Telemac;
 935 \item SERAFIND: classical double precision format in Telemac;
 936 \item MED     : MED format based on HDF5
 937 \end{itemize}""",
 938                 ),
 939             ),
 940 #           -----------------------------------
 941             REFERENCE_FILE = SIMP(statut ='f',
 942 #           -----------------------------------
 943                 typ = ('Fichier','All Files (*)'),
 944                 defaut = '',
 945                 fr = """Nom du fichier de reference en cas de validation.
 946 **Mots-cles associes :**
 947 VALIDATION""",
 948                 ang = """Name of validation data file
 949 \\
 950  \begin{CommentBlock}{Related keywords}
 951 VALIDATION
 952 \end{CommentBlock}""",
 953             ),
 954 #           -----------------------------------
 955             REFERENCE_FILE_FORMAT = SIMP(statut ='f',
 956 #           -----------------------------------
 957                 typ = 'TXM',
 958                 into = ['SERAFIN','SERAFIND','MED'],
 959                 defaut = 'SERAFIN',
 960                 fr = """Format du fichier de resultats du calcul precedent.
 961 Les valeurs possibles sont :
 962 - SERAFIN : format standard simple precision pour Telemac;
 963 - SERAFIND: format standard double precision pour Telemac;
 964 - MED     : format MED base sur HDF5""",
 965                 ang = """Previous computation results file format.
 966 Possible values are:
 967 \begin{itemize}
 968 \item SERAFIN : classical single precision format in Telemac;
 969 \item SERAFIND: classical double precision format in Telemac;
 970 \item MED     : MED format based on HDF5
 971 \end{itemize}""",
 972             ),
 973 #           -----------------------------------
 974             BINARY_FILE_1 = SIMP(statut ='f',
 975 #           -----------------------------------
 976                 typ = ('Fichier','All Files (*)'),
 977                 defaut = '',
 978                 fr = """Fichier de donnees code en binaire mis a la disposition
 979 de l''utilisateur.""",
 980                 ang = """Binary-coded data file made available to the user.""",
 981             ),
 982 #           -----------------------------------
 983             BINARY_DATA_FILE_1_FORMAT = SIMP(statut ='f',
 984 #           -----------------------------------
 985                 typ = 'TXM',
 986                 into = ['','SERAFIN','SERAFIND','MED'],
 987                 defaut = '',
 988                 fr = """Format du fichier des donnees binaires.
 989 Les valeurs possibles sont :
 990 - SERAFIN : format standard simple precision pour Telemac;
 991 - SERAFIND: format standard double precision pour Telemac;
 992 - MED     : format MED base sur HDF5""",
 993                 ang = """binary data file format.
 994 Possible values are:
 995 \begin{itemize}
 996 \item SERAFIN : classical single precision format in Telemac;
 997 \item SERAFIND: classical double precision format in Telemac;
 998 \item MED     : MED format based on HDF5
 999 \end{itemize}""",
1000             ),
1001 #           -----------------------------------
1002             FORMATTED_FILE_1 = SIMP(statut ='f',
1003 #           -----------------------------------
1004                 typ = ('Fichier','All Files (*)'),
1005                 defaut = '',
1006                 fr = """Fichier de donnees formate mis a la disposition
1007 de l''utilisateur.""",
1008                 ang = """Formatted data file made available to the user.""",
1009             ),
1010         ),
1011 #       -----------------------------------
1012         BOUNDARY_CONDITION_FILE = FACT(statut='o',
1013 #       -----------------------------------
1014 #           -----------------------------------
1015             FILE_WITH_COORDINATES_OF_SPECTRA_TO_IMPOSE = SIMP(statut ='f',
1016 #           -----------------------------------
1017                 typ = ('Fichier','All Files (*)'),
1018                 defaut = '',
1019                 fr = """Fichier texte au format DAT de Salome avec les coordonnées
1020 des spectres qui vont etre impose en conditions limites.""",
1021                 ang = """Text file following the DAT format of Salome with the
1022 coordinates of the spectra that will be imposed on the boundary.
1023 \\
1024  \begin{CommentBlock}{Related keywords}
1025 IMPOSED SPECTRA FILE
1026 IMPOSED SPECTRA FILE FORMAT
1027 TIME UNIT OF IMPOSED SPECTRA FILE
1028 TIME SHIFT OF IMPOSED SPECTRA FILE
1029 \end{CommentBlock}""",
1030             ),
1031 #           -----------------------------------
1032             IMPOSED_SPECTRA_FILE = SIMP(statut ='f',
1033 #           -----------------------------------
1034                 typ = ('Fichier','All Files (*)'),
1035                 defaut = '',
1036                 fr = """Nom du fichier contenant le maillage des spectres a imposer.""",
1037                 ang = """Name of the file containing the mesh with the imposed spectra.
1038 \\
1039  \begin{CommentBlock}{Related keywords}
1040 IMPOSED SPECTRA FILE FORMAT
1041 TIME UNIT OF IMPOSED SPECTRA FILE
1042 TIME SHIFT OF IMPOSED SPECTRA FILE
1043 FILE WITH COORDINATES OF SPECTRA TO IMPOSE
1044 \end{CommentBlock}""",
1045             ),
1046 #           -----------------------------------
1047             IMPOSED_SPECTRA_FILE_FORMAT = SIMP(statut ='f',
1048 #           -----------------------------------
1049                 typ = 'TXM',
1050                 into = ['SERAFIN','SERAFIND','MED'],
1051                 defaut = 'SERAFIN',
1052                 fr = """Format du fichier des spectres imposes.
1053 Les valeurs possibles sont :
1054 - SERAFIN : format standard simple precision pour Telemac;
1055 - SERAFIND: format standard double precision pour Telemac;
1056 - MED     : format MED base sur HDF5""",
1057                 ang = """Imposed spectra file format.
1058 Possible values are:
1059 \begin{itemize}
1060 \item SERAFIN : classical single precision format in Telemac;
1061 \item SERAFIND: classical double precision format in Telemac;
1062 \item MED     : MED format based on HDF5
1063 \end{itemize}
1064
1065 \begin{CommentBlock}{Related keywords}
1066 IMPOSED SPECTRA FILE
1067 TIME UNIT OF IMPOSED SPECTRA FILE
1068 TIME SHIFT OF IMPOSED SPECTRA FILE
1069 FILE WITH COORDINATES OF SPECTRA TO IMPOSE
1070 \end{CommentBlock}""",
1071             ),
1072 #           -----------------------------------
1073             TIME_UNIT_OF_IMPOSED_SPECTRA_FILE = SIMP(statut ='f',
1074 #           -----------------------------------
1075                 typ = 'R',
1076                 defaut = [1.],
1077                 fr = """Unite donnee en secondes, par exemple 3600. si le temps
1078 est donne en heures.""",
1079                 ang = """Unit given in seconds, for example 3600. if time
1080 is given in hours.
1081 \\
1082  \begin{CommentBlock}{Related keywords}
1083 IMPOSED SPECTRA FILE
1084 IMPOSED SPECTRA FILE FORMAT
1085 TIME SHIFT OF IMPOSED SPECTRA FILE
1086 FILE WITH COORDINATES OF SPECTRA TO IMPOSE
1087 \end{CommentBlock}""",
1088             ),
1089 #           -----------------------------------
1090             TIME_SHIFT_OF_IMPOSED_SPECTRA_FILE = SIMP(statut ='f',
1091 #           -----------------------------------
1092                 typ = 'R',
1093                 defaut = [0.],
1094                 fr = """Sera retranche au temps lu dans le fichier.
1095 L''unite est celle du fichier.""",
1096                 ang = """Will be withdrawn from the time read in the file.
1097  The unit is that of the file.
1098 \\
1099  \begin{CommentBlock}{Related keywords}
1100 IMPOSED SPECTRA FILE
1101 IMPOSED SPECTRA FILE FORMAT
1102 TIME UNIT OF IMPOSED SPECTRA FILE
1103 FILE WITH COORDINATES OF SPECTRA TO IMPOSE
1104 \end{CommentBlock}""",
1105             ),
1106         ),
1107     ),
1108 )
1109 # -----------------------------------------------------------------------
1110 GENERAL_PARAMETERS = PROC(nom= "GENERAL_PARAMETERS",op = None,
1111 # -----------------------------------------------------------------------
1112 #   -----------------------------------
1113     TIME = FACT(statut='o',
1114 #   -----------------------------------
1115 #       -----------------------------------
1116         NUMBER_OF_TIME_STEP = SIMP(statut ='o',
1117 #       -----------------------------------
1118             typ = 'I',
1119             fr = """Definit le nombre de pas de temps effectues lors de
1120 l''execution du code.
1121 **Mots-cles associes :**
1122 PAS DE TEMPS""",
1123             ang = """Define the number of time step.
1124 \\
1125  \begin{CommentBlock}{Related keywords}
1126 TIME STEP
1127 \end{CommentBlock}""",
1128         ),
1129 #       -----------------------------------
1130         TIME_STEP = SIMP(statut ='o',
1131 #       -----------------------------------
1132             typ = 'R',
1133             fr = """Definit le pas de temps en secondes.
1134 **Mots-cles associes :**
1135 NOMBRE DE PAS DE TEMPS""",
1136             ang = """Define the time step in seconds.
1137 \\
1138  \begin{CommentBlock}{Related keywords}
1139 NUMBER OF TIME STEPS
1140 \end{CommentBlock}""",
1141         ),
1142 #       -----------------------------------
1143         DATE_OF_COMPUTATION_BEGINNING = SIMP(statut ='f',
1144 #       -----------------------------------
1145             typ = 'R',
1146             defaut = 0,
1147             fr = """Donne la date du debut du calcul au format aaaammjjhhmm
1148 ce qui permet de se reperer par rapport au fichier des vents,
1149 199310241524 represente le 24 octobre 93 a 15h24.
1150 **Mots-cles associes :**
1151 FICHIER DES VENTS BINAIRE
1152 FICHIER DES VENTS FORMATE
1153 FORMAT DU FICHIER DES VENTS""",
1154             ang = """Gives the date of the computation beginning. The format
1155 is yyyymmddhhmm,
1156 as an exemple 199310241524 means the 24 october 93
1157 at 15h24. This date gives a reference for reading the
1158 wind file.
1159 \\
1160  \begin{CommentBlock}{Related keywords}
1161 BINARY WIND FILE\\
1162 FORMATTED WIND FILE\\
1163 WIND FILE FORMAT
1164 \end{CommentBlock}""",
1165         ),
1166 #       -----------------------------------
1167         INITIAL_TIME_SET_TO_ZERO = SIMP(statut ='f',
1168 #       -----------------------------------
1169             typ = bool,
1170             defaut = False,
1171             fr = """Remet le temps a zero en cas de suite de calcul""",
1172             ang = """Initial time set to zero in case of restart""",
1173         ),
1174     ),
1175 #   -----------------------------------
1176     SPECTRAL_DISCRETISATION = FACT(statut='o',
1177 #   -----------------------------------
1178 #       -----------------------------------
1179         NUMBER_OF_DIRECTIONS = SIMP(statut ='o',
1180 #       -----------------------------------
1181             typ = 'I',
1182             defaut = 12,
1183             fr = """Definit le nombre de directions de propagation de la houle.
1184 Les directions de propagation sont regulierement reparties entre 0
1185 et 360 degres.""",
1186             ang = """Defines the number of wave propagation directions. The
1187 propagation directions are evenly distributed from 0 to 360 degrees.""",
1188         ),
1189 #       -----------------------------------
1190         NUMBER_OF_FREQUENCIES = SIMP(statut ='o',
1191 #       -----------------------------------
1192             typ = 'I',
1193             defaut = 15,
1194             fr = """Definit le nombre de frequences de propagation de la houle.
1195 Les frequences sont reparties geometriquement en fonction de la
1196 FREQUENCE MINIMALE et RAISON FREQUENTIELLE.
1197 **Mots-cles associes :**
1198 FREQUENCE MINIMALE
1199 RAISON FREQUENTIELLE
1200 FACTEUR DE QUEUE DU SPECTRE""",
1201             ang = """Defines the number of wave propagation frequencies. The
1202 propagation frequencies are geometrically distributed as a fonction
1203 of the MINIMAL FREQUENCY OF THE COMPUTATION and the FREQUENTIAL
1204 REASON
1205 \\
1206  \begin{CommentBlock}{Related keywords}
1207 FREQUENTIAL RATIO\\
1208 SPECTRUM TAIL FACTOR
1209 \end{CommentBlock}""",
1210         ),
1211 #       -----------------------------------
1212         MINIMAL_FREQUENCY = SIMP(statut ='o',
1213 #       -----------------------------------
1214             typ = 'R',
1215             fr = """Definit la frequence minimale en Hz.
1216 On obtient les autres frequences grace a la RAISON FREQUENTIELLE r et le
1217 NOMBRE DE FREQUENCES NF par $f=f0*r^{k-1}$ k=1,NF.
1218 **Mots-cles associes :**
1219 RAISON FREQUENTIELLE
1220 NOMBRE DE FREQUENCES
1221 FACTEUR DE QUEUE DU SPECTRE""",
1222             ang = """Define the minimal frequency in Hz. The discretised frequencies
1223 are computed from the FREQUENTIAL RATIO r and the NUMBER OF FREQUENCIES
1224 NF by the relation $f=f_0*r^{k-1}$ k=1,NF.
1225 \\
1226  \begin{CommentBlock}{Related keywords}
1227 FREQUENTIAL RATIO\\
1228 NUMBER OF FREQUENCIES\\
1229 SPECTRUM TAIL FACTOR
1230 \end{CommentBlock}""",
1231         ),
1232 #       -----------------------------------
1233         FREQUENTIAL_RATIO = SIMP(statut ='o',
1234 #       -----------------------------------
1235             typ = 'R',
1236             defaut = 1.1,
1237             fr = """Definit le rapport entre 2 frequences de discretisation
1238 successives. On obtient les autres frequences grace a la FREQUENCE
1239 MINIMALE f0 et le NOMBRE DE FREQUENCES NF par $f=f0*r^{k-1}$ k=1,NF.
1240 **Mots-cles associes :**
1241 FREQUENCE MINIMALE
1242 NOMBRE DE FREQUENCES
1243 FACTEUR DE QUEUE DU SPECTRE""",
1244             ang = """Define the ratio between 2 successive discretised
1245 frequencies
1246 \\
1247  \begin{CommentBlock}{Related keywords}
1248 MINIMAL FREQUENCY\\
1249 NUMBER OF FREQUENCIES\\
1250 SPECTRUM TAIL FACTOR
1251 \end{CommentBlock}""",
1252         ),
1253 #       -----------------------------------
1254         SPECTRUM_TAIL_FACTOR = SIMP(statut ='f',
1255 #       -----------------------------------
1256             typ = 'R',
1257             defaut = 5.,
1258             fr = """Utilise pour calculer l energie des frequences superieures a la
1259 **Mots-cles associes :**
1260 NOMBRE DE FREQUENCES
1261 FREQUENCE MINIMALE
1262 RAISON FREQUENTIELLE""",
1263             ang = """decay order of the hight frequencies (Beyond cut off frequency)
1264 \\
1265  \begin{CommentBlock}{Related keywords}
1266 NUMBER OF FREQUENCIES\\
1267 FREQUENTIAL RATIO
1268 \end{CommentBlock}""",
1269         ),
1270 #       -----------------------------------
1271         SPECTRUM_ENERGY_THRESHOLD = SIMP(statut ='f',
1272 #       -----------------------------------
1273             typ = 'R',
1274             defaut = 1.E-30,
1275             fr = """ En condition initiale, une energie inferieure a ce seuil
1276 pour un couple frequence-direction donnee est prise nulle. Utile
1277 surtout pour les comparaisons avec WAM cycle 4.""",
1278             ang = """For initial conditions, the energy on a frequency-direction
1279 component lower to this threshold is taken to 0.
1280 Useful for comparisons with WAM cycle 4.""",
1281         ),
1282 #       -----------------------------------
1283         OPTION_FOR_DIAGNOSTIC_TAIL = SIMP(statut ='f',
1284 #       -----------------------------------
1285             typ = 'I',
1286             defaut = [1],
1287             fr = """Permet de choisir la methode de correction de la
1288 partie diagnostique du spectre.
1289 \begin{itemize}
1290 \item 0 : Pas de queue diagnostique
1291 \item 1 : Une decroissance en $f^{-TAILF}$ est imposee au dessus de
1292 max(4fPM;2.5fmoy)
1293 \end{itemize}
1294 **Mots-cles associes :**
1295 FACTEUR DE QUEUE DU SPECTRE
1296 NOMBRE DE FREQUENCES
1297 RAISON FREQUENTIELLE""",
1298             ang = """Option to treat the spectrum diagnotic tail.
1299 \begin{itemize}
1300 \item 0 : No diagnostic tail
1301 \item 1 : A decrease in $f^{-TAILF}$ is imposed beyond
1302 max(4fPM;2.5fmoy)
1303 \end{itemize}
1304  \begin{CommentBlock}{Related keywords}
1305 SPECTRUM TAIL FACTOR\\
1306 NUMBER OF FREQUENCIES\\
1307 FREQUENTIAL RATIO
1308 \end{CommentBlock}""",
1309         ),
1310     ),
1311 #   -----------------------------------
1312     METEO = FACT(statut='o',
1313 #   -----------------------------------
1314 #       -----------------------------------
1315         TIDE_REFRESHING_PERIOD = SIMP(statut ='f',
1316 #       -----------------------------------
1317             typ = 'I',
1318             defaut = 1,
1319             fr = """Determine la periode, en nombre d''iterations,
1320 d''actualisation de la profondeur d''eau et des courants de maree.
1321 **Mots-cles associes :**
1322 PRISE EN COMPTE DE LA MAREE
1323 FICHIER DU NIVEAU DE LA MAREE BINAIRE
1324 FICHIER DU NIVEAU DE LA MAREE FORMATE
1325 FORMAT DU FICHIER DU NIVEAU DE LA MAREE""",
1326             ang = """Determines the period in number of iterations to
1327 update the tidal currents and the water depth.
1328 \\
1329  \begin{CommentBlock}{Related keywords}
1330 CONSIDERATION OF TIDE\\
1331 BINARY TIDAL WATER LEVEL FILE\\
1332 FORMATTED TIDAL WATER LEVEL FILE\\
1333 FORMAT DU FICHIER DU NIVEAU DE LA MAREE\\
1334 \end{CommentBlock}""",
1335         ),
1336 #       -----------------------------------
1337         WIND_VELOCITY_ALONG_X = SIMP(statut ='f',
1338 #       -----------------------------------
1339             typ = 'R',
1340             defaut = 0.,
1341             fr = """Vitesse du vent suivant X, constante et homogene (en m/s)
1342 **Mots-cles associes :**
1343 PRISE EN COMPTE DU VENT""",
1344             ang = """Wind velocity along X axis, constant and homogeneous (m/s)
1345 \\
1346  \begin{CommentBlock}{Related keywords}
1347 CONSIDERATION OF A WIND
1348 \end{CommentBlock}""",
1349         ),
1350 #       -----------------------------------
1351         WIND_VELOCITY_ALONG_Y = SIMP(statut ='f',
1352 #       -----------------------------------
1353             typ = 'R',
1354             defaut = 0.,
1355             fr = """Vitesse du vent suivant Y, constante et homogene (en m/s)
1356 **Mots-cles associes :**
1357 PRISE EN COMPTE DU VENT""",
1358             ang = """Wind velocity along Y axis, constant and homogeneous (m/s)
1359 \\
1360  \begin{CommentBlock}{Related keywords}
1361 CONSIDERATION OF A WIND
1362 \end{CommentBlock}""",
1363         ),
1364 #       -----------------------------------
1365         CONSIDERATION_OF_A_STATIONARY_CURRENT = SIMP(statut ='o',
1366 #       -----------------------------------
1367             typ = bool,
1368             defaut = False,
1369             fr = """Indique si on prend en compte un courant, dans un fichier ou
1370 dans condiw.f.
1371 **Mots-cles associes :**
1372 FICHIER DES COURANTS""",
1373             ang = """Indicates whether a stationary current is taken into account,
1374 either in a file or in condiw.f.
1375 \\
1376  \begin{CommentBlock}{Related keywords}
1377 CURRENTS FILE
1378 \end{CommentBlock}""",
1379         ),
1380 #       -----------------------------------
1381         CONSIDERATION_OF_A_WIND = SIMP(statut ='o',
1382 #       -----------------------------------
1383             typ = bool,
1384             defaut = False,
1385             fr = """Indique si on prend en compte un vent, dans un fichier ou dans
1386 venuti.f.
1387 **Mots-cles associes :**
1388 FICHIER DES VENTS""",
1389             ang = """Indicates whether a wind is taken into account, either in
1390 a file or in venuti.f
1391 \\
1392  \begin{CommentBlock}{Related keywords}
1393 WINDS FILE
1394 \end{CommentBlock}""",
1395         ),
1396 #       -----------------------------------
1397         STATIONARY_WIND = SIMP(statut ='f',
1398 #       -----------------------------------
1399             typ = bool,
1400             defaut = [True ],
1401             fr = """Indique si le vent evolue dans le temps et doit etre mis a jour
1402 **Mots-cles associes :**
1403 PRISE EN COMPTE DU VENT""",
1404             ang = """Indicates whether the wind evolves temporally and requires
1405 to be updated
1406 \\
1407  \begin{CommentBlock}{Related keywords}
1408 CONSIDERATION OF A WIND
1409 \end{CommentBlock}""",
1410         ),
1411 #       -----------------------------------
1412         CONSIDERATION_OF_TIDE = SIMP(statut ='o',
1413 #       -----------------------------------
1414             typ = bool,
1415             defaut = False,
1416             fr = """Indique si on prend en compte l''influence de la maree,
1417 c''est-a-dire, prise en compte d''un niveau d''eau et de courants
1418 instationnaires.
1419 **Mots-cles associes :**
1420 FICHIER DU NIVEAU DE LA MAREE FORMATE
1421 FICHIER DU NIVEAU DE LA MAREE BINAIRE
1422 FORMAT DU FICHIER DU NIVEAU DE LA MAREE
1423 PERIODE D ACTUALISATION DE LA MAREE""",
1424             ang = """Indicates whether a current is taken into account, either in
1425 a file or in cdicow.f.
1426 \\
1427  \begin{CommentBlock}{Related keywords}
1428 FORMATTED TIDAL WATER LEVEL FILE\\
1429 BINARY TIDAL WATER LEVEL FILE\\
1430 TIDAL WATER LEVEL FILE FORMAT\\
1431 TIDE REFRESHING PERIOD
1432 \end{CommentBlock}""",
1433         ),
1434     ),
1435 #   -----------------------------------
1436     MISCELLANEOUS = FACT(statut='f',
1437 #   -----------------------------------
1438 #       -----------------------------------
1439         NUMBER_OF_PRIVATE_ARRAYS = SIMP(statut ='f',
1440 #       -----------------------------------
1441             typ = 'I',
1442             defaut = 0,
1443             fr = """Nombre de tableaux utilises en variables privees par
1444 l''utilisateur""",
1445             ang = """Number of private arrays used by the user""",
1446         ),
1447 #       -----------------------------------
1448         DEBUGGER = SIMP(statut ='f',
1449 #       -----------------------------------
1450             typ = 'I',
1451             defaut = 0,
1452             fr = """Pour imprimer la sequence des appels, mettre 1""",
1453             ang = """If 1, calls of subroutines will be printed in the listing""",
1454         ),
1455 #       -----------------------------------
1456         PARALLEL_PROCESSORS = SIMP(statut ='f',
1457 #       -----------------------------------
1458             typ = 'I',
1459             defaut = 0,
1460             fr = """NOMBRE DE PROCESSEURS EN CALCUL PARALLELE
1461 0 : 1 machine, compilation sans bibliotheque de parallelisme
1462 1 : 1 machine, compilation avec bibliotheque de parallelisme
1463 2 : 2 processeurs ou machines en parallele
1464 etc...""",
1465             ang = """NUMBER OF PROCESSORS FOR PARALLEL PROCESSING
1466 0 : 1 machine, compiling without parallel library
1467 1 : 1 machine, compiling with a parallel library
1468 2 : 2 processors or machines in parallel
1469 etc....""",
1470         ),
1471 #       -----------------------------------
1472         FINITE_ELEMENT_ASSEMBLY = SIMP(statut ='f',
1473 #       -----------------------------------
1474             typ = 'I',
1475             defaut = [1],
1476             fr = """1 : normal 2 : avec des entiers I8""",
1477             ang = """1: normal 2: with I8 integers""",
1478         ),
1479 #       -----------------------------------
1480         TITLE = SIMP(statut ='f',
1481 #       -----------------------------------
1482             typ = 'TXM',
1483             defaut = 'SET A TITLE !!!',
1484             fr = """Titre du cas etudie""",
1485             ang = """Title of the case being studied.""",
1486         ),
1487 #       -----------------------------------
1488         PARTITIONING_TOOL = SIMP(statut ='f',
1489 #       -----------------------------------
1490             typ = 'TXM',
1491             into = ['METIS','SCOTCH','PARMETIS','PTSCOTCH'],
1492             defaut = 'METIS',
1493             fr = """CHOIX DU PARTITIONNEUR
1494 1 : METIS
1495 2 : SCOTCH
1496 3 : PARMETIS
1497 4 : PTSCOTCH
1498 etc...""",
1499             ang = """PARTITIONING TOOL SELECTION
1500 \begin{itemize}
1501 \item 1 : METIS
1502 \item 2 : SCOTCH
1503 \item 3 : PARMETIS
1504 \item 4 : PTSCOTCH
1505 \end{itemize}""",
1506         ),
1507 #       -----------------------------------
1508         RECOVERY_OF_TELEMAC_DATA_ITEM = SIMP(statut ='f',
1509 #       -----------------------------------
1510             typ = bool,
1511             defaut = [False],
1512             fr = """Indique si on recupere des donnees TELEMAC dans LECDON.f
1513 Si oui il faut veiller a utiliser un FICHIER DES COURANTS au bon format
1514 et donner le rang de la variable en question dans le fichier TELEMAC.
1515 **Mots-cles associes :**
1516 FICHIER DES COURANTS BINAIRE
1517 FICHIER DES COURANTS FORMATE
1518 FORMAT DU FICHIER DES COURANTS
1519 RANG DE LA DONNEE TELEMAC A RECUPERER
1520 NUMERO DU PAS DE TEMPS DU FICHIER TELEMAC""",
1521             ang = """Indicates whether TELEMAC data are recovered in LECDON. If so,
1522 a proper-formatted CURRENTS FILE should be used and the rank of the
1523 respective variable should be entered into the TELEMAC file.
1524 \\
1525  \begin{CommentBlock}{Related keywords}
1526 BINARY CURRENTS FILE\\
1527 FORMATTED CURRENTS FILE\\
1528 CURRENTS FILE TYPE\\
1529 RANK OF THE TELEMAC DATA ITEM TO BE RECOVERED\\
1530 TIME INCREMENT NUMBER IN TELEMAC FILE
1531 \end{CommentBlock}""",
1532         ),
1533 #       -----------------------------------
1534         CONSIDERATION_OF_PROPAGATION = SIMP(statut ='f',
1535 #       -----------------------------------
1536             typ = bool,
1537             defaut = [True ],
1538             fr = """Indique si on prend en compte la propagation""",
1539             ang = """Indicates whether propagation is taken into account.""",
1540         ),
1541 #       -----------------------------------
1542         VALIDATION = SIMP(statut ='f',
1543 #       -----------------------------------
1544             typ = bool,
1545             defaut = [False],
1546             fr = """Logique indiquant si on effectue un calcul de validation
1547 **Mots-cles associes :**
1548 FICHIER DE REFERENCE""",
1549             ang = """True if the computation is a validation
1550 \\
1551  \begin{CommentBlock}{Related keywords}
1552 REFERENCE FILE
1553 \end{CommentBlock}""",
1554         ),
1555 #       -----------------------------------
1556         b_VALIDATIONG = BLOC(condition="VALIDATION == True",
1557 #       -----------------------------------
1558         ),
1559 #       -----------------------------------
1560         CHECKING_THE_MESH = SIMP(statut ='f',
1561 #       -----------------------------------
1562             typ = bool,
1563             defaut = False,
1564             fr = """Si oui on appelle le sous-programme checkmesh qui verifie
1565 la coherence du maillage, points superposes, etc.""",
1566             ang = """if this key word is equal to yes, a call to subroutine
1567 checkmesh will look for errors in the mesh, superimposed points, etc.""",
1568         ),
1569     ),
1570 #   -----------------------------------
1571     OTHER_DOMAIN_DEFINITIONS = FACT(statut='o',
1572 #   -----------------------------------
1573 #       -----------------------------------
1574         ORIGIN_COORDINATES = SIMP(statut ='f',
1575 #       -----------------------------------
1576             typ = 'I', min= 2, max= 2,
1577             defaut = [0,0],
1578             fr = """Valeur en metres, utilise pour eviter les trop grands nombres,
1579 transmis dans le format Selafin mais pas d''autre traitement pour
1580 l''instant""",
1581             ang = """Value in metres, used to avoid large real numbers,
1582 added in Selafin format, but so far no other treatment""",
1583         ),
1584 #       -----------------------------------
1585         MINIMUM_WATER_DEPTH = SIMP(statut ='o',
1586 #       -----------------------------------
1587             typ = 'R',
1588             defaut = 0.1,
1589             fr = """Definit la profondeur d eau minimale en dessous de laquelle
1590 les fonds sont supposes emerges.""",
1591             ang = """Defines the minimum water depth below which bottom elevations
1592 are regarded as dry.""",
1593         ),
1594 #       -----------------------------------
1595         SPHERICAL_COORDINATES = SIMP(statut ='f',
1596 #       -----------------------------------
1597             typ = bool,
1598             defaut = [False],
1599             fr = """Indique si on se place ou non en coordonnes spheriques.
1600 ATTENTION, en coordonnees cartesiennes, les coordonnees sont
1601 exprimees em m alors que ce sont des degres en coordonnees
1602 spheriques.""",
1603             ang = """Indicates whether the coordinates are spherical (unit=
1604 degree) or cartesian (unit = meter).""",
1605         ),
1606 #       -----------------------------------
1607         INFINITE_DEPTH = SIMP(statut ='o',
1608 #       -----------------------------------
1609             typ = bool,
1610             defaut = False,
1611             fr = """Indique si on se place dans l hypothese de profondeur infinie.
1612 Cette option inhibe les frottements sur le fond.""",
1613             ang = """Indicates whether an infinite depth is assumed. If so, bottom
1614 friction is inhibited.""",
1615         ),
1616 #       -----------------------------------
1617         TRIGONOMETRICAL_CONVENTION = SIMP(statut ='f',
1618 #       -----------------------------------
1619             typ = bool,
1620             defaut = [False],
1621             fr = """Logique indiquant si les directions de propagation
1622 de la houle sont definies dans le sens trigonometrique a
1623 partir de l axe des x positifs, ou definies dans le sens
1624 des aiguilles d une montre a partir du nord geographique""",
1625             ang = """True if the wave directions are measured
1626 counterclockwise from the positive x-axis, false if
1627 they are measured clockwise fron geographic North""",
1628         ),
1629     ),
1630 )
1631 # -----------------------------------------------------------------------
1632 SOURCE_TERMS = PROC(nom= "SOURCE_TERMS",op = None,
1633 # -----------------------------------------------------------------------
1634 #   -----------------------------------
1635     BAJ_MODELING = SIMP(statut ='o',
1636 #   -----------------------------------
1637         typ = 'TXM',
1638         into = ["classical modelisation","BAJ Modeling"],
1639         defaut = ["classical modelisation"],
1640         fr = """Type de calcul de la frequence centrale
1641 Si sa valeur est 0, on prend la formulation classique
1642 Si sa valeur est 1 on pren la modelisation BAJ proposee
1643 par Laugel (2013) pour le calcul de la frequence centrale
1644 et le limiteur de croissance
1645 **Mots-cles associes :**
1646 PRISE EN COMPTE DES TERMES SOURCES""",
1647         ang = """Choice of the calculus of centrale frequency
1648 if its value is 0, classical choice
1649 if its value is 1, BAJ choice proposed by Laugel (2013).
1650 \\
1651  \begin{CommentBlock}{Related keywords}
1652 CONSIDERATION OF SOURCE TERMS
1653 \end{CommentBlock}""",
1654     ),
1655 #   -----------------------------------
1656     CONSIDERATION_OF_SOURCE_TERMS = SIMP(statut ='f',
1657 #   -----------------------------------
1658         typ = bool,
1659         defaut = True,
1660         fr = """Indique la prise en compte ou non de l ensemble des termes
1661 sources.
1662 **Mots-cles associes :**
1663 APPORTS DUS AU VENT
1664 DISSIPATION PAR FROTTEMENT SUR LE FOND
1665 DISSIPATION PAR MOUTONNEMENT
1666 DISSIPATION PAR DEFERLEMENT
1667 DISSIPATION PAR WAVE BLOCKING
1668 TRANSFERTS NON LINEAIRES INTER-FREQUENCES
1669 TRANSFERTS ENTRE TRIPLETS DE FREQUENCES""",
1670         ang = """Indicates whether the source terms are taken into
1671 account or not.
1672 \\
1673  \begin{CommentBlock}{Related keywords}
1674 WIND GENERATION\\
1675 BOTTOM FRICTION DISSIPATION\\
1676 WHITE CAPPING DISSIPATION\\
1677 DEPTH-INDUCED BREAKING DISSIPATION\\
1678 WAVE BLOCKING DISSIPATION\\
1679 NON-LINEAR TRANSFERS BETWEEN FREQUENCIES\\
1680 TRIAD INTERACTION
1681 \end{CommentBlock}""",
1682     ),
1683 #   -----------------------------------
1684     TAKING_INTO_ACCOUNT_SOURCE_TERMS_ON_IMPOSED_BOUNDARIES = SIMP(statut ='f',
1685 #   -----------------------------------
1686         typ = bool,
1687         defaut = [True ],
1688         fr = """Indique si on prend en compte les termes sources sur les
1689 frontieres imposees.""",
1690         ang = """Indicates whether source terms are taken into account on
1691 imposed boundaries.""",
1692     ),
1693 #   -----------------------------------
1694     WIND = FACT(statut='o',
1695 #   -----------------------------------
1696 #       -----------------------------------
1697         WIND_GENERATION = SIMP(statut ='o',
1698 #       -----------------------------------
1699             typ = 'TXM',
1700             into = ["No wind generation","Wind generation in accordance with WAM cycle 4","Wind generation in accordance with WAM cycle 3","Wind generation in accordance with Yan expression (1987)"],
1701             defaut = ["No wind generation"],
1702             fr = """Choix du type de modelisation du terme source d apport
1703 par le vent. Si sa valeur est 0, on ne prend pas en compte les
1704 apports dus au vent, si sa valeur est 1, ils sont integres selon
1705 la formule utilisee dans WAM cycle 4;
1706 si sa valeur est 2, ils sont integres selon la formule utilisee
1707 dans WAM cycle 3; si sa valeur est 3, ils sont integres selon
1708 l expression de Yan (1987).
1709 **Mots-cles associes :**
1710 PRISE EN COMPTE DU VENT
1711 FICHIER DES VENTS
1712 DENSITE DE L''AIR
1713 DENSITE DE L''EAU
1714 COEFFICIENT DE GENERATION PAR LE VENT
1715 CONSTANTE DE VON KARMAN
1716 CONSTANTE DE CHARNOCK
1717 DECALAGE COURBE DE CROISSANCE DUE AU VENT
1718 COTE DE MESURE DES VENTS
1719 COEFFICIENT DE TRAINEE DE VENT
1720 COEFFICIENT A DE GENERATION PAR LE VENT
1721 COEFFICIENT B DE GENERATION PAR LE VENT
1722 COEFFICIENT C DE GENERATION PAR LE VENT
1723 COEFFICIENT D DE GENERATION PAR LE VENT
1724 COEFFICIENT TM DE GENERATION PAR LE VENT""",
1725             ang = """Selection of the type of modelling of the wind generation
1726 source term. If its value is 0, the wind generation is ignored; if
1727 its value is 1, it is integrated in accordance with the WAM cycle 4
1728 formula; if its value is 2, it is integrated in accordance with the
1729 WAM cycle 3 formula; if its value is 3, it is integrated in accordance
1730 with the Yan (1987) expression.
1731 \\
1732  \begin{CommentBlock}{Related keywords}
1733 CONSIDERATION OF A WIND\\
1734 WINDS FILE\\
1735 AIR DENSITY\\
1736 WATER DENSITY\\
1737 WIND GENERATION COEFFICIENT\\
1738 VON KARMAN CONSTANT\\
1739 CHARNOCK CONSTANT\\
1740 SHIFT GROWING CURVE DUE TO WIND\\
1741 WIND MEASUREMENTS LEVEL\\
1742 WIND DRAG COEFFICIENT\\
1743 WIND GENERATION COEFFICIENT A\\
1744 WIND GENERATION COEFFICIENT B\\
1745 WIND GENERATION COEFFICIENT C\\
1746 WIND GENERATION COEFFICIENT D\\
1747 WIND GENERATION COEFFICIENT TM\\
1748 \end{CommentBlock}""",
1749         ),
1750 #       -----------------------------------
1751         b_WIND_GENERATIONG = BLOC(condition="WIND_GENERATION == 'Wind generation in accordance with WAM cycle 4'",
1752 #       -----------------------------------
1753 #           -----------------------------------
1754             WIND_GENERATION_COEFFICIENT = SIMP(statut ='o',
1755 #           -----------------------------------
1756                 typ = 'R',
1757                 defaut = 1.2,
1758                 fr = """Fait partie de l ensemble des constantes utilisees dans
1759 le terme source de generation par le vent.
1760 **Mots-cles associes :**
1761 APPORTS DUS AU VENT""",
1762                 ang = """Constant used in the wind source term.
1763 \\
1764  \begin{CommentBlock}{Related keywords}
1765 WIND GENERATION
1766 \end{CommentBlock}""",
1767             ),
1768 #           -----------------------------------
1769             AIR_DENSITY = SIMP(statut ='o',
1770 #           -----------------------------------
1771                 typ = 'R',
1772                 defaut = 1.225,
1773                 fr = """Le rapport Roair/Roeau est utilise dans le terme source
1774 de generation par le vent.
1775 **Mots-cles associes :**
1776 APPORTS DUS AU VENT
1777 DENSITE DE L''EAU""",
1778                 ang = """The ratio ROAIR/ROEAU is used in the wind generation
1779 source term.
1780 \\
1781  \begin{CommentBlock}{Related keywords}
1782 WIND GENERATION\\
1783 WATER DENSITY
1784 \end{CommentBlock}""",
1785             ),
1786 #           -----------------------------------
1787             WATER_DENSITY = SIMP(statut ='o',
1788 #           -----------------------------------
1789                 typ = 'R',
1790                 defaut = 1000.,
1791                 fr = """ Le rapport Roair/Roeau est utilise dans le terme source
1792 de generation par le vent.
1793 **Mots-cles associes :**
1794 APPORTS DUS AU VENT
1795 DENSITE DE L''AIR""",
1796                 ang = """The ratio ROAIR/ROEAU is used in the wind generation
1797 source term.
1798 \\
1799  \begin{CommentBlock}{Related keywords}
1800 WIND GENERATION\\
1801 AIR DENSITY
1802 \end{CommentBlock}""",
1803             ),
1804 #           -----------------------------------
1805             CHARNOCK_CONSTANT = SIMP(statut ='f',
1806 #           -----------------------------------
1807                 typ = 'R',
1808                 defaut = 0.01,
1809                 fr = """Fait partie de l ensemble des constantes utilisees dans
1810 le terme source de generation par le vent.
1811 **Mots-cles associes :**
1812 APPORTS DUS AU VENT""",
1813                 ang = """Constant used in the wind source term.
1814 \\
1815  \begin{CommentBlock}{Related keywords}
1816 WIND GENERATION
1817 \end{CommentBlock}""",
1818             ),
1819 #           -----------------------------------
1820             WIND_DRAG_COEFFICIENT = SIMP(statut ='o',
1821 #           -----------------------------------
1822                 typ = 'R',
1823                 defaut = 1.2875E-3,
1824                 fr = """Fait partie de l ensemble des constantes utilisees dans
1825 le terme source de generation par le vent.
1826 **Mots-cles associes :**
1827 APPORTS DUS AU VENT""",
1828                 ang = """Constant used in the wind source term.
1829 \\
1830  \begin{CommentBlock}{Related keywords}
1831 WIND GENERATION
1832 \end{CommentBlock}""",
1833             ),
1834 #           -----------------------------------
1835             VON_KARMAN_CONSTANT = SIMP(statut ='o',
1836 #           -----------------------------------
1837                 typ = 'R',
1838                 defaut = 0.41,
1839                 fr = """Fait partie de l ensemble des constantes utilisees dans
1840 le terme source de generation par le vent.
1841 **Mots-cles associes :**
1842 APPORTS DUS AU VENT""",
1843                 ang = """Constant used in the wind source term.
1844 \\
1845  \begin{CommentBlock}{Related keywords}
1846 WIND GENERATION
1847 \end{CommentBlock}""",
1848             ),
1849 #           -----------------------------------
1850             SHIFT_GROWING_CURVE_DUE_TO_WIND = SIMP(statut ='o',
1851 #           -----------------------------------
1852                 typ = 'R',
1853                 defaut = 0.011,
1854                 fr = """Fait partie de l ensemble des constantes utilisees dans
1855 le terme source de generation par le vent.
1856 **Mots-cles associes :**
1857 APPORTS DUS AU VENT""",
1858                 ang = """Constant used in the wind source term.
1859 \\
1860  \begin{CommentBlock}{Related keywords}
1861 WIND GENERATION
1862 \end{CommentBlock}""",
1863             ),
1864 #           -----------------------------------
1865             WIND_MEASUREMENTS_LEVEL = SIMP(statut ='f',
1866 #           -----------------------------------
1867                 typ = 'R',
1868                 defaut = 10.,
1869                 fr = """Fait partie de l ensemble des constantes utilisees dans
1870 le terme source de generation par le vent.
1871 **Mots-cles associes :**
1872 APPORTS DUS AU VENT""",
1873                 ang = """Constant used in the wind source term.
1874 \\
1875  \begin{CommentBlock}{Related keywords}
1876 WIND GENERATION
1877 \end{CommentBlock}""",
1878             ),
1879         ),
1880 #       -----------------------------------
1881         b_WIND_GENERATIONH = BLOC(condition="WIND_GENERATION == 'Wind generation in accordance with WAM cycle 3'",
1882 #       -----------------------------------
1883         ),
1884 #       -----------------------------------
1885         b_WIND_GENERATIONI = BLOC(condition="WIND_GENERATION == 'Wind generation in accordance with Yan expression (1987)'",
1886 #       -----------------------------------
1887 #           -----------------------------------
1888             YAN_GENERATION_COEFFICIENT_D = SIMP(statut ='o',
1889 #           -----------------------------------
1890                 typ = 'R',
1891                 defaut = 0.04,
1892                 fr = """Fait partie de l ensemble des constantes utilisees dans
1893 le terme source de generation par le vent de Yan (1987).
1894 **Mots-cles associes :**
1895 APPORTS DUS AU VENT
1896 COEFFICIENT DE GENERATION DE YAN E
1897 COEFFICIENT DE GENERATION DE YAN F
1898 COEFFICIENT DE GENERATION DE YAN H""",
1899                 ang = """Constant used in the wind source term of Yan (1987).
1900 \\
1901  \begin{CommentBlock}{Related keywords}
1902 WIND GENERATION\\
1903 YAN GENERATION COEFFICIENT E\\
1904 YAN GENERATION COEFFICIENT F\\
1905 YAN GENERATION COEFFICIENT H
1906 \end{CommentBlock}""",
1907             ),
1908 #           -----------------------------------
1909             YAN_GENERATION_COEFFICIENT_E = SIMP(statut ='o',
1910 #           -----------------------------------
1911                 typ = 'R',
1912                 defaut = 0.00552,
1913                 fr = """Fait partie de l ensemble des constantes utilisees dans
1914 le terme source de generation par le vent de Yan (1987).
1915 **Mots-cles associes :**
1916 APPORTS DUS AU VENT
1917 COEFFICIENT DE GENERATION DE YAN D
1918 COEFFICIENT DE GENERATION DE YAN F
1919 COEFFICIENT DE GENERATION DE YAN H""",
1920                 ang = """Constant used in the wind source term of Yan (1987).
1921 \\
1922  \begin{CommentBlock}{Related keywords}
1923 WIND GENERATION\\
1924 YAN GENERATION COEFFICIENT D\\
1925 YAN GENERATION COEFFICIENT F\\
1926 YAN GENERATION COEFFICIENT H
1927 \end{CommentBlock}""",
1928             ),
1929 #           -----------------------------------
1930             YAN_GENERATION_COEFFICIENT_F = SIMP(statut ='o',
1931 #           -----------------------------------
1932                 typ = 'R',
1933                 defaut = 0.000052,
1934                 fr = """Fait partie de l ensemble des constantes utilisees dans
1935 le terme source de generation par le vent de Yan (1987).
1936 **Mots-cles associes :**
1937 APPORTS DUS AU VENT
1938 COEFFICIENT DE GENERATION DE YAN D
1939 COEFFICIENT DE GENERATION DE YAN E
1940 COEFFICIENT DE GENERATION DE YAN H""",
1941                 ang = """Constant used in the wind source term of Yan (1987).
1942 \\
1943  \begin{CommentBlock}{Related keywords}
1944 WIND GENERATION\\
1945 YAN GENERATION COEFFICIENT D\\
1946 YAN GENERATION COEFFICIENT E\\
1947 YAN GENERATION COEFFICIENT H
1948 \end{CommentBlock}""",
1949             ),
1950 #           -----------------------------------
1951             YAN_GENERATION_COEFFICIENT_H = SIMP(statut ='o',
1952 #           -----------------------------------
1953                 typ = 'R',
1954                 defaut = -0.000302,
1955                 fr = """Fait partie de l ensemble des constantes utilisees dans
1956 le terme source de generation par le vent de Yan (1987).
1957 **Mots-cles associes :**
1958 APPORTS DUS AU VENT
1959 COEFFICIENT DE GENERATION DE YAN D
1960 COEFFICIENT DE GENERATION DE YAN E
1961 COEFFICIENT DE GENERATION DE YAN F""",
1962                 ang = """Constant used in the wind source term of Yan (1987).
1963 \\
1964  \begin{CommentBlock}{Related keywords}
1965 WIND GENERATION\\
1966 YAN GENERATION COEFFICIENT D\\
1967 YAN GENERATION COEFFICIENT E\\
1968 YAN GENERATION COEFFICIENT F
1969 \end{CommentBlock}""",
1970             ),
1971         ),
1972 #       -----------------------------------
1973         LINEAR_WAVE_GROWTH = SIMP(statut ='o',
1974 #       -----------------------------------
1975             typ = 'TXM',
1976             into = ["the linear wave growth is ignored","linear wave growth as in Cavaleri and Malanotte-Rizzoli (1981)"],
1977             defaut = ["the linear wave growth is ignored"],
1978             fr = """Possibilite d ajouter au terme source d apport
1979 par le vent un terme de croissance lineaire.
1980 Si sa valeur est 0, on ne prend pas en compte le
1981 terme de croissance lineaire, si sa valeur est 1,
1982 il est ajoute au terme source, selon la formule
1983 de Cavaleri et Malanotte-Rizzoli (1981)
1984 **Mots-cles associes :**
1985 PRISE EN COMPTE DU VENT
1986 FICHIER DES VENTS""",
1987             ang = """Possibility to add a linear wave growth term
1988 to the wind generation source term.
1989 If its value is 0, the linear wave growth is ignored;
1990 if its value is 1, it is added to the source term,
1991 as in the formula of Cavaleri and Malanotte-Rizzoli (1981).
1992 \\
1993  \begin{CommentBlock}{Related keywords}
1994 CONSIDERATION OF A WIND\\
1995 WINDS FILE
1996 \end{CommentBlock}""",
1997         ),
1998     ),
1999 #   -----------------------------------
2000     WHITE_CAPPING = FACT(statut='o',
2001 #   -----------------------------------
2002 #       -----------------------------------
2003         WHITE_CAPPING_DISSIPATION = SIMP(statut ='o',
2004 #       -----------------------------------
2005             typ = 'TXM',
2006             into = ["No white capping dissipation","Dissipation in accordance with WAM cycle 4","Dissipation in accordance with Van des Westhuysen(2007)"],
2007             defaut = ["No white capping dissipation"],
2008             fr = """Choix du type de modelisation du terme source de dissipation
2009 par moutonnement. Si sa valeur est 0, on ne prend pas en compte la
2010 dissipation par moutonnement, si sa valeur est 1, elle est integree
2011 selon la formule utilisee dans WAM cycle 4; si sa valeur est 2, elle
2012 est integree selon la formule de van der Westhuysen (2007).
2013 **Mots-cles associes :**
2014 COEFFICIENT DE DISSIPATION PAR MOUTONNEMENT
2015 COEFFICIENT DE PONDERATION POUR LE MOUTONNEMENT
2016 COEFFICIENT DE DISSIPATION DE WESTHUYSEN
2017 DISSIPATION PAR MOUTONNEMENT
2018 SEUIL DE SATURATION POUR LA DISSIPATION
2019 DISSIPATION PAR MOUTONNEMENT DE WESTHUYSEN
2020 COEFFICIENT DE PONDERATION DE WESTHUYSEN""",
2021             ang = """Selection of the modelling type of the white capping source
2022 term. If its value is 0, the white capping dissipation is ignored;
2023 if its value is 1, it is integrated in accordance with a formula that
2024 is similar to that of WAM cycle 4; if its value is 2, it is integrated
2025 in accordance with the formula of van der Westhuysen (2007).
2026 \\
2027  \begin{CommentBlock}{Related keywords}
2028 WHITE CAPPING DISSIPATION COEFFICIENT\\
2029 WHITE CAPPING WEIGHTING COEFFICIENT\\
2030 WESTHUYSEN DISSIPATION COEFFICIENT\\
2031 SATURATION THRESHOLD FOR THE DISSIPATION\\
2032 WESTHUYSEN WHITE CAPPING DISSIPATION\\
2033 WESTHUYSEN WEIGHTING COEFFICIENT
2034 \end{CommentBlock}""",
2035         ),
2036 #       -----------------------------------
2037         b_WHITE_CAPPING_DISSIPATIONG = BLOC(condition="WHITE_CAPPING_DISSIPATION == 'Dissipation in accordance with WAM cycle 4'",
2038 #       -----------------------------------
2039 #           -----------------------------------
2040             WHITE_CAPPING_DISSIPATION_COEFFICIENT = SIMP(statut ='o',
2041 #           -----------------------------------
2042                 typ = 'R',
2043                 defaut = 4.5,
2044                 fr = """Coefficient de dissipation par moutonnement.
2045 **Mots-cles associes :**
2046 DISSIPATION PAR MOUTONNEMENT
2047 COEFFICIENT DE PONDERATION POUR LE MOUTONNEMENT""",
2048                 ang = """White capping dissipation coefficient .
2049 \\
2050  \begin{CommentBlock}{Related keywords}
2051 WHITE CAPPING DISSIPATION\\
2052 WHITE CAPPING WEIGHTING COEFFICIENT
2053 \end{CommentBlock}""",
2054             ),
2055 #           -----------------------------------
2056             WHITE_CAPPING_WEIGHTING_COEFFICIENT = SIMP(statut ='o',
2057 #           -----------------------------------
2058                 typ = 'R',
2059                 defaut = 0.5,
2060                 fr = """ Coefficient de ponderation pour le moutonnement.
2061 **Mots-cles associes :**
2062 DISSIPATION PAR MOUTONNEMENT
2063 COEFFICIENT DE DISSIPATION PAR MOUTONNEMENT""",
2064                 ang = """White capping weighting coefficient.
2065 \\
2066  \begin{CommentBlock}{Related keywords}
2067 WHITE CAPPING DISSIPATION\\
2068 WHITE CAPPING DISSIPATION COEFFICIENT
2069 \end{CommentBlock}""",
2070             ),
2071         ),
2072 #       -----------------------------------
2073         b_WHITE_CAPPING_DISSIPATIONH = BLOC(condition="WHITE_CAPPING_DISSIPATION == 'Dissipation in accordance with Van des Westhuysen(2007)'",
2074 #       -----------------------------------
2075 #           -----------------------------------
2076             SATURATION_THRESHOLD_FOR_THE_DISSIPATION = SIMP(statut ='o',
2077 #           -----------------------------------
2078                 typ = 'R',
2079                 defaut = 0.00175,
2080                 fr = """Coefficient de dissipation par moutonnement de l expression
2081 de van der Westhuysen (2007): Br (seuil de saturation).
2082 **Mots-cles associes :**
2083 DISSIPATION PAR MOUTONNEMENT
2084 COEFFICIENT DE DISSIPATION DE WESTHUYSEN
2085 DISSIPATION PAR MOUTONNEMENT DE WESTHUYSEN
2086 COEFFICIENT DE PONDERATION DE WESTHUYSEN""",
2087                 ang = """White capping dissipation coefficient of
2088 van der Westhuysen (2007): Br (saturation threshold).
2089 \\
2090  \begin{CommentBlock}{Related keywords}
2091 WHITE CAPPING DISSIPATION\\
2092 WESTHUYSEN DISSIPATION COEFFICIENT\\
2093 WESTHUYSEN WHITE CAPPING DISSIPATION\\
2094 WESTHUYSEN WEIGHTING COEFFICIENT
2095 \end{CommentBlock}""",
2096             ),
2097 #           -----------------------------------
2098             WESTHUYSEN_WHITE_CAPPING_DISSIPATION = SIMP(statut ='o',
2099 #           -----------------------------------
2100                 typ = 'R',
2101                 defaut = 3.29,
2102                 fr = """Coefficient de dissipation par moutonnement de l expression
2103 de van der Westhuysen (2007): Cdis,non-break.
2104 **Mots-cles associes :**
2105 DISSIPATION PAR MOUTONNEMENT
2106 COEFFICIENT DE DISSIPATION DE WESTHUYSEN
2107 SEUIL DE SATURATION POUR LA DISSIPATION
2108 COEFFICIENT DE PONDERATION DE WESTHUYSEN""",
2109                 ang = """White capping dissipation coefficient of
2110 van der Westhuysen (2007): Cdis,non-break.
2111 \\
2112  \begin{CommentBlock}{Related keywords}
2113 WHITE CAPPING DISSIPATION\\
2114 WESTHUYSEN DISSIPATION COEFFICIENT\\
2115 SATURATION THRESHOLD FOR THE DISSIPATION\\
2116 WESTHUYSEN WEIGHTING COEFFICIENT
2117 \end{CommentBlock}""",
2118             ),
2119 #           -----------------------------------
2120             WESTHUYSEN_WEIGHTING_COEFFICIENT = SIMP(statut ='o',
2121 #           -----------------------------------
2122                 typ = 'R',
2123                 defaut = 0.0,
2124                 fr = """Coefficient de dissipation par moutonnement de l expression
2125 de van der Westhuysen (2007): delta.
2126 **Mots-cles associes :**
2127 DISSIPATION PAR MOUTONNEMENT
2128 COEFFICIENT DE DISSIPATION DE WESTHUYSEN
2129 SEUIL DE SATURATION POUR LA DISSIPATION
2130 DISSIPATION PAR MOUTONNEMENT DE WESTHUYSEN""",
2131                 ang = """White capping dissipation coefficient of
2132 van der Westhuysen (2007): delta.
2133 \\
2134  \begin{CommentBlock}{Related keywords}
2135 WHITE CAPPING DISSIPATION\\
2136 WESTHUYSEN DISSIPATION COEFFICIENT\\
2137 SATURATION THRESHOLD FOR THE DISSIPATION\\
2138 WESTHUYSEN WHITE CAPPING DISSIPATION
2139 \end{CommentBlock}""",
2140             ),
2141 #           -----------------------------------
2142             WESTHUYSEN_DISSIPATION_COEFFICIENT = SIMP(statut ='o',
2143 #           -----------------------------------
2144                 typ = 'R',
2145                 defaut = 0.00005,
2146                 fr = """Coefficient de dissipation par moutonnement de l expression
2147 de van der Westhuysen (2007): Cdis,break.
2148 **Mots-cles associes :**
2149 DISSIPATION PAR MOUTONNEMENT
2150 SEUIL DE SATURATION POUR LA DISSIPATION
2151 DISSIPATION PAR MOUTONNEMENT DE WESTHUYSEN
2152 COEFFICIENT DE PONDERATION DE WESTHUYSEN""",
2153                 ang = """White capping dissipation coefficient of
2154 van der Westhuysen (2007): Cdis,break.
2155 \\
2156  \begin{CommentBlock}{Related keywords}
2157 WHITE CAPPING DISSIPATION\\
2158 SATURATION THRESHOLD FOR THE DISSIPATION\\
2159 WESTHUYSEN WHITE CAPPING DISSIPATION\\
2160 WESTHUYSEN WEIGHTING COEFFICIENT
2161 \end{CommentBlock}""",
2162             ),
2163         ),
2164     ),
2165 #   -----------------------------------
2166     BOTTOM_FRICTION = FACT(statut='o',
2167 #   -----------------------------------
2168 #       -----------------------------------
2169         BOTTOM_FRICTION_DISSIPATION = SIMP(statut ='o',
2170 #       -----------------------------------
2171             typ = 'TXM',
2172             into = ["No bottom friction dissipation","Dissipation in accordance with WAM cycle 4"],
2173             defaut = ["No bottom friction dissipation"],
2174             fr = """Choix du type de modelisation du terme source de dissipation
2175 sur le fond. Si sa valeur est 0, on ne prend pas en compte la
2176 dissipation par frottement, si sa valeur est 1, elle est integree
2177 selon la formule equivalente a celle utilisee dans WAM cycle 4.
2178 **Mots-cles associes :**
2179 PROFONDEUR INFINIE
2180 COEFFICIENT DE FROTTEMENT SUR LE FOND""",
2181             ang = """Selection of the modelling type of the bottom friction source
2182 term. If its value is 0, the bottom friction dissipation is ignored;
2183 if its value is 1, it is integrated in accordance with a formula that
2184 is similar to that of WAM cycle 4.
2185 \\
2186  \begin{CommentBlock}{Related keywords}
2187 INFINITE DEPTH\\
2188 BOTTOM FRICTION COEFFICIENT
2189 \end{CommentBlock}""",
2190         ),
2191 #       -----------------------------------
2192         b_BOTTOM_FRICTION_DISSIPATIONG = BLOC(condition="BOTTOM_FRICTION_DISSIPATION == 'Dissipation in accordance with WAM cycle 4'",
2193 #       -----------------------------------
2194 #           -----------------------------------
2195             BOTTOM_FRICTION_COEFFICIENT = SIMP(statut ='o',
2196 #           -----------------------------------
2197                 typ = 'R',
2198                 defaut = 0.038,
2199                 fr = """Coefficient de frottement sur le fond.
2200 **Mots-cles associes :**
2201 PROFONDEUR INFINIE
2202 DISSIPATION PAR FROTTEMENT SUR LE FOND""",
2203                 ang = """Bottom friction coefficient.
2204 \\
2205  \begin{CommentBlock}{Related keywords}
2206 INFINITE DEPTH\\
2207 BOTTOM FRICTION-INDUCED DISSIPATION
2208 \end{CommentBlock}""",
2209             ),
2210         ),
2211     ),
2212 #   -----------------------------------
2213     QUADRUPLET_INTERACTIONS = FACT(statut='o',
2214 #   -----------------------------------
2215 #       -----------------------------------
2216         NON_LINEAR_TRANSFERS_BETWEEN_FREQUENCIES = SIMP(statut ='o',
2217 #       -----------------------------------
2218             typ = 'TXM',
2219             into = ["No non-linear transfers term","Non-linear transfers term with WAM cycle 4 (DIA Method)","Non-linear transfers term in accordance with MDIA Method","Non-linear transfers term calculated with exact GQM Method"],
2220             defaut = ["No non-linear transfers term"],
2221             fr = """Choix du type de modelisation du terme de transfert non lineaire
2222 inter-frequences. Si sa valeur est 0, on ne prend pas en compte les
2223 transferts non lineaires inter-frequences, si sa valeur est 1, ils sont
2224 integres selon la formule utilisee dans WAM cycle 4 (methode DIA), si sa
2225 valeur est 2, la methode MDIA (Multiple DIA) est utilisee pour calculer
2226 le terme de transfert non lineaire, si sa valeur est 3, le terme de
2227 transfert non lineaire est calcule de maniere exacte avec la methode
2228 GQM.
2229 **Mots-cles associes :**
2230 PARAMETRE DE LA CONFIGURATION STANDARD
2231 REGLAGE POUR INTEGRATION SUR OMEGA1
2232 REGLAGE POUR INTEGRATION SUR THETA1
2233 REGLAGE POUR INTEGRATION SUR OMEGA2
2234 SEUIL0 ELIMINATION DE CONFIGURATIONS
2235 SEUIL1 ELIMINATION DE CONFIGURATIONS
2236 SEUIL2 ELIMINATION DE CONFIGURATIONS""",
2237             ang = """Selection of the modelling type of the non-linear transfert
2238 source term. If its value is 0, the non-linear transfers are ignored;
2239 if its value is 1, they are integrated in accordance with the formula
2240 of WAM cycle 4 (DIA method), if its value is 2, the MDIA
2241 (Multiple DIA) method is used to calculate the non linear transfer
2242 term, if its value is 3, the non linear transfer term is calculated
2243 with the exact GQM method.
2244 \\
2245  \begin{CommentBlock}{Related keywords}
2246 STANDARD CONFIGURATION PARAMETER\\
2247 SETTING FOR INTEGRATION ON OMEGA1\\
2248 SETTING FOR INTEGRATION ON THETA1\\
2249 SETTING FOR INTEGRATION ON OMEGA2\\
2250 THRESHOLD0 FOR CONFIGURATIONS ELIMINATION\\
2251 THRESHOLD1 FOR CONFIGURATIONS ELIMINATION\\
2252 THRESHOLD2 FOR CONFIGURATIONS ELIMINATION
2253 \end{CommentBlock}""",
2254         ),
2255 #       -----------------------------------
2256         b_NON_LINEAR_TRANSFERS_BETWEEN_FREQUENCIESG = BLOC(condition="NON_LINEAR_TRANSFERS_BETWEEN_FREQUENCIES == 'Non-linear transfers term with WAM cycle 4 (DIA Method)'",
2257 #       -----------------------------------
2258 #           -----------------------------------
2259             STANDARD_CONFIGURATION_PARAMETER = SIMP(statut ='o',
2260 #           -----------------------------------
2261                 typ = 'R',
2262                 defaut = 0.25,
2263                 fr = """Parametre definissant la configuration d interaction
2264 standard pour les quadruplets dans la methode DIA.
2265 **Mots-cles associes :**
2266 TRANSFERTS NON LINEAIRES INTER-FREQUENCES""",
2267                 ang = """Parameter defining the standard configuration for
2268 the quadruplet interactions in the DIA method.
2269 \\
2270  \begin{CommentBlock}{Related keywords}
2271 NON-LINEAR TRANSFERS BETWEEN FREQUENCIES
2272 \end{CommentBlock}""",
2273             ),
2274         ),
2275 #       -----------------------------------
2276         b_NON_LINEAR_TRANSFERS_BETWEEN_FREQUENCIESH = BLOC(condition="NON_LINEAR_TRANSFERS_BETWEEN_FREQUENCIES == 'Non-linear transfers term calculated with exact GQM Method'",
2277 #       -----------------------------------
2278 #           -----------------------------------
2279             SETTING_FOR_INTEGRATION_ON_OMEGA1 = SIMP(statut ='o',
2280 #           -----------------------------------
2281                 typ = 'TXM',
2282                 into = ["medium","fine","rough"],
2283                 defaut = ["rough"],
2284                 fr = """ Choix du reglage donnant le nombre de point d integration sur
2285 omega1 lorsque le terme de transfert non lineaire est calcule de
2286 maniere exacte (methode GQM): grossier 3;moyen 1 ; fin 2""",
2287                 ang = """Choice of setting giving the number of integration points on
2288 omega1 when the non linear transfer term is calculated with the exact
2289 GQM method: rough 3 ; medium 1 ; fine 2""",
2290             ),
2291 #           -----------------------------------
2292             SETTING_FOR_INTEGRATION_ON_THETA1 = SIMP(statut ='o',
2293 #           -----------------------------------
2294                 typ = 'TXM',
2295                 into = ["rough","medium","fine"],
2296                 defaut = ["rough"],
2297                 fr = """ Choix du reglage donnant le nombre de point d integration sur
2298 theta1 (nombre de points d integration = 2*NQ\_TE1) lorsque le terme
2299 de transfert non lineaire est calcule de maniere exacte (methode GQM):
2300 grossier 3 ; moyen 4 ; fin 8""",
2301                 ang = """Choice of setting giving the number of integration points on
2302 theta1 (number of integration points= 2*NQ\_TE1) when the non linear
2303 transfer term is calculated with the exact GQM method:
2304 rough 3 ; medium 4 ; fine 8""",
2305             ),
2306 #           -----------------------------------
2307             SETTING_FOR_INTEGRATION_ON_OMEGA2 = SIMP(statut ='o',
2308 #           -----------------------------------
2309                 typ = 'TXM',
2310                 into = ["rough","medium","fine"],
2311                 defaut = ["rough"],
2312                 fr = """ Nombre de point d integration sur omega2 lorsque le terme de
2313 transfert non lineaire est calcule de maniere exacte (methode GQM):
2314 grossier 6 ; moyen 8 ; fin 12""",
2315                 ang = """Number of integration points on omega2 when the non linear
2316 transfer term is calculated with the exact GQM method:
2317 rough 6 ; medium 8 ; fine 12""",
2318             ),
2319 #           -----------------------------------
2320             THRESHOLD0_FOR_CONFIGURATIONS_ELIMINATION = SIMP(statut ='o',
2321 #           -----------------------------------
2322                 typ = 'R',
2323                 defaut = 0.00,
2324                 fr = """ Choix du seuil pour l elimination de configurations lorsque
2325 le terme de transfert non lineaire est calcule de maniere exacte
2326 (methode GQM)
2327 **Mots-cles associes :**
2328 SEUIL1 ELIMINATION DE CONFIGURATIONS
2329 SEUIL2 ELIMINATION DE CONFIGURATIONS
2330 TRANSFERTS NON LINEAIRES INTER-FREQUENCES""",
2331                 ang = """Choice of threshold for configurations elimination when the
2332 non linear transfer term is calculated with the exact GQM method
2333 \\
2334  \begin{CommentBlock}{Related keywords}
2335 THRESHOLD1 FOR CONFIGURATIONS ELIMINATION\\
2336 THRESHOLD2 FOR CONFIGURATIONS ELIMINATION\\
2337 NON-LINEAR TRANSFERS BETWEEN FREQUENCIES
2338 \end{CommentBlock}""",
2339             ),
2340 #           -----------------------------------
2341             THRESHOLD1_FOR_CONFIGURATIONS_ELIMINATION = SIMP(statut ='o',
2342 #           -----------------------------------
2343                 typ = 'R',
2344                 defaut = 10000000000.0,
2345                 fr = """ Choix du seuil1 pour l elimination de configurations lorsque
2346 le terme de transfert non lineaire est calcule de maniere exacte
2347 (methode GQM)
2348 **Mots-cles associes :**
2349 SEUIL0 ELIMINATION DE CONFIGURATIONS
2350 SEUIL2 ELIMINATION DE CONFIGURATIONS
2351 TRANSFERTS NON LINEAIRES INTER-FREQUENCES""",
2352                 ang = """Choice of threshold1 for configurations elimination when the
2353 non linear transfer term is calculated with the exact GQM method
2354 \\
2355  \begin{CommentBlock}{Related keywords}
2356 THRESHOLD0 FOR CONFIGURATIONS ELIMINATION\\
2357 THRESHOLD2 FOR CONFIGURATIONS ELIMINATION\\
2358 NON-LINEAR TRANSFERS BETWEEN FREQUENCIES
2359 \end{CommentBlock}""",
2360             ),
2361 #           -----------------------------------
2362             THRESHOLD2_FOR_CONFIGURATIONS_ELIMINATION = SIMP(statut ='o',
2363 #           -----------------------------------
2364                 typ = 'R',
2365                 defaut = 0.15,
2366                 fr = """ Choix du seuil2 pour l elimination de configurations lorsque
2367 le terme de transfert non lineaire est calcule de maniere exacte
2368 (methode GQM) : grossier 0.15 ; moyen 0.01 ; fin 0.001
2369 **Mots-cles associes :**
2370 SEUIL0 ELIMINATION DE CONFIGURATIONS
2371 SEUIL1 ELIMINATION DE CONFIGURATIONS
2372 TRANSFERTS NON LINEAIRES INTER-FREQUENCES""",
2373                 ang = """Choice of threshold2 for configurations elimination when the
2374 non linear transfer term is calculated with the exact GQM method:
2375 rough 0.15 ; medium 0.01 ; fine 0.001
2376 \\
2377  \begin{CommentBlock}{Related keywords}
2378 THRESHOLD0 FOR CONFIGURATIONS ELIMINATION\\
2379 THRESHOLD1 FOR CONFIGURATIONS ELIMINATION\\
2380 NON-LINEAR TRANSFERS BETWEEN FREQUENCIES
2381 \end{CommentBlock}""",
2382             ),
2383         ),
2384     ),
2385 #   -----------------------------------
2386     NUMERICAL_PARAMETERS = FACT(statut='f',
2387 #   -----------------------------------
2388 #       -----------------------------------
2389         NUMBER_OF_ITERATIONS_FOR_THE_SOURCE_TERMS = SIMP(statut ='f',
2390 #       -----------------------------------
2391             typ = 'I',
2392             defaut = 1,
2393             fr = """Nombre de sous-iterations pour le calcul des
2394 contributions des termes sources. Le pas de temps considere
2395 pour les termes sources est le rapport entre le PAS DE TEMPS
2396 et le NOMBRE DE SOUS-ITERATIONS POUR LES TERMES SOURCES.
2397 **Mots-cles associes :**
2398 PAS DE TEMPS""",
2399             ang = """Number of sub-iterations for the computation of the source terms.
2400 The time step considered in the integration of the source terms
2401 is the ratio between the TIME STEP and the NUMBER OF SUB-ITERATIONS
2402 FOR THE SOURCE TERMS
2403 \\
2404  \begin{CommentBlock}{Related keywords}
2405 TIME STEP
2406 \end{CommentBlock}""",
2407         ),
2408 #       -----------------------------------
2409         IMPLICITATION_COEFFICIENT_FOR_SOURCE_TERMS = SIMP(statut ='f',
2410 #       -----------------------------------
2411             typ = 'R',
2412             defaut = 0.5,
2413             fr = """Coefficient controlant l implicitation dans le schema
2414 d integration des termes sources, compris entre 0 et 1.
2415 CIMPLI=0.  : explicite
2416 CIMPLI=0.5 : semi-implicite
2417 CIMPLI=1.  : implicite.
2418 **Mots-cles associes :**
2419 PRISE EN COMPTE DES TERMES SOURCES""",
2420             ang = """Implicitation coefficient for the source terms integration,
2421 included between 0 et 1.
2422 \begin{itemize}
2423 \item CIMPLI=0.  : explicit
2424 \item CIMPLI=0.5 : semi-implicit
2425 \item CIMPLI=1.  : implicit.
2426 \end{itemize}
2427  \begin{CommentBlock}{Related keywords}
2428 CONSIDERATION OF SOURCE TERMS
2429 \end{CommentBlock}""",
2430         ),
2431     ),
2432 #   -----------------------------------
2433     STRONG_CURRENT = FACT(statut='o',
2434 #   -----------------------------------
2435 #       -----------------------------------
2436         DISSIPATION_BY_STRONG_CURRENT = SIMP(statut ='o',
2437 #       -----------------------------------
2438             typ = 'TXM',
2439             into = ["No wave-blocking","Spectrum limitation by a Phillips shape","Dissipation in accordance with Van der Westhuysen(2012)"],
2440             defaut = ["No wave-blocking"],
2441             fr = """Lorsque les effets de wave-blocking ou vagues stoppees
2442 par un fort courant sont presents, deux options sont proposees.
2443 Si sa valeur est 1, une limitation est imposee au spectre,
2444 en utilisant une forme d equilibre de Phillips (1977).
2445 Si sa valeur est 2, on utilise le terme de dissipation propose
2446 par Van der Westhuysen (2012).
2447 **Mots-cles associes :**
2448 COEFFICIENT DE DISSIPATION PAR FORT COURANT""",
2449             ang = """When wave-blocking effects are present (wave stopped by
2450 a strong opposing current), two options are possible.
2451 If its value is 1, an upper limit is imposed to the spectrum,
2452 using a Phillips (1977) shape.
2453 If its value is 2, a dissipative term is added, following
2454 Van der Westhuysen (2012).
2455 \\
2456  \begin{CommentBlock}{Related keywords}
2457 DISSIPATION COEFFICIENT FOR STRONG CURRENT
2458 \end{CommentBlock}""",
2459         ),
2460 #       -----------------------------------
2461         b_DISSIPATION_BY_STRONG_CURRENTG = BLOC(condition="DISSIPATION_BY_STRONG_CURRENT == 'Dissipation in accordance with Van der Westhuysen(2012)'",
2462 #       -----------------------------------
2463 #           -----------------------------------
2464             DISSIPATION_COEFFICIENT_FOR_STRONG_CURRENT = SIMP(statut ='o',
2465 #           -----------------------------------
2466                 typ = 'R',
2467                 defaut = 0.65,
2468                 fr = """Coefficient de dissipation pour des vagues stoppees
2469 par un courant fort adverse (effets de wave-blocking).
2470 Expression de van der Westhuysen (2012): Cds,cur.
2471 **Mots-cles associes :**
2472 DISSIPATION PAR FORT COURANT""",
2473                 ang = """Dissipation coefficient for waves stopped
2474 by a strong opposing current (wave blocking effects).
2475 Van der Westhuysen (2012) expression: Cds,cur.
2476 \\
2477  \begin{CommentBlock}{Related keywords}
2478 DISSIPATION BY STRONG CURRENT
2479 \end{CommentBlock}""",
2480             ),
2481         ),
2482     ),
2483 #   -----------------------------------
2484     BREAKING = FACT(statut='o',
2485 #   -----------------------------------
2486 #       -----------------------------------
2487         DEPTH_INDUCED_BREAKING_DISSIPATION = SIMP(statut ='o',
2488 #       -----------------------------------
2489             typ = 'TXM',
2490             into = ["No breaking","Dissipation in accordance with Battjes et Janssen (1978)","Dissipation in accordance with Thornton et Guza (1983)","Dissipation in accordance with Roelvink (1993)","Dissipation in accordance with Izumiya et Horikawa (1984)"],
2491             defaut = ["No breaking"],
2492             fr = """Choix du type de modelisation du terme source de dissipation
2493 par deferlement du a la bathymetrie :
2494  0 : Pas de prise en compte du deferlement.
2495  1 : Modele de Battjes et Janssen (1978).
2496  2 : Modele de Thornton et Guza  (1983).
2497  3 : Modele de Roelvink (1993).
2498  4 : Modele de Izumiya et Horikawa (1984).
2499 **Mots-cles associes :**
2500 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2501 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB
2502 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM
2503 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE
2504 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA
2505 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1
2506 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2
2507 DEFERLEMENT 2 (TG) FONCTION DE PONDERATION
2508 DEFERLEMENT 2 (TG) CHOIX FREQUENCE CARACTERISTIQUE
2509 DEFERLEMENT 2 (TG) CONSTANTE B
2510 DEFERLEMENT 2 (TG) CONSTANTE GAMMA
2511 DEFERLEMENT 3 (RO) DISTRIBUTION DES HAUTEURS DE HOULE
2512 DEFERLEMENT 3 (RO) EXPOSANT FONCTION DE PONDERATION
2513 DEFERLEMENT 3 (RO) CHOIX FREQUENCE CARACTERISTIQUE
2514 DEFERLEMENT 3 (RO) CONSTANTE ALPHA
2515 DEFERLEMENT 3 (RO) CONSTANTE GAMMA
2516 DEFERLEMENT 3 (RO) CONSTANTE GAMMA2
2517 DEFERLEMENT 4 (IH) CHOIX FREQUENCE CARACTERISTIQUE
2518 DEFERLEMENT 4 (IH) CONSTANTE BETA0
2519 DEFERLEMENT 4 (IH) CONSTANTE M2STAR""",
2520             ang = """Selection of the modelling type of the bathymetric-induced
2521 breaking dissipation source term :
2522 \begin{itemize}
2523 \item 0 : Breaking is ignored.
2524 \item 1 : Battjes and Janssen model (1978).
2525 \item 2 : Thornton and Guza model (1983).
2526 \item 3 : Roelvink model (1993).
2527 \item 4 : Izumiya and Horikawa model (1984).
2528 \end{itemize}
2529  \begin{CommentBlock}{Related keywords}
2530 NUMBER OF BREAKING TIME STEPS\\
2531 DEPTH-INDUCED BREAKING 1 (BJ) QB COMPUTATION METHOD\\
2532 DEPTH-INDUCED BREAKING 1 (BJ) HM COMPUTATION METHOD\\
2533 DEPTH-INDUCED BREAKING 1 (BJ) CHARACTERISTIC FREQUENCY\\
2534 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT ALPHA\\
2535 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA1\\
2536 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA2\\
2537 DEPTH-INDUCED BREAKING 2 (TG) WEIGHTING FUNCTION\\
2538 DEPTH-INDUCED BREAKING 2 (TG) CHARACTERISTIC FREQUENCY\\
2539 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT B\\
2540 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT GAMMA\\
2541 DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION\\
2542 DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION\\
2543 DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY\\
2544 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA\\
2545 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA\\
2546 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2\\
2547 DEPTH-INDUCED BREAKING 4 (IH) CHARACTERISTIC FREQUENCY\\
2548 DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT BETA0\\
2549 DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT M2STAR
2550 \end{CommentBlock}""",
2551         ),
2552 #       -----------------------------------
2553         b_DEPTH_INDUCED_BREAKING_DISSIPATIONG = BLOC(condition="DEPTH_INDUCED_BREAKING_DISSIPATION == 'Dissipation in accordance with Battjes et Janssen (1978)'",
2554 #       -----------------------------------
2555 #           -----------------------------------
2556             DEPTH_INDUCED_BREAKING_1__BJ__QB_COMPUTATION_METHOD = SIMP(statut ='o',
2557 #           -----------------------------------
2558                 typ = 'TXM',
2559                 into = ["SOLVES BY DICHOTOMY","EXPLICIT INSPIRED FROM CREDIZ VERSION 1","EXPLICIT INSPIRED FROM CREDIZ VERSION 2","EXPLICIT INSPIRED FROM CREDIZ VERSION 3"],
2560                 defaut = ["EXPLICIT INSPIRED FROM CREDIZ VERSION 2"],
2561                 fr = """Choix du mode de resolution de l equation implicite donnant Qb.
2562 **Mots-cles associes :**
2563 DISSIPATION PAR DEFERLEMENT
2564 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM
2565 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE
2566 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA
2567 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1
2568 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2""",
2569                 ang = """Selection of the method for the resolution of the implicit
2570 equation for QB.
2571 \\
2572  \begin{CommentBlock}{Related keywords}
2573 DEPTH-INDUCED BREAKING DISSIPATION\\
2574 DEPTH-INDUCED BREAKING 1 (BJ) HM COMPUTATION METHOD\\
2575 DEPTH-INDUCED BREAKING 1 (BJ) CHARACTERISTIC FREQUENCY\\
2576 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT ALPHA\\
2577 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA1\\
2578 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA2
2579 \end{CommentBlock}""",
2580             ),
2581 #           -----------------------------------
2582             DEPTH_INDUCED_BREAKING_1__BJ__HM_COMPUTATION_METHOD = SIMP(statut ='o',
2583 #           -----------------------------------
2584                 typ = 'TXM',
2585                 into = ["Hm = GAMMA*D","Hm given by the Miche criterium"],
2586                 defaut = ["Hm = GAMMA*D"],
2587                 fr = """Choix du critere de deferlement donnant la hauteur de houle
2588 de deferlement (1 : Hm = GAMMA*D ; 2 : Hm par critere de Miche).
2589 **Mots-cles associes :**
2590 DISSIPATION PAR DEFERLEMENT
2591 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE
2592 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1
2593 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2""",
2594                 ang = """Selection of the depth-induced breaking criterium
2595 giving the breaking wave height (1 : Hm = GAMMA*D ; 2 : Hm given
2596 the Miche criterium).
2597 \\
2598  \begin{CommentBlock}{Related keywords}
2599 DEPTH-INDUCED BREAKING DISSIPATION\\
2600 DEPTH-INDUCED BREAKING 1 (BJ) CHARACTERISTIC FREQUENCY\\
2601 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA1\\
2602 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA2\\
2603 \end{CommentBlock}""",
2604             ),
2605 #           -----------------------------------
2606             DEPTH_INDUCED_BREAKING_1__BJ__CHARACTERISTIC_FREQUENCY = SIMP(statut ='o',
2607 #           -----------------------------------
2608                 typ = 'TXM',
2609                 into = ["Frequency Fmoy","Frequency F01","Frequency F02","Frequency Fpic","Frequency Fread ordre 5","Frequency Fread ordre 8"],
2610                 defaut = ["Frequency F01"],
2611                 fr = """Choix de la frequence caracteristique du spectre de houle
2612 1 : Frequence Fmoy
2613 2 : Frequence F01 (definie par les moments d ordre 0 et 1 du spectre)
2614 3 : Frequence F02 (definie par les moments d ordre 0 et 2 du spectre)
2615 4 : Frequence Fpic (frequence d echantillonage correspondant au max)
2616 5 : Frequence Fread ordre 5 (frequence de pic methode Read ordre 5)
2617 6 : Frequence Fread ordre 8 (frequence de pic methode Read ordre 8)
2618 **Mots-cles associes :**
2619 DISSIPATION PAR DEFERLEMENT
2620 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB
2621 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM
2622 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA
2623 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1
2624 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2""",
2625                 ang = """Selection of the characteristic frequency of the wave spectrum
2626 \begin{itemize}
2627 \item 1 : Frequency Fmoy
2628 \item 2 : Frequency F01 (defined by the moments of order 0 and 1 of the
2629 spectrum)
2630 \item 3 : Frequency F02 (defined by the moments of order 0 and 2 of the
2631 spectrum)
2632 \item 4 : Frequency Fpic (sampling frequency corresponding to the max)
2633 \item 5 : Frequency Fread ordre 5 (peak frequency, 5th order Read
2634 method)
2635 \item 6 : Frequency Fread ordre 8 (peak frequency, 8th order Read
2636 method)
2637 \end{itemize}
2638  \begin{CommentBlock}{Related keywords}
2639 DEPTH-INDUCED BREAKING DISSIPATION\\
2640 DEPTH-INDUCED BREAKING 1 (BJ) QB COMPUTATION METHOD\\
2641 DEPTH-INDUCED BREAKING 1 (BJ) HM COMPUTATION METHOD\\
2642 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT ALPHA\\
2643 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA1\\
2644 DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA2
2645 \end{CommentBlock}""",
2646             ),
2647 #           -----------------------------------
2648             DEPTH_INDUCED_BREAKING_1__BJ__COEFFICIENT_ALPHA = SIMP(statut ='o',
2649 #           -----------------------------------
2650                 typ = 'R',
2651                 defaut = 1.,
2652                 fr = """Constante ALPHA du modele de deferlement de Battjes et Janssen.
2653 **Mots-cles associes :**
2654 DISSIPATION PAR DEFERLEMENT
2655 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2656 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB
2657 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM
2658 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE
2659 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1
2660 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2""",
2661                 ang = """ALPHA constant for the Battjes and Janssen model.
2662 \\
2663  \begin{CommentBlock}{Related keywords}
2664 DEPTH-INDUCED BREAKING DISSIPATION\\
2665 NUMBER OF BREAKING TIME STEPS\\
2666 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB\\
2667 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM\\
2668 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE\\
2669 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1\\
2670 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2
2671 \end{CommentBlock}""",
2672             ),
2673 #           -----------------------------------
2674             DEPTH_INDUCED_BREAKING_1__BJ__COEFFICIENT_GAMMA1 = SIMP(statut ='o',
2675 #           -----------------------------------
2676                 typ = 'R',
2677                 defaut = 0.88,
2678                 fr = """Constante GAMMA1 du modele de deferlement de Battjes et Janssen.
2679 **Mots-cles associes :**
2680 DISSIPATION PAR DEFERLEMENT
2681 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2682 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB
2683 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM
2684 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE
2685 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA
2686 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2""",
2687                 ang = """GAMMA1 constant of the Battjes and Janssen model.
2688 \\
2689  \begin{CommentBlock}{Related keywords}
2690 DEPTH-INDUCED BREAKING DISSIPATION\\
2691 NUMBER OF BREAKING TIME STEPS\\
2692 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB\\
2693 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM\\
2694 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE\\
2695 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA\\
2696 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA2
2697 \end{CommentBlock}""",
2698             ),
2699 #           -----------------------------------
2700             DEPTH_INDUCED_BREAKING_1__BJ__COEFFICIENT_GAMMA2 = SIMP(statut ='o',
2701 #           -----------------------------------
2702                 typ = 'R',
2703                 defaut = 0.8,
2704                 fr = """Constante GAMMA2 du modele de deferlement de Battjes et Janssen.
2705 **Mots-cles associes :**
2706 DISSIPATION PAR DEFERLEMENT
2707 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2708 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB
2709 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM
2710 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE
2711 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA
2712 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1""",
2713                 ang = """GAMMA1 constant of the Battjes and Janssen model.
2714 \\
2715  \begin{CommentBlock}{Related keywords}
2716 DEPTH-INDUCED BREAKING DISSIPATION\\
2717 NUMBER OF BREAKING TIME STEPS\\
2718 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE QB\\
2719 DEFERLEMENT 1 (BJ) MODE DE CALCUL DE HM\\
2720 DEFERLEMENT 1 (BJ) CHOIX FREQUENCE CARACTERISTIQUE\\
2721 DEFERLEMENT 1 (BJ) CONSTANTE ALPHA\\
2722 DEFERLEMENT 1 (BJ) CONSTANTE GAMMA1
2723 \end{CommentBlock}""",
2724             ),
2725         ),
2726 #       -----------------------------------
2727         b_DEPTH_INDUCED_BREAKING_DISSIPATIONH = BLOC(condition="DEPTH_INDUCED_BREAKING_DISSIPATION == 'Dissipation in accordance with Thornton et Guza (1983)'",
2728 #       -----------------------------------
2729 #           -----------------------------------
2730             DEPTH_INDUCED_BREAKING_2__TG__WEIGHTING_FUNCTION = SIMP(statut ='o',
2731 #           -----------------------------------
2732                 typ = 'TXM',
2733                 into = ["Weight function 1","Weight function 2"],
2734                 defaut = ["Weight function 2"],
2735                 fr = """Choix de l expression de la fonction de ponderation basee
2736 sur une distribution de probabilite des hauteurs de houle.
2737 **Mots-cles associes :**
2738 DISSIPATION PAR DEFERLEMENT
2739 DEFERLEMENT 2 (TG) CHOIX FREQUENCE CARACTERISTIQUE
2740 DEFERLEMENT 2 (TG) CONSTANTE B
2741 DEFERLEMENT 2 (TG) CONSTANTE GAMMA""",
2742                 ang = """Selection of the expression for the weighting function
2743 based on a probability distribution of the wave heights.
2744 \\
2745  \begin{CommentBlock}{Related keywords}
2746 DEPTH-INDUCED BREAKING DISSIPATION\\
2747 DEPTH-INDUCED BREAKING 2 (TG) CHARACTERISTIC FREQUENCY\\
2748 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT B\\
2749 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT GAMMA
2750 \end{CommentBlock}""",
2751             ),
2752 #           -----------------------------------
2753             DEPTH_INDUCED_BREAKING_2__TG__CHARACTERISTIC_FREQUENCY = SIMP(statut ='o',
2754 #           -----------------------------------
2755                 typ = 'TXM',
2756                 into = ["Frequency Fmoy","Frequency F01","Frequency F02","Frequency Fpic","Frequency Fread ordre 5","Frequency Fread ordre 8"],
2757                 defaut = ["Frequency Fread ordre 5"],
2758                 fr = """Choix de la frequence caracteristique du spectre de houle
2759 \begin{itemize}
2760 \item 1 : Frequence Fmoy
2761 \item 2 : Frequence F01 (definie par les moments d ordre 0 et 1 du
2762 spectre)
2763 \item 3 : Frequence F02 (definie par les moments d ordre 0 et 2 du
2764 spectre)
2765 \item 4 : Frequence Fpic (frequence d echantillonage correspondant au
2766 max)
2767 \item 5 : Frequence Fread ordre 5 (frequence de pic methode Read ordre
2768 5)
2769 \item 6 : Frequence Fread ordre 8 (frequence de pic methode Read ordre
2770 8)
2771 \end{itemize}
2772 **Mots-cles associes :**
2773 DISSIPATION PAR DEFERLEMENT
2774 DEFERLEMENT 2 (TG) FONCTION DE PONDERATION
2775 DEFERLEMENT 2 (TG) CONSTANTE B
2776 DEFERLEMENT 2 (TG) CONSTANTE GAMMA""",
2777                 ang = """Selection of the characteristic frequency of the wave spectrum
2778 \begin{itemize}
2779 \item 1 : Frequency Fmoy
2780 \item 2 : Frequency F01 (defined by the moments of order 0 and 1 of the
2781 spectrum)
2782 \item 3 : Frequency F02 (defined by the moments of order 0 and 2 of the
2783 spectrum)
2784 \item 4 : Frequency Fpic (sampling frequency corresponding to the max)
2785 \item 5 : Frequency Fread ordre 5 (peak frequency, 5th order Read
2786 method)
2787 \item 6 : Frequency Fread ordre 8 (peak frequency, 8th order Read
2788 method)
2789 \end{itemize}
2790  \begin{CommentBlock}{Related keywords}
2791 DEPTH-INDUCED BREAKING DISSIPATION
2792 DEPTH-INDUCED BREAKING 2 (TG) WEIGHTING FUNCTION
2793 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT B
2794 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT GAMMA
2795 \end{CommentBlock}""",
2796             ),
2797 #           -----------------------------------
2798             DEPTH_INDUCED_BREAKING_2__TG__COEFFICIENT_B = SIMP(statut ='o',
2799 #           -----------------------------------
2800                 typ = 'R',
2801                 defaut = 1.0,
2802                 fr = """Constante B du modele de deferlement de Thornton et Guza.
2803 **Mots-cles associes :**
2804 DISSIPATION PAR DEFERLEMENT
2805 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2806 DEFERLEMENT 2 (TG) FONCTION DE PONDERATION
2807 DEFERLEMENT 2 (TG) CHOIX FREQUENCE CARACTERISTIQUE
2808 DEFERLEMENT 2 (TG) CONSTANTE GAMMA""",
2809                 ang = """Coefficient B of the Thornton and Guza model.
2810 \\
2811  \begin{CommentBlock}{Related keywords}
2812 DEPTH-INDUCED BREAKING DISSIPATION\\
2813 NUMBER OF BREAKING TIME STEPS\\
2814 DEPTH-INDUCED BREAKING 2 (TG) WEIGHTING FUNCTION\\
2815 DEPTH-INDUCED BREAKING 2 (TG) CHARACTERISTIC FREQUENCY\\
2816 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT GAMMA
2817 \end{CommentBlock}""",
2818             ),
2819 #           -----------------------------------
2820             DEPTH_INDUCED_BREAKING_2__TG__COEFFICIENT_GAMMA = SIMP(statut ='o',
2821 #           -----------------------------------
2822                 typ = 'R',
2823                 defaut = 0.42,
2824                 fr = """Constante GAMMA du modele de deferlement de Thornton et Guza.
2825 **Mots-cles associes :**
2826 DISSIPATION PAR DEFERLEMENT
2827 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2828 DEFERLEMENT 2 (TG) FONCTION DE PONDERATION
2829 DEFERLEMENT 2 (TG) CHOIX FREQUENCE CARACTERISTIQUE
2830 DEFERLEMENT 2 (TG) CONSTANTE B""",
2831                 ang = """Coefficient GAMMA of the Thornton and Guza model.
2832 \\
2833  \begin{CommentBlock}{Related keywords}
2834 DEPTH-INDUCED BREAKING DISSIPATION\\
2835 NUMBER OF BREAKING TIME STEPS\\
2836 DEPTH-INDUCED BREAKING 2 (TG) WEIGHTING FUNCTION\\
2837 DEPTH-INDUCED BREAKING 2 (TG) CHARACTERISTIC FREQUENCY\\
2838 DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT B
2839 \end{CommentBlock}""",
2840             ),
2841         ),
2842 #       -----------------------------------
2843         b_DEPTH_INDUCED_BREAKING_DISSIPATIONI = BLOC(condition="DEPTH_INDUCED_BREAKING_DISSIPATION == 'Dissipation in accordance with Roelvink (1993)'",
2844 #       -----------------------------------
2845 #           -----------------------------------
2846             DEPTH_INDUCED_BREAKING_3__RO__WAVE_HEIGHT_DISTRIBUTION = SIMP(statut ='o',
2847 #           -----------------------------------
2848                 typ = 'TXM',
2849                 into = ["Weibull","Rayleigh"],
2850                 defaut = ["Weibull"],
2851                 fr = """Choix de la distribution des hauteurs de houle pour le
2852 modele de deferlement de Roelvink :
2853    1...Weibull,
2854    2...Rayleigh.
2855 **Mots-cles associes :**
2856 DISSIPATION PAR DEFERLEMENT
2857 DEFERLEMENT 3 (RO) EXPOSANT FONCTION DE PONDERATION
2858 DEFERLEMENT 3 (RO) CHOIX FREQUENCE CARACTERISTIQUE
2859 DEFERLEMENT 3 (RO) CONSTANTE ALPHA
2860 DEFERLEMENT 3 (RO) CONSTANTE GAMMA
2861 DEFERLEMENT 3 (RO) CONSTANTE GAMMA2""",
2862                 ang = """Selection of the wave height distribution for the
2863 Roelvink breaking model :
2864    1...Weibull,
2865    2...Rayleigh.
2866 \\
2867  \begin{CommentBlock}{Related keywords}
2868 DEPTH-INDUCED BREAKING DISSIPATION\\
2869 DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION\\
2870 DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY\\
2871 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA\\
2872 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA\\
2873 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2
2874 \end{CommentBlock}""",
2875             ),
2876 #           -----------------------------------
2877             DEPTH_INDUCED_BREAKING_3__RO__EXPONENT_WEIGHTING_FUNCTION = SIMP(statut ='o',
2878 #           -----------------------------------
2879                 typ = 'I',
2880                 defaut = 10,
2881                 fr = """Exposant n de la fonction de ponderation utilisee par
2882 le modele de deferlement de Roelvink.
2883 **Mots-cles associes :**
2884 DISSIPATION PAR DEFERLEMENT
2885 DEFERLEMENT 3 (RO) DISTRIBUTION DES HAUTEURS DE HOULE
2886 DEFERLEMENT 3 (RO) CHOIX FREQUENCE CARACTERISTIQUE
2887 DEFERLEMENT 3 (RO) CONSTANTE ALPHA
2888 DEFERLEMENT 3 (RO) CONSTANTE GAMMA
2889 DEFERLEMENT 3 (RO) CONSTANTE GAMMA2""",
2890                 ang = """n exponent of the weighting function used in the Roelvink
2891 breaking model.
2892 \\
2893  \begin{CommentBlock}{Related keywords}
2894 DEPTH-INDUCED BREAKING DISSIPATION\\
2895 DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION\\
2896 DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY\\
2897 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA\\
2898 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA\\
2899 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2
2900 \end{CommentBlock}""",
2901             ),
2902 #           -----------------------------------
2903             DEPTH_INDUCED_BREAKING_3__RO__CHARACTERISTIC_FREQUENCY = SIMP(statut ='o',
2904 #           -----------------------------------
2905                 typ = 'TXM',
2906                 into = ["Frequency Fmoy","Frequency F01","Frequency F02","Frequency Fpic","Frequency Fread ordre 5","Frequency Fread ordre 8"],
2907                 defaut = ["Frequency Fread ordre 5"],
2908                 fr = """Choix de la frequence caracteristique du spectre de houle
2909 1 : Frequence Fmoy
2910 2 : Frequence F01 (definie par les moments d ordre 0 et 1 du spectre)
2911 3 : Frequence F02 (definie par les moments d ordre 0 et 2 du spectre)
2912 4 : Frequence Fpic (frequence d echantillonage correspondant au max)
2913 5 : Frequence Fread ordre 5 (frequence de pic methode Read ordre 5)
2914 6 : Frequence Fread ordre 8 (frequence de pic methode Read ordre 8)
2915 **Mots-cles associes :**
2916 DISSIPATION PAR DEFERLEMENT
2917 DEFERLEMENT 3 (RO) DISTRIBUTION DES HAUTEURS DE HOULE
2918 DEFERLEMENT 3 (RO) EXPOSANT FONCTION DE PONDERATION
2919 DEFERLEMENT 3 (RO) CONSTANTE ALPHA
2920 DEFERLEMENT 3 (RO) CONSTANTE GAMMA
2921 DEFERLEMENT 3 (RO) CONSTANTE GAMMA2""",
2922                 ang = """Selection of the characteristic frequency of the wave spectrum
2923 \begin{itemize}
2924 \item 1 : Frequency Fmoy
2925 \item 2 : Frequency F01 (defined by the moments of order 0 and 1 of the
2926 spectrum)
2927 \item 3 : Frequency F02 (defined by the moments of order 0 and 2 of the
2928 spectrum)
2929 \item 4 : Frequency Fpic (sampling frequency corresponding to the max)
2930 \item 5 : Frequency Fread ordre 5 (peak frequency, 5th order Read
2931 method)
2932 \item 6 : Frequency Fread ordre 8 (peak frequency, 8th order Read
2933 method)
2934 \end{itemize}
2935  \begin{CommentBlock}{Related keywords}
2936 DEPTH-INDUCED BREAKING DISSIPATION\\
2937 DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION\\
2938 DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION\\
2939 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA\\
2940 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA\\
2941 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2
2942 \end{CommentBlock}""",
2943             ),
2944 #           -----------------------------------
2945             DEPTH_INDUCED_BREAKING_3__RO__COEFFICIENT_ALPHA = SIMP(statut ='o',
2946 #           -----------------------------------
2947                 typ = 'R',
2948                 defaut = 1.,
2949                 fr = """Constante ALPHA du modele de deferlement de Roelvink (1993).
2950 **Mots-cles associes :**
2951 DISSIPATION PAR DEFERLEMENT
2952 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2953 DEFERLEMENT 3 (RO) DISTRIBUTION DES HAUTEURS DE HOULE
2954 DEFERLEMENT 3 (RO) EXPOSANT FONCTION DE PONDERATION
2955 DEFERLEMENT 3 (RO) CHOIX FREQUENCE CARACTERISTIQUE
2956 DEFERLEMENT 3 (RO) CONSTANTE GAMMA
2957 DEFERLEMENT 3 (RO) CONSTANTE GAMMA2""",
2958                 ang = """Coefficient ALPHA of the Roelvink model (1993).
2959 \\
2960  \begin{CommentBlock}{Related keywords}
2961 DEPTH-INDUCED BREAKING DISSIPATION\\
2962 NUMBER OF BREAKING TIME STEPS\\
2963 DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION\\
2964 DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION\\
2965 DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY\\
2966 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA\\
2967 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2
2968 \end{CommentBlock}""",
2969             ),
2970 #           -----------------------------------
2971             DEPTH_INDUCED_BREAKING_3__RO__COEFFICIENT_GAMMA = SIMP(statut ='o',
2972 #           -----------------------------------
2973                 typ = 'R',
2974                 defaut = 0.54,
2975                 fr = """Constante GAMMA du modele de deferlement de Roelvink (1993).
2976 **Mots-cles associes :**
2977 DISSIPATION PAR DEFERLEMENT
2978 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
2979 DEFERLEMENT 3 (RO) DISTRIBUTION DES HAUTEURS DE HOULE
2980 DEFERLEMENT 3 (RO) EXPOSANT FONCTION DE PONDERATION
2981 DEFERLEMENT 3 (RO) CHOIX FREQUENCE CARACTERISTIQUE
2982 DEFERLEMENT 3 (RO) CONSTANTE ALPHA
2983 DEFERLEMENT 3 (RO) CONSTANTE GAMMA2""",
2984                 ang = """Coefficient GAMMA of the Roelvink model (1993).
2985 \\
2986  \begin{CommentBlock}{Related keywords}
2987 DEPTH-INDUCED BREAKING DISSIPATION\\
2988 NUMBER OF BREAKING TIME STEPS\\
2989 DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION\\
2990 DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION\\
2991 DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY\\
2992 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA\\
2993 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2
2994 \end{CommentBlock}""",
2995             ),
2996 #           -----------------------------------
2997             DEPTH_INDUCED_BREAKING_3__RO__COEFFICIENT_GAMMA2 = SIMP(statut ='o',
2998 #           -----------------------------------
2999                 typ = 'R',
3000                 defaut = 0.65,
3001                 fr = """Constante GAMMA2 du modele de deferlement de Roelvink (1993).
3002 N est utilisee que pour la distribution de Weibull.
3003 **Mots-cles associes :**
3004 DISSIPATION PAR DEFERLEMENT
3005 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
3006 DEFERLEMENT 3 (RO) DISTRIBUTION DES HAUTEURS DE HOULE
3007 DEFERLEMENT 3 (RO) EXPOSANT FONCTION DE PONDERATION
3008 DEFERLEMENT 3 (RO) CHOIX FREQUENCE CARACTERISTIQUE
3009 DEFERLEMENT 3 (RO) CONSTANTE ALPHA
3010 DEFERLEMENT 3 (RO) CONSTANTE GAMMA""",
3011                 ang = """Coefficient GAMMA2 of the Roelvink model (1993).
3012 \\
3013  \begin{CommentBlock}{Related keywords}
3014 DEPTH-INDUCED BREAKING DISSIPATION\\
3015 NUMBER OF BREAKING TIME STEPS\\
3016 DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION\\
3017 DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION\\
3018 DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY\\
3019 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA\\
3020 DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA
3021 \end{CommentBlock}""",
3022             ),
3023         ),
3024 #       -----------------------------------
3025         b_DEPTH_INDUCED_BREAKING_DISSIPATIONJ = BLOC(condition="DEPTH_INDUCED_BREAKING_DISSIPATION == 'Dissipation in accordance with Izumiya et Horikawa (1984)'",
3026 #       -----------------------------------
3027 #           -----------------------------------
3028             DEPTH_INDUCED_BREAKING_4__IH__CHARACTERISTIC_FREQUENCY = SIMP(statut ='o',
3029 #           -----------------------------------
3030                 typ = 'TXM',
3031                 into = ["Frequency Fmoy","Frequency F01","Frequency F02","Frequency Fpic","Frequency Fread ordre 5","Frequency Fread ordre 8"],
3032                 defaut = ["Frequency Fread ordre 5"],
3033                 fr = """Choix de la frequence caracteristique du spectre de houle
3034 1 : Frequence Fmoy
3035 2 : Frequence F01 (definie par les moments d ordre 0 et 1 du spectre)
3036 3 : Frequence F02 (definie par les moments d ordre 0 et 2 du spectre)
3037 4 : Frequence Fpic (frequence d echantillonage correspondant au max)
3038 5 : Frequence Fread ordre 5 (frequence de pic methode Read ordre 5)
3039 6 : Frequence Fread ordre 8 (frequence de pic methode Read ordre 8)
3040 **Mots-cles associes :**
3041 DISSIPATION PAR DEFERLEMENT
3042 DEFERLEMENT 4 (IH) CONSTANTE BETA0
3043 DEFERLEMENT 4 (IH) CONSTANTE M2STAR""",
3044                 ang = """Selection of the characteristic frequency of the wave spectrum
3045 \begin{itemize}
3046 \item 1 : Frequency Fmoy
3047 \item 2 : Frequency F01 (defined by the moments of order 0 and 1 of the
3048 spectrum)
3049 \item 3 : Frequency F02 (defined by the moments of order 0 and 2 of the
3050 spectrum)
3051 \item 4 : Frequency Fpic (sampling frequency corresponding to the max)
3052 \item 5 : Frequency Fread ordre 5 (peak frequency, 5th order Read
3053 method)
3054 \item 6 : Frequency Fread ordre 8 (peak frequency, 8th order Read
3055 method)
3056 \end{itemize}
3057  \begin{CommentBlock}{Related keywords}
3058 DEPTH-INDUCED BREAKING DISSIPATION\\
3059 DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT BETA0\\
3060 DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT M2STAR
3061 \end{CommentBlock}""",
3062             ),
3063 #           -----------------------------------
3064             DEPTH_INDUCED_BREAKING_4__IH__COEFFICIENT_BETA0 = SIMP(statut ='o',
3065 #           -----------------------------------
3066                 typ = 'R',
3067                 defaut = 1.8,
3068                 fr = """Constante BETA0 du modele de deferlement de Izumiya et
3069 Horikawa (1984).
3070 **Mots-cles associes :**
3071 DISSIPATION PAR DEFERLEMENT
3072 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
3073 DEFERLEMENT 4 (IH) CHOIX FREQUENCE CARACTERISTIQUE
3074 DEFERLEMENT 4 (IH) CONSTANTE M2STAR""",
3075                 ang = """coefficient BETA0 of the Izumiya and Horikawa
3076 model (1984).
3077 \\
3078  \begin{CommentBlock}{Related keywords}
3079 DEPTH-INDUCED BREAKING DISSIPATION\\
3080 NUMBER OF BREAKING TIME STEPS\\
3081 DEPTH-INDUCED BREAKING 4 (IH) CHARACTERISTIC FREQUENCY\\
3082 DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT M2STAR
3083 \end{CommentBlock}""",
3084             ),
3085 #           -----------------------------------
3086             DEPTH_INDUCED_BREAKING_4__IH__COEFFICIENT_M2STAR = SIMP(statut ='o',
3087 #           -----------------------------------
3088                 typ = 'R',
3089                 defaut = 0.009,
3090                 fr = """Constante M2STAR du modele de deferlement de Izumiya et
3091 Horikawa (1984).
3092 **Mots-cles associes :**
3093 DISSIPATION PAR DEFERLEMENT
3094 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT
3095 DEFERLEMENT 4 (IH) CHOIX FREQUENCE CARACTERISTIQUE
3096 DEFERLEMENT 4 (IH) CONSTANTE BETA0""",
3097                 ang = """coefficient M2STAR of the Izumiya and Horikawa
3098 model (1984).
3099 \\
3100  \begin{CommentBlock}{Related keywords}
3101 DEPTH-INDUCED BREAKING DISSIPATION\\
3102 NUMBER OF BREAKING TIME STEPS\\
3103 DEPTH-INDUCED BREAKING 4 (IH) CHARACTERISTIC FREQUENCY\\
3104 DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT BETA0
3105 \end{CommentBlock}""",
3106             ),
3107         ),
3108 #       -----------------------------------
3109         NUMBER_OF_BREAKING_TIME_STEPS = SIMP(statut ='o',
3110 #       -----------------------------------
3111             typ = 'I',
3112             defaut = 1,
3113             fr = """Nombre de sous-pas de temps pour la prise en compte de la
3114 dissipation d energie par deferlement. Ces sous-pas de temps sont
3115 en progression geometrique.
3116 **Mots-cles associes :**
3117 DISSIPATION PAR DEFERLEMENT
3118 COEFFICIENT POUR LES SOUS-PAS DE TEMPS POUR LE DEFERLEMENT""",
3119             ang = """Number of time steps for the breaking source term.
3120 These time steps are in a geometric progression
3121 \\
3122  \begin{CommentBlock}{Related keywords}
3123 DEPTH-INDUCED BREAKING DISSIPATION\\
3124 COEFFICIENT FOR THE BREAKING TIME STEPS
3125 \end{CommentBlock}""",
3126         ),
3127 #       -----------------------------------
3128         MAXIMUM_VALUE_OF_THE_RATIO_HM0_ON_D = SIMP(statut ='o',
3129 #       -----------------------------------
3130             typ = 'R',
3131             defaut = 1.,
3132             fr = """En debut de prise en compte des termes sources, la hauteur
3133 de houle est ecretee de facon a satisfaire le critere specifie.
3134 **Mots-cles associes :**
3135 DISSIPATION PAR DEFERLEMENT""",
3136             ang = """At the beginning of the integration of the source terms,
3137 the wave height is lopped in order to satisfy the specified
3138 criterium.
3139 \\
3140  \begin{CommentBlock}{Related keywords}
3141 DEPTH-INDUCED BREAKING DISSIPATION
3142 \end{CommentBlock}""",
3143         ),
3144 #       -----------------------------------
3145         COEFFICIENT_OF_THE_TIME_SUB_INCREMENTS_FOR_BREAKING = SIMP(statut ='f',
3146 #       -----------------------------------
3147             typ = 'R',
3148             defaut = 1.45,
3149             fr = """Raison de la suite geometrique des sous-pas de temps pour
3150 le deferlement.
3151 **Mots-cles associes :**
3152 DISSIPATION PAR DEFERLEMENT
3153 NOMBRE DE SOUS-PAS DE TEMPS POUR LE DEFERLEMENT""",
3154             ang = """Geometrical ratio of the time sub-increments for the
3155 depth-induced breaking
3156 \\
3157  \begin{CommentBlock}{Related keywords}
3158 DEPTH-INDUCED BREAKING DISSIPATION\\
3159 NUMBER OF BREAKING TIME STEPS
3160 \end{CommentBlock}""",
3161         ),
3162     ),
3163 #   -----------------------------------
3164     LIMITER = FACT(statut='o',
3165 #   -----------------------------------
3166 #       -----------------------------------
3167         WAVE_GROWTH_LIMITER = SIMP(statut ='o',
3168 #       -----------------------------------
3169             typ = 'TXM',
3170             into = ["no wave growth limiter","WAM 4 original limiter","Hersbach et Janssen (1999) limiter","Laugel-BAJ limiter"],
3171             defaut = ["WAM 4 original limiter"],
3172             fr = """Choix du type de limiteur de croissance.
3173 Si la valeur est 0, pas de limiteur.
3174 Si la valeur est 1, limiteur type WAM 4 original.
3175 Si la valeur est 2, limiteur de Hersbach et Janssen (1999).
3176 Si la valeur est 3, limiteur de BAJ Laugel.
3177 **Mots-cles associes :**
3178 PRISE EN COMPTE DES TERMES SOURCES""",
3179             ang = """Choice of the wave growth limiter.
3180 \begin{itemize}
3181 \item If LIMIT=0, no wave growth limiter.
3182 \item If LIMIT=1, WAM 4 original limiter.
3183 \item If LIMIT=2, Hersbach et Janssen (1999) limiter.
3184 \item If LIMIT=3, Laugel BAJ limiter.
3185 \end{itemize}
3186  \begin{CommentBlock}{Related keywords}
3187 CONSIDERATION OF SOURCE TERMS
3188 \end{CommentBlock}""",
3189         ),
3190     ),
3191 #   -----------------------------------
3192     TRIAD_TRANSFERS = FACT(statut='o',
3193 #   -----------------------------------
3194 #       -----------------------------------
3195         TRIAD_INTERACTIONS = SIMP(statut ='o',
3196 #       -----------------------------------
3197             typ = 'TXM',
3198             into = ["no triad interactions","LTA model (Eldeberky, 1995)","SPB model (Becq, 1998)"],
3199             defaut = ["no triad interactions"],
3200             fr = """Choix du type de modelisation du terme de transfert non
3201 lineaire entre triplets de frequences. Si sa valeur est 0, on ne
3202 prend pas en compte les transferts non lineaires entre triplets
3203 de frequences, si sa valeur est 1, ils sont integres selon le
3204 modele LTA, si sa valeur est 2, ils sont integres selon le
3205 modele SPB.
3206 **Mots-cles associes :**
3207 TRIADS 1 (LTA) CONSTANTE ALPHA
3208 TRIADS 1 (LTA) CONSTANTE RFMLTA
3209 TRIADS 2 (SPB) CONSTANTE K
3210 TRIADS 2 (SPB) BORNE DIRECTIONNELLE INFERIEURE
3211 TRIADS 2 (SPB) BORNE DIRECTIONNELLE SUPERIEURE""",
3212             ang = """Selection of the triad interaction model:
3213 \begin{itemize}
3214 \item 0 : no triad interactions
3215 \item 1 : LTA model (Eldeberky, 1996)
3216 \item 2 : SPB model (Becq, 1998)
3217 \end{itemize}
3218  \begin{CommentBlock}{Related keywords}
3219 TRIADS 1 (LTA) COEFFICIENT ALPHA\\
3220 TRIADS 1 (LTA) COEFFICIENT RFMLTA\\
3221 TRIADS 2 (SPB) COEFFICIENT K\\
3222 TRIADS 2 (SPB) LOWER DIRECTIONAL BOUNDARY\\
3223 TRIADS 2 (SPB) UPPER DIRECTIONAL BOUNDARY\\
3224 \end{CommentBlock}""",
3225         ),
3226 #       -----------------------------------
3227         b_TRIAD_INTERACTIONSG = BLOC(condition="TRIAD_INTERACTIONS == 'LTA model (Eldeberky, 1996)'",
3228 #       -----------------------------------
3229 #           -----------------------------------
3230             TRIADS_1__LTA__COEFFICIENT_ALPHA = SIMP(statut ='o',
3231 #           -----------------------------------
3232                 typ = 'R',
3233                 defaut = 0.5,
3234                 fr = """Constante alpha du modele LTA propose par Eldeberky (1996).
3235 Si alpha = 0, les transferts d energie entre frequences seront nuls.
3236 L intensite de ces transferts augmente avec la valeur de alpha.
3237 **Mots-cles associes :**
3238 TRANSFERTS ENTRE TRIPLETS DE FREQUENCES
3239 TRIADS 1 (LTA) CONSTANTE RFMLTA""",
3240                 ang = """Coefficient alpha of the LTA model proposed by Eldeberky(1996).
3241 If alpha=0, no energy transfers. The energy transfers increase
3242 with alpha.
3243 \\
3244  \begin{CommentBlock}{Related keywords}
3245 TRIAD INTERACTIONS\\
3246 TRIADS 1 (LTA) COEFFICIENT RFMLTA
3247 \end{CommentBlock}""",
3248             ),
3249 #           -----------------------------------
3250             TRIADS_1__LTA__COEFFICIENT_RFMLTA = SIMP(statut ='o',
3251 #           -----------------------------------
3252                 typ = 'R',
3253                 defaut = 2.5,
3254                 fr = """RFMLTA determine la frequence maximale vers laquelle les
3255 transferts d energie peuvent avoir lieu. La frequence maximale est
3256 calculee comme le produit entre la constante RFMLTA et la frequence
3257 de pic du spectre.
3258 **Mots-cles associes :**
3259 TRANSFERTS ENTRE TRIPLETS DE FREQUENCES
3260 TRIADS 1 (LTA) CONSTANTE ALPHA""",
3261                 ang = """RFMLTA determines the upper frequency on which the energy
3262 transfers may occur. The maximal frequency is calculated as the
3263 product of the constant RFMLTA by the peak frequency of the spectrum.
3264 \\
3265  \begin{CommentBlock}{Related keywords}
3266 TRIAD INTERACTIONS\\
3267 TRIADS 1 (LTA) COEFFICIENT ALPHA
3268 \end{CommentBlock}""",
3269             ),
3270         ),
3271 #       -----------------------------------
3272         b_TRIAD_INTERACTIONSH = BLOC(condition="TRIAD_INTERACTIONS == 'SPB model (Becq, 1998)'",
3273 #       -----------------------------------
3274 #           -----------------------------------
3275             TRIADS_2__SPB__COEFFICIENT_K = SIMP(statut ='o',
3276 #           -----------------------------------
3277                 typ = 'R',
3278                 defaut = 0.34,
3279                 fr = """Parametre d ajustement du modele SPB
3280 **Mots-cles associes :**
3281 TRANSFERTS ENTRE TRIPLETS DE FREQUENCES
3282 TRIADS 2 (SPB) BORNE DIRECTIONNELLE INFERIEURE
3283 TRIADS 2 (SPB) BORNE DIRECTIONNELLE SUPERIEURE""",
3284                 ang = """coefficient K of the SPB model
3285 \\
3286  \begin{CommentBlock}{Related keywords}
3287 TRIAD INTERACTIONS\\
3288 TRIADS 2 (SPB) LOWER DIRECTIONAL BOUNDARY\\
3289 TRIADS 2 (SPB) UPPER DIRECTIONAL BOUNDARY
3290 \end{CommentBlock}""",
3291             ),
3292 #           -----------------------------------
3293             TRIADS_2__SPB__LOWER_DIRECTIONAL_BOUNDARY = SIMP(statut ='o',
3294 #           -----------------------------------
3295                 typ = 'R',
3296                 defaut = 0.,
3297                 fr = """Borne directionnelle inferieure du modele SPB
3298 **Mots-cles associes :**
3299 TRANSFERTS ENTRE TRIPLETS DE FREQUENCES
3300 TRIADS 2 (SPB) CONSTANTE K
3301 TRIADS 2 (SPB) BORNE DIRECTIONNELLE SUPERIEURE""",
3302                 ang = """Lower directional boundary of the SPB model
3303 \\
3304  \begin{CommentBlock}{Related keywords}
3305 TRIAD INTERACTIONS\\
3306 TRIADS 2 (SPB) COEFFICIENT K\\
3307 TRIADS 2 (SPB) UPPER DIRECTIONAL BOUNDARY
3308 \end{CommentBlock}""",
3309             ),
3310 #           -----------------------------------
3311             TRIADS_2__SPB__UPPER_DIRECTIONAL_BOUNDARY = SIMP(statut ='o',
3312 #           -----------------------------------
3313                 typ = 'R',
3314                 defaut = 360.,
3315                 fr = """Borne directionnelle superieure du modele SPB
3316 **Mots-cles associes :**
3317 TRANSFERTS ENTRE TRIPLETS DE FREQUENCES
3318 TRIADS 2 (SPB) CONSTANTE K
3319 TRIADS 2 (SPB) BORNE DIRECTIONNELLE INFERIEURE""",
3320                 ang = """Upper directional boundary of the SPB model
3321 \\
3322  \begin{CommentBlock}{Related keywords}
3323 TRIAD INTERACTIONS\\
3324 TRIADS 2 (SPB) COEFFICIENT K\\
3325 TRIADS 2 (SPB) LOWER DIRECTIONAL BOUNDARY
3326 \end{CommentBlock}""",
3327             ),
3328         ),
3329     ),
3330 #   -----------------------------------
3331     VEGETATION = FACT(statut='o',
3332 #   -----------------------------------
3333 #       -----------------------------------
3334         VEGETATION_TAKEN_INTO_ACCOUNT = SIMP(statut ='o',
3335 #       -----------------------------------
3336             typ = bool,
3337             defaut = False,
3338             fr = """Si oui, on appelle le sous-programme QVEG, dans lequel des
3339 donnees sur la vegetation doivent etre renseignees""",
3340             ang = """If YES, subroutine QVEG will be called, it contains data
3341 on vegetation that are case-specific and must thus be modified""",
3342         ),
3343     ),
3344 #   -----------------------------------
3345     POROUS = FACT(statut='o',
3346 #   -----------------------------------
3347 #       -----------------------------------
3348         POROUS_MEDIA = SIMP(statut ='o',
3349 #       -----------------------------------
3350             typ = bool,
3351             defaut = False,
3352             fr = """Si oui, on appelle le sous-programme QPOROS, dans lequel des
3353 donnees sur le milieu poreux doivent etre renseignees""",
3354             ang = """If YES, subroutine QPOROS will be called, it contains data
3355 on POROUS MEDIA that are case-specific and must thus be modified""",
3356         ),
3357     ),
3358 )
3359 # -----------------------------------------------------------------------
3360 INITIAL_CONDITIONS = PROC(nom= "INITIAL_CONDITIONS",op = None,
3361 # -----------------------------------------------------------------------
3362 #   -----------------------------------
3363     TYPE_OF_INITIAL_DIRECTIONAL_SPECTRUM = SIMP(statut ='o',
3364 #   -----------------------------------
3365         typ = 'TXM',
3366         into = ["non-existent spectrum","JONSWAP spectrum 1","JONSWAP spectrum 2","JONSWAP spectrum 3","JONSWAP spectrum 4","JONSWAP spectrum 5","JONSWAP spectrum 6","TMA spectrum"],
3367         defaut = ["non-existent spectrum"],
3368         fr = """Si ce mot-cle est pris egal a 0, on specifie un spectre
3369 initial nul. Si il est pris egal entre 1 et 6
3370 un spectre de type JONSWAP est specifie du champ de vent initial
3371 et ou des valeurs des autres mots cles. Si il est pris egal a 7
3372 un spectre de type TMA parametre est specifie.
3373 **Mots-cles associes :**
3374 HAUTEUR SIGNIFICATIVE INITIALE
3375 FREQUENCE DE PIC INITIALE
3376 FACTEUR DE PIC INITIAL
3377 VALEUR INITIALE DE SIGMA-A POUR SPECTRE
3378 VALEUR INITIALE DE SIGMA-B POUR SPECTRE
3379 CONSTANTE DE PHILLIPS INITIALE
3380 VALEUR MOYENNE DU FETCH INITIAL
3381 FREQUENCE DE PIC MAXIMALE
3382 DIRECTION PRINCIPALE 1 INITIALE
3383 ETALEMENT DIRECTIONNEL 1 INITIAL
3384 DIRECTION PRINCIPALE 2 INITIALE
3385 ETALEMENT DIRECTIONNEL 2 INITIAL
3386 FACTEUR DE PONDERATION POUR FRA INITIALE""",
3387         ang = """If this keyword is set to 0, a non-existent spectrum is speci
3388 fied at the initial time step. If it ranges from 1 to 7, a
3389 JONSWAP (or TMA)-typed spectrum is specified as a
3390 function of the initial wind field and/or of the values of the
3391 following keywords
3392 \\
3393  \begin{CommentBlock}{Related keywords}
3394 INITIAL SIGNIFICANT WAVE HEIGHT\\
3395 INITIAL PEAK FREQUENCY\\
3396 INITIAL PEAK FACTOR\\
3397 INITIAL VALUE OF SIGMA-A FOR SPECTRUM\\
3398 INITIAL VALUE OF SIGMA-B FOR SPECTRUM\\
3399 INITIAL PHILLIPS CONSTANT\\
3400 INITIAL MEAN FETCH VALUE\\
3401 INITIAL MAXIMUM PEAK FREQUENCY\\
3402 INITIAL MAIN DIRECTION 1\\
3403 INITIAL DIRECTIONAL SPREAD 1\\
3404 INITIAL MAIN DIRECTION 2\\
3405 INITIAL DIRECTIONAL SPREAD 2\\
3406 INITIAL WEIGHTING FACTOR FOR ADF
3407 \end{CommentBlock}""",
3408     ),
3409 #   -----------------------------------
3410     INITIAL_ANGULAR_DISTRIBUTION_FUNCTION = SIMP(statut ='f',
3411 #   -----------------------------------
3412         typ = 'TXM',
3413         into = ["$cos{^2s}(T-T0)$, T in [T0-pi/2,T0+pi/2]","$exp(-0.5((T-T0)/s)^2)$, T in [T0-pi/2,T0+pi/2]","$cos{^2s}((T-T0)/2)$ (de type Mitsuyasu)","Goda Formula allowing a frequence dependancy"],
3414         defaut = ["$cos{^2s}(T-T0)$, T in [T0-pi/2,T0+pi/2]"],
3415         fr = """Fait partie de l ensemble des constantes utilisees dans
3416 l initialisation du spectre directionnel. Permet le calcul de
3417 la fonction de repartition angulaire bimodale pour une serie de
3418 directions
3419 1 : modele en $cos{^2s}(T-T0)$ ; T dans [T0-pi/2;T0+pi/2]
3420 2 : modele en $exp(-0.5((T-T0)/s)^2)$ ; T dans [T0-pi/2;T0+pi/2]
3421 3 : modele en $cos{^2s}((T-T0)/2)$ (de type Mitsuyasu)
3422 4 : Formule de Goda : Mitsuyasu avec $s=(F/fp)^5$ or $s=(F/fp)^{-2.5}$
3423 **Mots-cles associes :**
3424 TYPE DE SPECTRE DIRECTIONNEL INITIAL""",
3425         ang = """Is part of the set of constants used for computing the
3426 initial directional spectrum. Allow the computation of the
3427 angular distribution function
3428 \begin{itemize}
3429 \item 1 : $cos^{2s}(T-T0)$ ; with T in [T0-pi/2;T0+pi/2]
3430 \item 2 : $exp(-0.5((T-T0)/s)^2)$ ; with T in [T0-pi/2;T0+pi/2]
3431 \item 3 : $cos^{2s}((T-T0)/2)$ (of type Mitsuyasu)
3432 \item 4 : Mitsuyasu with $s=(F/fp)^5$ or $s=(F/fp)^{-2.5}$
3433 \end{itemize}
3434 where $s$ is the boundary directionnal spread (\telkey{SPRED1}
3435 or \telkey{SPRED2})
3436 \\
3437  \begin{CommentBlock}{Related keywords}
3438 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3439 \end{CommentBlock}""",
3440     ),
3441 #   -----------------------------------
3442     INITIAL_SIGNIFICANT_WAVE_HEIGHT = SIMP(statut ='o',
3443 #   -----------------------------------
3444         typ = 'R',
3445         defaut = 1.,
3446         fr = """Fait partie de l ensemble des constantes utilisees dans
3447 l initialisation du spectre directionnel en fonction du champ
3448 de vent initial.
3449 **Mots-cles associes :**
3450 TYPE DE SPECTRE DIRECTIONNEL INITIAL""",
3451         ang = """Is part of the set of constants used for computing the
3452 boundary directional spectrum as a function of the wind field.
3453 \\
3454  \begin{CommentBlock}{Related keywords}
3455 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3456 \end{CommentBlock}""",
3457     ),
3458 #   -----------------------------------
3459     INITIAL_PEAK_FREQUENCY = SIMP(statut ='o',
3460 #   -----------------------------------
3461         typ = 'R',
3462         defaut = 0.067,
3463         fr = """Fait partie de l ensemble des constantes utilisees dans
3464 l initialisation du spectre directionnel en fonction du champ
3465 de vent initial.
3466 **Mots-cles associes :**
3467 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3468         ang = """Is part of the set of constants used for computing the
3469 boundary directional spectrum as a function of the wind field.
3470 \\
3471  \begin{CommentBlock}{Related keywords}
3472 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3473 \end{CommentBlock}""",
3474     ),
3475 #   -----------------------------------
3476     INITIAL_PEAK_FACTOR = SIMP(statut ='o',
3477 #   -----------------------------------
3478         typ = 'R',
3479         defaut = 3.3,
3480         fr = """Fait partie de l ensemble des constantes utilisees dans
3481 l initialisation du spectre directionnel en fonction du champ
3482 de vent initial.
3483 **Mots-cles associes :**
3484 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3485         ang = """Is part of the set of constants used for computing the
3486 initial directional spectrum as a function of the wind field.
3487 \\
3488  \begin{CommentBlock}{Related keywords}
3489 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3490 \end{CommentBlock}""",
3491     ),
3492 #   -----------------------------------
3493     INITIAL_VALUE_OF_SIGMA_A_FOR_SPECTRUM = SIMP(statut ='f',
3494 #   -----------------------------------
3495         typ = 'R',
3496         defaut = 0.07,
3497         fr = """Fait partie de l ensemble des constantes utilisees dans
3498 l initialisation du spectre directionnel en fonction du champ
3499 de vent initial.
3500 **Mots-cles associes :**
3501 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3502         ang = """Is part of the set of constants used for computing the
3503 initial directional spectrum as a function of the wind field.
3504 \\
3505  \begin{CommentBlock}{Related keywords}
3506 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3507 \end{CommentBlock}""",
3508     ),
3509 #   -----------------------------------
3510     INITIAL_VALUE_OF_SIGMA_B_FOR_SPECTRUM = SIMP(statut ='f',
3511 #   -----------------------------------
3512         typ = 'R',
3513         defaut = 0.09,
3514         fr = """Fait partie de l ensemble des constantes utilisees dans
3515 l initialisation du spectre directionnel en fonction du champ
3516 de vent initial.
3517 **Mots-cles associes :**
3518 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3519         ang = """Is part of the set of constants used for computing the
3520 initial directional spectrum as a function of the wind field.
3521 \\
3522  \begin{CommentBlock}{Related keywords}
3523 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3524 \end{CommentBlock}""",
3525     ),
3526 #   -----------------------------------
3527     INITIAL_PHILLIPS_CONSTANT = SIMP(statut ='f',
3528 #   -----------------------------------
3529         typ = 'R',
3530         defaut = 0.0081,
3531         fr = """Fait partie de l ensemble des constantes utilisees dans
3532 l initialisation du spectre directionnel en fonction du champ
3533 de vent initial.
3534 **Mots-cles associes :**
3535 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3536         ang = """Is part of the set of constants used for computing the
3537 initiale directional spectrum as a function of the wind field.
3538 \\
3539  \begin{CommentBlock}{Related keywords}
3540 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3541 \end{CommentBlock}""",
3542     ),
3543 #   -----------------------------------
3544     INITIAL_MEAN_FETCH_VALUE = SIMP(statut ='o',
3545 #   -----------------------------------
3546         typ = 'R',
3547         defaut = 30000.,
3548         fr = """Fait partie de l ensemble des constantes utilisees dans
3549 l initialisation du spectre directionnel en fonction du champ
3550 de vent initial.
3551 **Mots-cles associes :**
3552 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3553         ang = """Is part of the set of constants used for computing the
3554 initial directional spectrum as a function of the wind field.
3555 \\
3556  \begin{CommentBlock}{Related keywords}
3557 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3558 \end{CommentBlock}""",
3559     ),
3560 #   -----------------------------------
3561     INITIAL_MAXIMUM_PEAK_FREQUENCY = SIMP(statut ='o',
3562 #   -----------------------------------
3563         typ = 'R',
3564         defaut = 0.2,
3565         fr = """Fait partie de l ensemble des constantes utilisees dans
3566 l initialisation du spectre directionnel en fonction du champ
3567 de vent initial.
3568 **Mots-cles associes :**
3569 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3570         ang = """Is part of the set of constants used for computing the
3571 initial directional spectrum as a function of the wind field.
3572 \\
3573  \begin{CommentBlock}{Related keywords}
3574 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3575 \end{CommentBlock}""",
3576     ),
3577 #   -----------------------------------
3578     INITIAL_MAIN_DIRECTION_1 = SIMP(statut ='o',
3579 #   -----------------------------------
3580         typ = 'R',
3581         defaut = 0.,
3582         fr = """Fait partie de l ensemble des constantes utilisees dans
3583 l initialisation du spectre directionnel en fonction du champ
3584 de vent initial. Exprimee en degres
3585 **Mots-cles associes :**
3586 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3587         ang = """Is part of the set of constants used for computing the
3588 initial directional spectrum as a function of the wind field.
3589 \\
3590  \begin{CommentBlock}{Related keywords}
3591 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3592 \end{CommentBlock}""",
3593     ),
3594 #   -----------------------------------
3595     INITIAL_DIRECTIONAL_SPREAD_1 = SIMP(statut ='o',
3596 #   -----------------------------------
3597         typ = 'R',
3598         defaut = 2.,
3599         fr = """Fait partie de l ensemble des constantes utilisees dans
3600 l initialisation du spectre directionnel en fonction du champ
3601 de vent initial.
3602 **Mots-cles associes :**
3603 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3604         ang = """Is part of the set of constants used for computing the
3605 initial directional spectrum as a function of the wind field.
3606 \\
3607  \begin{CommentBlock}{Related keywords}
3608 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3609 \end{CommentBlock}""",
3610     ),
3611 #   -----------------------------------
3612     INITIAL_MAIN_DIRECTION_2 = SIMP(statut ='o',
3613 #   -----------------------------------
3614         typ = 'R',
3615         defaut = 0.,
3616         fr = """Fait partie de l ensemble des constantes utilisees dans
3617 l initialisation du spectre directionnel en fonction du champ
3618 de vent initial. Exprimee en degres.
3619 **Mots-cles associes :**
3620 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3621         ang = """Is part of the set of constants used for computing the
3622 initial directional spectrum as a function of the wind field.
3623 \\
3624  \begin{CommentBlock}{Related keywords}
3625 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3626 \end{CommentBlock}""",
3627     ),
3628 #   -----------------------------------
3629     INITIAL_DIRECTIONAL_SPREAD_2 = SIMP(statut ='o',
3630 #   -----------------------------------
3631         typ = 'R',
3632         defaut = 2.,
3633         fr = """Fait partie de l ensemble des constantes utilisees dans
3634 l initialisation du spectre directionnel en fonction du champ
3635 de vent initial.
3636 **Mots-cles associes :**
3637 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3638         ang = """Is part of the set of constants used for computing the
3639 initial directional spectrum as a function of the wind field.
3640 \\
3641  \begin{CommentBlock}{Related keywords}
3642 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3643 \end{CommentBlock}""",
3644     ),
3645 #   -----------------------------------
3646     INITIAL_WEIGHTING_FACTOR_FOR_ADF = SIMP(statut ='o',
3647 #   -----------------------------------
3648         typ = 'R',
3649         defaut = 1.,
3650         fr = """Fait partie de l ensemble des constantes utilisees dans
3651 l initialisation du spectre directionnel en fonction du champ
3652 de vent initial.
3653 **Mots-cles associes :**
3654 INITIALISATION DU SPECTRE DIRECTIONNEL""",
3655         ang = """Is part of the set of constants used for computing the
3656 initial directional spectrum as a function of the wind field.
3657 \\
3658  \begin{CommentBlock}{Related keywords}
3659 TYPE OF INITIAL DIRECTIONAL SPECTRUM
3660 \end{CommentBlock}""",
3661     ),
3662 #   -----------------------------------
3663     GODA_COEFFICIENT_FOR_ANGULAR_SPEADING = SIMP(statut ='o',
3664 #   -----------------------------------
3665         typ = 'R',
3666         defaut = 1.,
3667         fr = """Fait partie de l ensemble des constantes utilisees dans
3668 l initialisation du spectre directionnel en fonction du champ
3669 de vent initial. Coefficient intervenant dans la loi de repartition
3670 angulaire. Selon Goda 10(Wind waves), 25 swell short decay, 75 long deca
3671 mais des valeurs autres sont acceptees.
3672 **Mots-cles associes :**
3673 FONCTION DE REPARTITION ANGULAIRE INITIALE""",
3674         ang = """Is part of the set of constants used for computing the
3675 initial directional spectrum as a function of the wind field.
3676 This coefficient is in the formula of Goda formulation.
3677 It should be 10Wind waves, 25 swell short decay, 75 long decay
3678 but other values are accepted.
3679 \\
3680  \begin{CommentBlock}{Related keywords}
3681 INITIAL ANGULAR DISTRIBUTION FUNCTION
3682 \end{CommentBlock}""",
3683     ),
3684 #   -----------------------------------
3685     INITIAL_STILL_WATER_LEVEL = SIMP(statut ='o',
3686 #   -----------------------------------
3687         typ = 'R',
3688         defaut = 0.,
3689         fr = """Parametre permettant de calculer la profondeur
3690 initiale du plan d eau (DEPTH) a partir de la cote du
3691 fond (ZF) : DEPTH=ZREPOS-ZF.""",
3692         ang = """Parameter used in the computation of the initial
3693 water DEPTH : DEPTH=ZREPOS-ZF.""",
3694     ),
3695 )
3696 # -----------------------------------------------------------------------
3697 INTERNAL = PROC(nom= "INTERNAL",op = None,
3698 # -----------------------------------------------------------------------
3699     UIinfo = {"groupes": ("CACHE")},
3700 #   -----------------------------------
3701     VECTOR_LENGTH = SIMP(statut ='o',
3702 #   -----------------------------------
3703         typ = 'I',
3704         defaut = [1],
3705         fr = """Indique la longueur du vecteur de la machine vectorielle
3706 utilisee.""",
3707         ang = """Indicates the vector length of the vectorial machine
3708 being used.""",
3709     ),
3710 #   -----------------------------------
3711     STEERING_FILE = SIMP(statut ='f',
3712 #   -----------------------------------
3713         typ = ('Fichier','All Files (*)'),
3714         defaut = '',
3715         fr = """Nom du fichier contenant les parametres du calcul a realiser.""",
3716         ang = """Name of the file containing the parameters of the computation
3717 to be made.""",
3718     ),
3719 #   -----------------------------------
3720     DICTIONARY = SIMP(statut ='f',
3721 #   -----------------------------------
3722         typ = ('Fichier','All Files (*)'),
3723         defaut = 'tomawac.dico',
3724         fr = """Dictionnaire des mots cles.""",
3725         ang = """Key word dictionary.""",
3726     ),
3727 #   -----------------------------------
3728     BOUNDARY_CONDITION_BEFORE_TIME_STEP = SIMP(statut ='f',
3729 #   -----------------------------------
3730         typ = bool,
3731         defaut = [False],
3732         fr = """Indique si on tient compte de la condition à la limite
3733 avant ou apres le pas de temps""",
3734         ang = """Indicates whether boundary condition is taken into account
3735 before or after time step""",
3736     ),
3737 #   -----------------------------------
3738     ECRET_FOR_SMALL_HEIGHT = SIMP(statut ='f',
3739 #   -----------------------------------
3740         typ = bool,
3741         defaut = [True ],
3742         fr = """Indique si on ecrete la hauteur de vague pour les
3743 hauteurs d eau quasi nulle""",
3744         ang = """Indicates whether wave height is null for very
3745 small heigth of water""",
3746     ),
3747 #   -----------------------------------
3748     CONCATENATE_PARTEL_OUTPUT = SIMP(statut ='o',
3749 #   -----------------------------------
3750         typ = bool,
3751         defaut = False,
3752         fr = """Avec cette option partel ne genereras non plus un fichier (GEO/CLI/PAR)
3753 par processeur mais une concaténation de ceux-ci, ainsi qu''un fichier
3754 d''index associé. Ainsi plutot que d''avoir 3P fichiers, il n''y en a
3755 plus que 6.""",
3756         ang = """With this option partel no more generates a file (GEO/CLI/PAR) per
3757 process but a single concatenate file of them, associated to an index
3758 file. Then instead of having partel generating 3P files, it only
3759 generates 6 files.""",
3760     ),
3761 )
3762 # -----------------------------------------------------------------------
3763 BOUNDARY_CONDITIONS = PROC(nom= "BOUNDARY_CONDITIONS",op = None,
3764 # -----------------------------------------------------------------------
3765 #   -----------------------------------
3766     TYPE_OF_BOUNDARY_DIRECTIONAL_SPECTRUM = SIMP(statut ='o',
3767 #   -----------------------------------
3768         typ = 'TXM',
3769         into = ["non-existent spectrum","JONSWAP spectrum 1","JONSWAP spectrum 2","JONSWAP spectrum 3","JONSWAP spectrum 4","JONSWAP spectrum 5","JONSWAP spectrum 6","TMA spectrum"],
3770         defaut = ["non-existent spectrum"],
3771         fr = """Si ce mot-cle est pris egal a 0, on specifie un spectre
3772 nul aux limites. Si il est pris egal entre 1 et 6
3773 un spectre de type JONSWAP est specifie en tout point des limites
3774 d entree en fonction du champ de vent aux limites et ou des
3775 valeurs des autres mots cles. Si il est pris egal a 7 un spectre de
3776 type TMA parametre est specifie aux limites.
3777 **Mots-cles associes :**
3778 HAUTEUR SIGNIFICATIVE AUX LIMITES
3779 FREQUENCE DE PIC AUX LIMITES
3780 FACTEUR DE PIC AUX LIMITES
3781 VALEUR AUX LIMITES DE SIGMA-A POUR SPECTRE
3782 VALEUR AUX LIMITES DE SIGMA-B POUR SPECTRE
3783 CONSTANTE DE PHILLIPS AUX LIMITES
3784 VALEUR MOYENNE DU FETCH AUX LIMITES
3785 FREQUENCE DE PIC MAXIMALE
3786 DIRECTION PRINCIPALE 1 AUX LIMITES
3787 ETALEMENT DIRECTIONNEL 1 AUX LIMITES
3788 DIRECTION PRINCIPALE 2 AUX LIMITES
3789 ETALEMENT DIRECTIONNEL 2 AUX LIMITES
3790 FACTEUR DE PONDERATION POUR FRA AUX LIMITES""",
3791         ang = """If this keyword is set to 0, a non-existent spectrum is speci
3792 fied at the inlet boundaries of the domain. If it ranges from 1 to 7, a
3793 JONSWAP (or TMA) -typed spectrum is specified at these very points as a
3794 function of the initial wind field and/or of the values of the following
3795 keywords
3796 \\
3797  \begin{CommentBlock}{Related keywords}
3798 BOUNDARY SIGNIFICANT WAVE HEIGHT\\
3799 BOUNDARY PEAK FREQUENCY\\
3800 BOUNDARY PEAK FACTOR\\
3801 BOUNDARY VALUE OF SIGMA-A FOR SPECTRUM\\
3802 BOUNDARY VALUE OF SIGMA-B FOR SPECTRUM\\
3803 BOUNDARY PHILLIPS CONSTANT\\
3804 BOUNDARY MEAN FETCH VALUE\\
3805 BOUNDARY MAXIMUM PEAK FREQUENCY\\
3806 BOUNDARY MAIN DIRECTION 1\\
3807 BOUNDARY DIRECTIONAL SPREAD 1\\
3808 BOUNDARY MAIN DIRECTION 2\\
3809 BOUNDARY DIRECTIONAL SPREAD 2\\
3810 BOUNDARY WEIGHTING FACTOR FOR ADF\\
3811 \end{CommentBlock}""",
3812     ),
3813 #   -----------------------------------
3814     BOUNDARY_ANGULAR_DISTRIBUTION_FUNCTION = SIMP(statut ='f',
3815 #   -----------------------------------
3816         typ = 'TXM',
3817         into = ["$cos{^2s}(T-T0)$, T in [T0-pi/2,T0+pi/2]","$exp(-0.5((T-T0)/s)^2)$, T in [T0-pi/2,T0+pi/2]","$cos{^2s}((T-T0)/2)$ (de type Mitsuyasu)","Goda Formula allowing a frequence dependancy"],
3818         defaut = ["$cos{^2s}(T-T0)$, T in [T0-pi/2,T0+pi/2]"],
3819         fr = """Fait partie de l ensemble des constantes utilisees dans
3820 le calcul du spectre directionnel aux limites. Permet le calcul de
3821 la fonction de repartition angulaire bimodale pour une serie de
3822 directions
3823 1 : modele en $cos{^2s}(T-T0)$ ; T dans [T0-pi/2;T0+pi/2]
3824 2 : modele en $exp(-0.5((T-T0)/s)^2)$ ; T dans [T0-pi/2;T0+pi/2]
3825 3 : modele en $cos{^2s}((T-T0)/2)$ (de type Mitsuyasu)
3826 4 : Formule de Goda : Mitsuyasu avec $s=(F/fp)^5$ or $s=(F/fp)^{-2.5}$
3827 **Mots-cles associes :**
3828 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3829         ang = """Is part of the set of constants used for computing the
3830 boundary directional spectrum. Allow the computation of the
3831 angular distribution function
3832 \begin{itemize}
3833 \item 1 : $cos^{2s}(T-T0)$ ; with T in [T0-pi/2;T0+pi/2]
3834 \item 2 : $exp(-0.5((T-T0)/s)^2)$ ; with T in [T0-pi/2;T0+pi/2]
3835 \item 3 : $cos^{2s}((T-T0)/2)$ (of type Mitsuyasu)
3836 \item 4 : Mitsuyasu with $s=(F/fp)^5$ or $s=(F/fp)^{-2.5}$
3837 \end{itemize}
3838 where $s$ is the boundary directionnal spread (\telkey{SPRE1L}
3839 or \telkey{SPRE2L})
3840 \\
3841  \begin{CommentBlock}{Related keywords}
3842 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3843 \end{CommentBlock}""",
3844     ),
3845 #   -----------------------------------
3846     BOUNDARY_SIGNIFICANT_WAVE_HEIGHT = SIMP(statut ='o',
3847 #   -----------------------------------
3848         typ = 'R',
3849         defaut = 1.,
3850         fr = """Fait partie de l ensemble des constantes utilisees dans
3851 le calcul du spectre directionnel aux limites en fonction du champ
3852 de vent.
3853 **Mots-cles associes :**
3854 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3855         ang = """Is part of the set of constants used for computing the
3856 boundary directional spectrum as a function of the wind field.
3857 \\
3858  \begin{CommentBlock}{Related keywords}
3859 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3860 \end{CommentBlock}""",
3861     ),
3862 #   -----------------------------------
3863     BOUNDARY_PEAK_FREQUENCY = SIMP(statut ='o',
3864 #   -----------------------------------
3865         typ = 'R',
3866         defaut = 0.067,
3867         fr = """Fait partie de l ensemble des constantes utilisees dans
3868 le calcul du spectre directionnel aux limites en fonction du champ
3869 de vent .
3870 **Mots-cles associes :**
3871 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3872         ang = """Is part of the set of constants used for computing the
3873 boundary directional spectrum as a function of the wind field.
3874 \\
3875  \begin{CommentBlock}{Related keywords}
3876 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3877 \end{CommentBlock}""",
3878     ),
3879 #   -----------------------------------
3880     BOUNDARY_SPECTRUM_VALUE_OF_SIGMA_A = SIMP(statut ='f',
3881 #   -----------------------------------
3882         typ = 'R',
3883         defaut = 0.07,
3884         fr = """Fait partie de l ensemble des constantes utilisees dans
3885 le calcul du spectre directionnel aux limites en fonction du champ
3886 de vent .
3887 **Mots-cles associes :**
3888 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3889         ang = """Is part of the set of constants used for computing the
3890 boundary directional spectrum as a function of the wind field.
3891 \\
3892  \begin{CommentBlock}{Related keywords}
3893 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3894 \end{CommentBlock}""",
3895     ),
3896 #   -----------------------------------
3897     BOUNDARY_SPECTRUM_VALUE_OF_SIGMA_B = SIMP(statut ='f',
3898 #   -----------------------------------
3899         typ = 'R',
3900         defaut = 0.09,
3901         fr = """Fait partie de l ensemble des constantes utilisees dans
3902 le calcul du spectre directionnel aux limites en fonction du champ
3903 de vent .
3904 **Mots-cles associes :**
3905 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3906         ang = """Is part of the set of constants used for computing the
3907 boundary directional spectrum as a function of the wind field.
3908 \\
3909  \begin{CommentBlock}{Related keywords}
3910 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3911 \end{CommentBlock}""",
3912     ),
3913 #   -----------------------------------
3914     BOUNDARY_PHILLIPS_CONSTANT = SIMP(statut ='f',
3915 #   -----------------------------------
3916         typ = 'R',
3917         defaut = 0.0081,
3918         fr = """Fait partie de l ensemble des constantes utilisees dans
3919 le calcul du spectre directionnel aux limites en fonction du champ
3920 de vent .
3921 **Mots-cles associes :**
3922 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3923         ang = """Is part of the set of constants used for computing the
3924 boundary directional spectrum as a function of the wind field.
3925 \\
3926  \begin{CommentBlock}{Related keywords}
3927 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3928 \end{CommentBlock}""",
3929     ),
3930 #   -----------------------------------
3931     BOUNDARY_MEAN_FETCH_VALUE = SIMP(statut ='o',
3932 #   -----------------------------------
3933         typ = 'R',
3934         defaut = 30000.,
3935         fr = """Fait partie de l ensemble des constantes utilisees dans
3936 le calcul du spectre directionnel aux limites en fonction du champ
3937 de vent .
3938 **Mots-cles associes :**
3939 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3940         ang = """Is part of the set of constants used for computing the
3941 boundary directional spectrum as a function of the wind field.
3942 \\
3943  \begin{CommentBlock}{Related keywords}
3944 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3945 \end{CommentBlock}""",
3946     ),
3947 #   -----------------------------------
3948     BOUNDARY_MAXIMUM_PEAK_FREQUENCY = SIMP(statut ='o',
3949 #   -----------------------------------
3950         typ = 'R',
3951         defaut = 0.2,
3952         fr = """Fait partie de l ensemble des constantes utilisees dans
3953 le calcul du spectre directionnel aux limites en fonction du champ
3954 de vent .
3955 **Mots-cles associes :**
3956 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3957         ang = """Is part of the set of constants used for computing the
3958 boundary directional spectrum as a function of the wind field.
3959 \\
3960  \begin{CommentBlock}{Related keywords}
3961 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3962 \end{CommentBlock}""",
3963     ),
3964 #   -----------------------------------
3965     BOUNDARY_MAIN_DIRECTION_1 = SIMP(statut ='o',
3966 #   -----------------------------------
3967         typ = 'R',
3968         defaut = 0.,
3969         fr = """Fait partie de l ensemble des constantes utilisees dans
3970 le calcul du spectre directionnel aux limites en fonction du champ
3971 de vent .
3972 **Mots-cles associes :**
3973 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3974         ang = """Is part of the set of constants used for computing the
3975 boundary directional spectrum as a function of the wind field.
3976 \\
3977  \begin{CommentBlock}{Related keywords}
3978 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3979 \end{CommentBlock}""",
3980     ),
3981 #   -----------------------------------
3982     BOUNDARY_DIRECTIONAL_SPREAD_1 = SIMP(statut ='o',
3983 #   -----------------------------------
3984         typ = 'R',
3985         defaut = 2.,
3986         fr = """Fait partie de l ensemble des constantes utilisees dans
3987 le calcul du spectre directionnel aux limites en fonction du champ
3988 de vent .
3989 **Mots-cles associes :**
3990 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
3991         ang = """Is part of the set of constants used for computing the
3992 boundary directional spectrum as a function of the wind field.
3993 \\
3994  \begin{CommentBlock}{Related keywords}
3995 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
3996 \end{CommentBlock}""",
3997     ),
3998 #   -----------------------------------
3999     BOUNDARY_MAIN_DIRECTION_2 = SIMP(statut ='o',
4000 #   -----------------------------------
4001         typ = 'R',
4002         defaut = 0.,
4003         fr = """Fait partie de l ensemble des constantes utilisees dans
4004 le calcul du spectre directionnel aux limites en fonction du champ
4005 de vent .
4006 **Mots-cles associes :**
4007 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
4008         ang = """Is part of the set of constants used for computing the
4009 boundary directional spectrum as a function of the wind field.
4010 \\
4011  \begin{CommentBlock}{Related keywords}
4012 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
4013 \end{CommentBlock}""",
4014     ),
4015 #   -----------------------------------
4016     BOUNDARY_DIRECTIONAL_SPREAD_2 = SIMP(statut ='o',
4017 #   -----------------------------------
4018         typ = 'R',
4019         defaut = 2.,
4020         fr = """Fait partie de l ensemble des constantes utilisees dans
4021 le calcul du spectre directionnel aux limites en fonction du champ
4022 de vent .
4023 **Mots-cles associes :**
4024 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
4025         ang = """Is part of the set of constants used for computing the
4026 boundary directional spectrum as a function of the wind field.
4027 \\
4028  \begin{CommentBlock}{Related keywords}
4029 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
4030 \end{CommentBlock}""",
4031     ),
4032 #   -----------------------------------
4033     BOUNDARY_WEIGHTING_FACTOR_FOR_ADF = SIMP(statut ='f',
4034 #   -----------------------------------
4035         typ = 'R',
4036         defaut = 1.,
4037         fr = """Fait partie de l ensemble des constantes utilisees dans
4038 le calcul du spectre directionnel aux limites en fonction du champ
4039 de vent .
4040 **Mots-cles associes :**
4041 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
4042         ang = """Is part of the set of constants used for computing the
4043 boundary directional spectrum as a function of the wind field.
4044 \\
4045  \begin{CommentBlock}{Related keywords}
4046 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
4047 \end{CommentBlock}""",
4048     ),
4049 #   -----------------------------------
4050     BOUNDARY_PEAK_FACTOR = SIMP(statut ='o',
4051 #   -----------------------------------
4052         typ = 'R',
4053         defaut = 3.3,
4054         fr = """Fait partie de l ensemble des constantes utilisees dans
4055 le calcul du spectre directionnel aux limites en fonction du champ
4056 de vent .
4057 **Mots-cles associes :**
4058 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
4059         ang = """Is part of the set of constants used for computing the
4060 boundary directional spectrum as a function of the wind field.
4061 \\
4062  \begin{CommentBlock}{Related keywords}
4063 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
4064 \end{CommentBlock}""",
4065     ),
4066 #   -----------------------------------
4067     LIMIT_SPECTRUM_MODIFIED_BY_USER = SIMP(statut ='o',
4068 #   -----------------------------------
4069         typ = bool,
4070         defaut = [False],
4071         fr = """Indique si l''utilisateur desire modifier le spectre
4072 aux limites. Il doit alors rapatrier chez lui le sous programme
4073 limwac.f dans le cas d une discretisation frequentielle du
4074 spectre et le sous programme spelim.f sinon.
4075 **Mots-cles associes :**
4076 TYPE DE SPECTRE DIRECTIONNEL AUX LIMITES""",
4077         ang = """Indicates whether the user wants to modify the boundary
4078 spectrum. He should then retrieve the limwac.f subroutine, if the
4079 spectrum is frequency discretized, or the spelim.f subroutine,
4080 otherwise.
4081 \\
4082  \begin{CommentBlock}{Related keywords}
4083 TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
4084 \end{CommentBlock}""",
4085     ),
4086 )
4087 # -----------------------------------------------------------------------
4088 TRANSPORT = PROC(nom= "TRANSPORT",op = None,
4089 # -----------------------------------------------------------------------
4090 #   -----------------------------------
4091     DIFFRACTION_PARAMETERS = FACT(statut='f',
4092 #   -----------------------------------
4093 #       -----------------------------------
4094         DIFFRACTION = SIMP(statut ='f',
4095 #       -----------------------------------
4096             typ = 'TXM',
4097             into = ["Diffraction is not taken into account","Mild Slope Equation model (Berkhoff - 1972)","Revised Mild Slope Equation model (Porter - 2003)"],
4098             defaut = ["Diffraction is not taken into account"],
4099             fr = """Choix du model pour representer la diffraction :
4100  0 : Pas de prise en compte de la diffraction
4101  1 : Mild Slope Equation de Berkhoff (1972)
4102  2 : Revised Mild Slope Equation de Porter (2003)
4103 La diffraction est modelisee suivant l approche proposee
4104 par Holthuijsen (2003)
4105 **Mots-cles associes :**
4106 PAS DE TEMPS DEBUT DIFFRACTION
4107 SEUIL DE VARIANCE CONSIDEREE POUR DIFFRACTION
4108 FILTRE POUR DIFFRACTION""",
4109             ang = """Caution : We do not guarantee the modele of diffraction.
4110 Selection of the model used to represent the diffraction :
4111 \begin{itemize}
4112 \item 0 : Diffraction is not taken into account
4113 \item  1 : Mild Slope Equation model (Berkhoff - 1972)
4114 \item  2 : Revised Mild Slope Equation model (Porter - 2003)
4115 \end{itemize}
4116 The phase-decoupled approach proposed by Holthuijsen (2003) is
4117 used to simulate diffraction in TOMAWAC
4118 \\
4119  \begin{CommentBlock}{Related keywords}
4120 STARTING TIME STEP FOR DIFFRACTION\\
4121 VARIANCE THRESHOLD FOR DIFFRACTION\\
4122 DIFFRACTION FILTER
4123 \end{CommentBlock}""",
4124         ),
4125 #       -----------------------------------
4126         STARTING_TIME_STEP_FOR_DIFFRACTION = SIMP(statut ='f',
4127 #       -----------------------------------
4128             typ = 'I',
4129             defaut = 1,
4130             fr = """Numero du pas de temps a partir duquel la diffraction est
4131 prise en compte dans la simulation.
4132 **Mots-cles associes :**
4133 DIFFRACTION
4134 SEUIL DE VARIANCE CONSIDEREE POUR DIFFRACTION
4135 FILTRE POUR DIFFRACTION""",
4136             ang = """Number of the time step from which the diffraction
4137 is taken into account until the end of the simulation.
4138 \\
4139  \begin{CommentBlock}{Related keywords}
4140 DIFFRACTION\\
4141 VARIANCE THRESHOLD FOR DIFFRACTION\\
4142 DIFFRACTION FILTER
4143 \end{CommentBlock}""",
4144         ),
4145 #       -----------------------------------
4146         VARIANCE_THRESHOLD_FOR_DIFFRACTION = SIMP(statut ='f',
4147 #       -----------------------------------
4148             typ = 'R',
4149             defaut = 1.E-12,
4150             fr = """Seuil minimum de variance spectrale pris en compte
4151 dans la diffraction
4152 **Mots-cles associes :**
4153 DIFFRACTION
4154 PAS DE TEMPS DEBUT DIFFRACTION
4155 FILTRE POUR DIFFRACTION""",
4156             ang = """Minimum spectral variance threshold taken into account
4157 when diffraction is considered
4158 \\
4159  \begin{CommentBlock}{Related keywords}
4160 DIFFRACTION\\
4161 STARTING TIME STEP FOR DIFFRACTION\\
4162 DIFFRACTION FILTER
4163 \end{CommentBlock}""",
4164         ),
4165 #       -----------------------------------
4166         OPTION_FOR_SECOND_DERIVATIVES = SIMP(statut ='f',
4167 #       -----------------------------------
4168             typ = 'I',
4169             defaut = [1],
4170             fr = """1 : methode Freemesh 2 : deux derivees simples""",
4171             ang = """1: Freemesh method 2: two simple derivatives""",
4172         ),
4173 #       -----------------------------------
4174         DIFFRACTION_FILTER = SIMP(statut ='f',
4175 #       -----------------------------------
4176             typ = bool,
4177             defaut = [False],
4178             fr = """Si la diffraction est prise en compte, le logique
4179 indique si les amplitudes calculees sont filtrees
4180 pour le calcul du parametre de diffraction et des vitesses
4181 de transfert.
4182 **Mots-cles associes :**
4183 DIFFRACTION
4184 SEUIL DE VARIANCE CONSIDEREE POUR DIFFRACTION
4185 PAS DE TEMPS DEBUT DIFFRACTION""",
4186             ang = """If diffraction is considered, the keyword indicates
4187 whether the local amplitudes of the directional spectra are
4188 filtered to compute the diffraction parameter and the transfer
4189 rates.
4190 \\
4191  \begin{CommentBlock}{Related keywords}
4192 DIFFRACTION\\
4193 VARIANCE THRESHOLD FOR DIFFRACTION\\
4194 STARTING TIME STEP FOR DIFFFRACTION
4195 \end{CommentBlock}""",
4196         ),
4197     ),
4198 )
4199 TEXTE_NEW_JDC = "\
4200 COMPUTATION_ENVIRONMENT();\
4201 GENERAL_PARAMETERS();\
4202 SOURCE_TERMS();\
4203 INITIAL_CONDITIONS();\
4204 BOUNDARY_CONDITIONS();\
4205 "
4206 Ordre_Des_Commandes = (
4207 'COMPUTATION_ENVIRONMENT',
4208 'GENERAL_PARAMETERS',
4209 'SOURCE_TERMS',
4210 'INITIAL_CONDITIONS',
4211 'INTERNAL',
4212 'BOUNDARY_CONDITIONS',
4213 'TRANSPORT')
4214 try:
4215     import TelApy
4216     source = "eficas"
4217 except Exception as excpt:
4218     source = "Telemac"
4219 enum = source+'.tomawac_enum_auto'
4220 dicoCasEn = source+'.tomawac_dicoCasEnToCata'
4221 dicoCasFr = source+'.tomawac_dicoCasFrToCata'