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