Telemac/Telemac_Cata.py

   1 # coding: utf-8
   2 # PNPNPNPN
   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 import types
  21 class Tuple:
  22   def __init__(self,ntuple):
  23     self.ntuple=ntuple
  24
  25   def __convert__(self,valeur):
  26     if type(valeur) == types.StringType:
  27       return None
  28     if len(valeur) != self.ntuple:
  29       return None
  30     return valeur
  31
  32   def info(self):
  33     return "Tuple de %s elements" % self.ntuple
  34
  35
  36
  37 JdC = JDC_CATA (code = 'MAP',
  38                 execmodul = None,
  39                 )
  40 # ======================================================================
  41 # Catalog entry for the MAP function : c_pre_interfaceBody_mesh
  42 # ======================================================================
  43
  44 # -----------------------------------------------------------------------
  45 INITIALIZATION = PROC(nom = "INITIALIZATION",op = None,
  46 # -----------------------------------------------------------------------
  47
  48      fr = "Initialisation des fichiers d'entrée et de sortie",
  49      ang = "Input and Output files initialization",
  50      #UIinfo = { "groupes" : ( "CACHE", )},
  51      UIinfo = { "groupes" : ( "iiii", )},
  52
  53 #    ------------------------------------
  54      Title = SIMP( statut = 'o',typ = 'TXM',
  55 #    ------------------------------------
  56           fr = 'Titre du cas etudie. Ce titre figurera sur les dessins.',
  57           ang = 'Title of the case being considered. This title shall be marked on the drawings.'),
  58      #Working_Directory = SIMP( statut='o',typ='Repertoire',defaut='/tmp'),
  59
  60 #    ------------------------------------
  61      Input_Files = FACT(statut='o',
  62 #    ------------------------------------
  63
  64        #  Dictionary = SIMP( statut='o', typ = ('Fichier', 'Dico (*.dico);;All Files (*)',),
  65        #                    defaut='telemac2d.dico',
  66        #                    fr='Dictionnaire des mots cles.', ang='Key word dictionary.',),
  67 # PN : le mot cle doit etre dans le dictionnaire et repris du catalogue mais n
  68 # est pas modifiable
  69
  70 #        ------------------------------------
  71          Geometry_File_Format = SIMP( statut = 'o', typ = 'TXM',
  72 #        ------------------------------------
  73              into = ['Serafin', 'MED', 'SerafinD'],
  74              defaut = 'Serafin',
  75              fr = 'Format du fichier de geometrie. Les valeurs possibles sont : \n \
  76      - SERAFIN : format standard simple precision pour Telemac;   \n \
  77      - SERAFIND: format standard double precision pour Telemac;   \n \
  78      - MED     : format MED base sur HDF5',
  79              ang = 'Results file format. Possible values are: \n\
  80      - SERAFIN : classical single precision format in Telemac;\n\
  81      - SERAFIND: classical double precision format in Telemac;\n\
  82      - MED     : MED format based on HDF5',) ,
  83
  84 #        ------------------------------------
  85          Geometry_File = SIMP( statut = 'o',
  86 #        ------------------------------------
  87              typ = ('Fichier', 'Geo Files (*.geo);;All Files (*)',),
  88              fr = 'Nom du fichier contenant le maillage du calcul a realiser.',
  89              ang = 'Name of the file containing the mesh. \n\
  90 This file may also contain the topography and the friction coefficients.'),
  91
  92           #Steering_File = SIMP( statut = 'o', typ = ('Fichier', 'Steering Files (*.cas);;All Files (*)',),),
  93
  94
  95 #        ------------------------------------
  96          Fortran_File = SIMP(statut = 'f',
  97 #        ------------------------------------
  98              typ = ('Fichier', 'Fortran files (*.f);;All Files (*)'),
  99              fr = 'Nom du fichier a soumettre',
 100              ang = 'Name of FORTRAN file to be submitted',),
 101
 102 #        ------------------------------------
 103          Bottom_Topography_File = SIMP( statut = 'f',
 104 #        ------------------------------------
 105               typ = ('Fichier', 'Geo Files (*.geo);;All Files (*)',),
 106               fr = "Nom du fichier eventuel contenant la bathymetrie associee au maillage. \
 107 Si ce mot-cle est utilise; c'est cette bathymetrie qui sera utilisee pour le calcul.",
 108               ang = 'Name of the possible file containing the bathymetric data.\
 109 Where this keyword is used, these bathymetric data shall be used in the computation.',
 110          ),
 111
 112 #        ------------------------------------
 113           Boundary_Conditions_File = SIMP( statut = 'o',
 114 #        ------------------------------------
 115               typ = ('Fichier', 'Boundary Condition (*.cli);;All Files (*)',),
 116               fr = 'Nom du fichier contenant les types de conditions aux limites. Ce fichier est rempli de facon automatique\n\
 117 par le mailleur au moyen de couleurs affectees aux noeuds des frontieres du domaine de calcul.',
 118               ang = 'Name of the file containing the types of boundary conditions. This file is filled automatically\n\
 119 by the mesh generator through through colours that are assigned to the boundary nodes.',),
 120
 121
 122 #        ------------------------------------
 123          Validation = FACT( statut = 'f',
 124 #        ------------------------------------
 125 #PNPN--> creer le Mot_clef simple Validation si ce fact existe
 126
 127 #            ------------------------------------
 128              Reference_File_Format = SIMP( statut = 'o',
 129 #            ------------------------------------
 130                  typ = 'TXM',
 131                  into = ['Serafin','MED','SerafinD'],
 132                  defaut = 'Serafin',
 133                  fr = 'Format du fichier de resultats. Les valeurs possibles sont : \n\
 134      - SERAFIN : format standard simple precision pour Telemac;  \n\
 135      - SERAFIND: format standard double precision pour Telemac; \n\
 136      - MED     : format MED base sur HDF5' ,
 137                  ang = 'Results file format. Possible values are:\n \
 138      - SERAFIN : classical single precision format in Telemac;\n\
 139      - SERAFIND: classical double precision format in Telemac; \n\
 140      - MED     : MED format based on HDF5' ,),
 141
 142 #            ------------------------------------
 143              Reference_File = SIMP( statut = 'o',
 144 #            ------------------------------------
 145                  typ = ('Fichier', 'Reference File (*.ref);;All Files (*)',),
 146                  fr = 'Fichier de resultats de reference pour la validation. Les resultats a placer dans ce fichier seront a ecrire sur le canal 22.',
 147                  ang = 'Binary-coded result file for validation. The results to be entered into this file shall be written on channel 22.',),
 148
 149          ),  # Fin de Validation
 150
 151 #        ------------------------------------
 152          Formatted_And_Binary_Files = FACT( statut = 'f',
 153 #        ------------------------------------
 154
 155 #            ------------------------------------
 156              Formatted_File1 = SIMP( statut = 'f', typ = ('Fichier', 'formated File (*.txt);;All Files (*)',),
 157 #            ------------------------------------
 158                   fr = "Fichier de donnees formate mis a la disposition de l''utilisateur.  \n\
 159 Les donnees de ce fichier seront a lire sur le canal 26.",
 160                   ang = 'Formatted data file made available to the user.\n\
 161 The data in this file shall be read on channel 26.',),
 162
 163 #            ------------------------------------
 164              Formatted_File2 = SIMP( statut = 'f', typ = ('Fichier', 'formated File (*.txt);;All Files (*)',),
 165 #            ------------------------------------
 166                   fr = "Fichier de donnees formate mis a la disposition de l'utilisateur. \n\
 167 Les donnees de ce fichier seront a lire sur le canal 27.",
 168                   ang = "Formatted data file made available to the user.\n\
 169 The data in this file shall be read on channel 27.",),
 170
 171 #            ------------------------------------
 172              Binary_Data_File1 = SIMP( statut = 'f', typ = ('Fichier', 'Reference File (*.txt);;All Files (*)',),
 173 #            ------------------------------------
 174                   fr = 'Fichier de donnees code en binaire mis a la disposition de l utilisateur. \n\
 175 Les donnees de ce fichier seront a lire sur le canal 24.',
 176                   ang = 'Binary-coded data file made available to the user.\n\
 177 The data in this file shall be read on channel 24.',),
 178
 179 #            ------------------------------------
 180              Binary_Data_File2 = SIMP( statut = 'f', typ = ('Fichier', 'Reference File (*.txt);;All Files (*)',),
 181 #            ------------------------------------
 182                   fr = 'Fichier de donnees code en binaire mis a la disposition de l utilisateur.\n\
 183 Les donnees de ce fichier seront a lire sur le canal 25.',
 184                    ang = 'Binary-coded data file made available to the user. \n\
 185 The data in this file shall be read on channel 25.',),
 186
 187          ),  # fin Formatted_And_Binary_Files
 188
 189      ), # Fin de InputFile
 190
 191
 192 #    ------------------------------------
 193      Computation_Continued = SIMP( statut = 'o',typ = bool,defaut = False),
 194 #    ------------------------------------
 195
 196 #    ------------------------------------
 197      b_comput_con = BLOC(condition = 'Computation_Continued == True',
 198      Computation_Continued_Settings = FACT(statut = 'o',
 199
 200 #        ------------------------------------
 201          Previous_Computation_File_Format = SIMP( statut = 'o',typ = 'TXM',
 202 #        ------------------------------------
 203               into = ['Serafin','MED','SerafinD'],
 204               defaut = 'Serafin',
 205               fr = 'Format du fichier de resultats du calcul precedent. Les valeurs possibles sont : \n\
 206          - SERAFIN : format standard simple precision pour Telemac;  \n\
 207          - SERAFIND: format standard double precision pour Telemac; \n\
 208          - MED     : format MED base sur HDF5',
 209               ang = 'Previous computation results file format. Possible values are: \n\
 210          - SERAFIN : classical single precision format in Telemac;  \n\
 211          - SERAFIND: classical double precision format in Telemac; \n\
 212          - MED     : MED format based on HDF5',),
 213
 214 #        ------------------------------------
 215          Previous_Computation_File = SIMP( statut = 'o',
 216 #        ------------------------------------
 217              typ = ('Fichier', 'Computation File (*.res);;All Files (*)',),
 218              fr = "Nom d'un fichier contenant les resultats d'un calcul precedent realise sur le meme maillage \n\
 219  et dont le dernier pas de temps enregistre va fournir les conditions initiales pour une suite de de calcul.",
 220              ang = 'Name of a file containing the results of an earlier computation which was made on the same mesh.\n\
 221  The last recorded time step will provid the initial conditions for the new computation.',
 222                     ),
 223 #        ------------------------------------
 224           Initial_Time_Set = SIMP(typ = bool, statut = 'o',
 225 #        ------------------------------------
 226              fr = 'Remet le temps a zero en cas de suite de calcul',
 227              ang = 'Initial time set to zero in case of restart',
 228              defaut = "False"),
 229
 230 #        ------------------------------------
 231           Record_Number_For_Restart = SIMP(typ = 'I', statut = 'o', defaut = 0,
 232 #        ------------------------------------
 233               fr = "numero de l'enregistrement de depart dans le fichier du calcul precedent. 0 signifie qu'on prend le dernier enregistrement",
 234               ang = "record number to start from in the previous computation file, 0 for last record" ),
 235
 236         ),
 237      ),# fin BLOC b_comput_con
 238
 239 #    ------------------------------------
 240      Coupling = FACT( statut = 'o',
 241 #    ------------------------------------
 242 # PNPNPN Attention 1 seul choix possible
 243         fr = 'Liste des codes avec lesquels on couple Telemac-2D',
 244         ang = 'List of codes to be coupled with Telemac-2D',
 245
 246 #        ------------------------------------
 247          Sisyphe = SIMP(statut = 'o',typ = bool,defaut = False ,
 248 #        ------------------------------------
 249              fr = 'couplage interne avec Sisyphe',
 250              ang = 'internal coupling with Sisyphe'),
 251
 252 #        ------------------------------------
 253          Tomawac = SIMP(statut = 'o',typ = bool,defaut = False,
 254 #        ------------------------------------
 255              fr = 'couplage interne avec Tomawac',
 256              ang = 'internal coupling with Tomawac'),
 257
 258 #        ------------------------------------
 259          Delwacq = SIMP(statut = 'o',typ = bool,defaut = False,
 260 #        ------------------------------------
 261              fr = 'couplage interne avec Delwacq',
 262              ang = 'internal coupling with Delwacq'),
 263 # PNPNPN Attention : il faut des mots cles si Delwacq. a voir avec Soizic
 264
 265         ), # fin Coupling
 266
 267 #    ------------------------------------
 268       Parallel_Computation = SIMP(statut = 'o',typ = 'TXM',
 269 #    ------------------------------------
 270 #    Ce mot clef n existe pas dans le dico
 271          into = ['Sequentiel','Parallel'],
 272          defaut = 'Sequentiel',),
 273
 274 #    ------------------------------------
 275       b_para = BLOC(condition = 'Parallel_Computation == "Parallel"',
 276 #    ------------------------------------
 277 #        ------------------------------------
 278          Parallel_Processors = SIMP(statut = 'o',typ = 'I',
 279 #        ------------------------------------
 280              val_min = 0,defaut = 1,
 281              fr = 'NOMBRE DE PROCESSEURS EN CALCUL PARALLELE \n\
 282 0 : 1 machine, compilation sans bibliotheque de parallelisme \n\
 283 1 : 1 machine, compilation avec bibliotheque de parallelisme \n\
 284 2 : 2 processeurs ou machines en parallele etc... ',
 285              ang = 'NUMBER OF PROCESSORS FOR PARALLEL PROCESSING \n\
 286 0 : 1 machine, compiling without parallel library \n\
 287 1 : 1 machine, compiling with a parallel library \n\
 288 2 : 2 processors or machines in parallel'),
 289          ), # fin b_para
 290
 291 )# INITIALISATION
 292
 293 # -----------------------------------------------------------------------
 294 TIDE_PARAMETERS = PROC(nom = "TIDE_PARAMETERS",op = None,
 295 # -----------------------------------------------------------------------
 296 #    ------------------------------------
 297      Inputs_Outputs_For_Tide = FACT( statut = 'o',
 298 #    ------------------------------------
 299
 300 #       ------------------------------------
 301         Harmonic_Constants_File = SIMP( statut = 'o',
 302 #       ------------------------------------
 303             typ = ('Fichier', 'All Files (*)',),
 304             fr = 'Constantes harmoniques extraites du fichier du modele de maree',
 305             ang = 'Harmonic constants extracted from the tidalmodel file',),
 306
 307 #       ------------------------------------
 308         Tidal_Model_File = SIMP( statut = 'o',
 309 #       ------------------------------------
 310             typ = ('Fichier', 'All Files (*)',),
 311             fr = 'Fichier de geometrie du modele dont sont extraites les constantes harmoniques',
 312             ang = 'Geometry file of the model from which harmonic constituents are extracted',),
 313
 314       ), # Fin Inputs_Outputs_For_Tide
 315
 316 #    ------------------------------------
 317      Location = FACT( statut = 'o',
 318 #    ------------------------------------
 319 #       ------------------------------------
 320         Geographic_System = SIMP(statut = 'o',typ = 'TXM',
 321 #       ------------------------------------
 322             into = ["Defined by user", "WGS84 longitude/latitude in real degrees", "WGS84 nothern UTM",\
 323                       "WGS84 southern UTM","Lambert", "Mercator",],
 324             defaut = "Defined by user",
 325             fr = 'Systeme de coordonnees geographiques dans lequel est construit le modele numerique.',
 326             ang = 'Geographic coordinates system in which the numerical model is built.',),
 327
 328 #       ------------------------------------
 329         Zone_number_in_Geographic_System = SIMP(statut = 'f',typ = 'TXM',
 330 #       ------------------------------------
 331             into = [ 'Lambert 1 north', 'Lambert 2 center', 'Lambert 3 xouth', \
 332                      'Lambert 4 corsica', 'Lambert 2 extended', 'UTM zone,E.G.'],
 333             fr = "Numero de zone (fuseau ou type de projection) lors de l'utilisation d'une projection plane.\n \
 334 Indiquer le systeme geographique dans lequel est construit le modele numerique avec le mot-cle SYSTEME GEOGRAPHIQUE",
 335             ang = 'Number of zone when using a plane projection. \n\
 336 Indicate the geographic system in which the numerical model is built with the keyword GEOGRAPHIC SYSTEM'),
 337 # Soizic
 338        ), # Fin Location
 339
 340 #    ------------------------------------
 341      Physical_Parameters = FACT(statut = 'o',
 342 #    ------------------------------------
 343
 344 #       ------------------------------------
 345         Tide_Generating_Force = SIMP(statut = 'o',
 346 #       ------------------------------------
 347            typ = bool, defaut = False),
 348
 349 #       ------------------------------------
 350         b_Tide = BLOC(condition = "Tide_Generating_Force == True",
 351 #       ------------------------------------
 352 #           ------------------------------------
 353             Longitude_Of_Origin_Point = SIMP(typ = 'R',
 354 #           ------------------------------------
 355                 statut = 'o', defaut = 48.,
 356                 fr = 'Fixe la valeur de la longitude du point origine du modele, lors de l utilisation de la force generatrice de la maree.',
 357                 ang = 'Give the value of the longitude of the origin point of the model, when taking into account of the tide generator force.',),
 358
 359 #           ------------------------------------
 360             Tidal_Data_Base = SIMP(statut = 'o',typ = 'TXM',
 361 #           ------------------------------------
 362 # Soizic . Il faudrait une consigne ? avec des blocs ?
 363                  into = [ "JMJ", "TPXO", "Miscellaneous (LEGOS-NEA, FES20XX, PREVIMER...)",],
 364                  fr = 'Pour JMJ, renseigner la localisation du fichier bdd_jmj et geofin dans les mots-cles BASE DE DONNEES DE MAREE \n\
 365 et FICHIER DU MODELE DE MAREE.  Pour TPXO, LEGOS-NEA, FES20XX et PREVIMER, l utilisateur doit telecharger les fichiers \n\
 366 de constantes harmoniques sur internet',
 367                  ang = 'For JMJ, indicate the location of the files bdd_jmj and geofin with keywords TIDE DATA BASE and TIDAL MODEL FILE.\n\
 368 For TPXO, LEGOS-NEA, FES20XX and PREVIMER, the user has to download files of harmonic constituents on the internet',),
 369
 370 #           ------------------------------------
 371             b_tpxo = BLOC(condition = "Tidal_Data_Base == 'TPXO'",
 372 #           ------------------------------------
 373
 374 #              ------------------------------------
 375                Minor_Constituents_Inference = SIMP( statut = 'o',typ = 'bool',
 376 #              ------------------------------------
 377 # Soizic . Il faudrait un blo avec les 2 mots clefs
 378                   defaut = False ,
 379                   fr = 'Interpolation de composantes harmoniques mineures a partir de celles lues dans les \n\
 380 fichiers d entrees lies aux mots-cles BASE BINAIRE 1 DE DONNEES DE MAREE et BASE BINAIRE 2 DE DONNEES DE MAREE',
 381                   ang = 'Inference of minor constituents from the one read in input files linked to \n\
 382 keywords BINARY DATABASE 1 FOR TIDE and BINARY DATABASE 2 FOR TIDE',),
 383
 384             ),#fin du bloc b_tpxo
 385
 386
 387 #           ------------------------------------
 388               Binary_Database_1_for_Tide = SIMP( statut = 'o',
 389 #           ------------------------------------
 390                 typ = ('Fichier', '(All Files (*),)',),
 391                 fr = 'Base de donnees binaire 1 tiree du fichier du modele de maree.\n\
 392 Dans le cas des donnees satellitaires de TPXO, ce fichier correspond aux donnees de niveau d''eau, par exemple h_tpxo7.2',
 393                 ang = 'Binary database 1 extracted from the tidal model file.\n\
 394 In the case of the TPXO satellite altimetry model, this file should be for free surface level, for instance h_tpxo7.2',),
 395
 396 #           ------------------------------------
 397               Binary_Database_2_for_Tide = SIMP( statut = 'o',
 398 #           ------------------------------------
 399                 typ = ('Fichier', '(All Files (*),)',),
 400                 fr= 'Base de donnees binaire 2 tiree du fichier du modele de maree.\n\
 401 Dans le cas des donnees satellitaires de TPXO, ce fichier correspond aux donnees de vitesse de marrees, par exemple u_tpxo7.2',
 402                 ang = 'Binary database 2 extracted from the tidal model file.\n\
 403 In the case of the TPXO satellite altimetry model, this file should be for tidal velocities, for instance u_tpxo7.2' ),
 404
 405          ), # Fin du Bloc b_Tide
 406
 407 #       ------------------------------------
 408         Wave_Driven_Currents = SIMP(statut = 'o',
 409 #       ------------------------------------
 410             typ = bool, defaut = False,
 411             fr = 'Active la prise en compte des courants de houle',
 412             ang = 'Wave driven currents are taken into account.'),
 413
 414 #       ------------------------------------
 415         b_Wave = BLOC(condition = "Wave_Driver_Currents == 'True'",
 416 #       ------------------------------------
 417 #           ------------------------------------
 418             Record_Number_in_Wave_File = SIMP(statut = 'o',typ = 'I', defaut = 1,
 419 #           ------------------------------------
 420                 fr = 'Numero d enregistrement dans le fichier des courants de houle',
 421                 ang = 'Record number to read in the wave driven currents file'),
 422         ), # fin b_Wave
 423
 424 #       ------------------------------------
 425         Option_For_Tidal_Boundary_Conditions = SIMP( statut = 'o',
 426 #       ------------------------------------
 427            typ = 'TXM', defaut = 'No tide',
 428            into = ['No tide', 'Real tide (recommended methodology)', 'Astronomical tide', \
 429                    'Mean spring tide', 'Mean tide', 'Mean neap tide', \
 430                    'Astronomical neap tide', 'Real tide (methodology before 2010)'],),
 431
 432 #       ------------------------------------
 433         b_Option_B = BLOC(condition = 'Option_For_Tidal_Boundary_Conditions!= "No tide"',
 434 #       ------------------------------------
 435 #           ------------------------------------
 436             Coefficient_To_Calibrate_Tidal_Range = SIMP(statut = 'o',
 437 #           ------------------------------------
 438                 typ = 'R', defaut = 1.,
 439                 fr = 'Coefficient pour ajuster le marnage de l''onde de maree aux frontieres maritimes',
 440                 ang = 'Coefficient to calibrate the tidal range of tidal wave at tidal open boundary conditions'),
 441
 442 #           ------------------------------------
 443             Coefficient_To_Calibrate_Tidal_Velocity = SIMP(statut = 'o',
 444 #           ------------------------------------
 445                 typ = 'R', defaut = 999999,
 446                 fr = 'Coefficient pour ajuster les composantes de vitesse de l''onde de maree aux frontieres maritimes.\n\
 447 La valeur par defaut 999999. signifie que c''est la racine carree du Coefficient_De_Calage_Du_Marnage qui est prise',
 448                 ang = 'Coefficient to calibrate the tidal velocities of tidal wave at tidal open boundary conditions.\n\
 449                 Default value 999999. means that the square root of Coefficient_To_Calibrate_Tidal_Range is taken'),
 450
 451 #           ------------------------------------
 452               Coefficient_To_Calibrate_Sea_Level = SIMP(statut = 'o',typ = 'R',
 453 #           ------------------------------------
 454                  defaut = 0.,
 455                  fr = 'Coefficient pour ajuster le niveau de mer',
 456                  ang = 'Coefficient to calibrate the sea level'),
 457           ), # fin b_Option_B
 458
 459        ), #fin Physical_Parameters
 460 ) # Fin TIDE_PARAMETERS
 461
 462 # -----------------------------------------------------------------------
 463 INITIAL_STATE = PROC(nom = "INITIAL_STATE",op = None,
 464 # -----------------------------------------------------------------------
 465
 466 #    ------------------------------------
 467      Initial_Conditions = SIMP(statut = 'o',typ = 'TXM',
 468 #    ------------------------------------
 469           into = ['Zero elevation','Constant elevation','Zero depth','Constant depth','Special','TPXO satellite altimetry'],
 470           defaut = 'Zero elevation',
 471           fr = "Permet de definir les conditions initiales sur les hauteurs d'eau. Les valeurs possibles sont :\n\
 472     - COTE NULLE. Initialise la cote de surface libre a 0. \nLes hauteurs d'eau initiales sont alors retrouvees en faisant la difference entre les cotes de surface libre et du fond. \n\
 473     - COTE CONSTANTE . Initialise la cote de surface libre a la valeur donnee par le mot-cle COTE INITIALE. Les hauteurs d'eau initiales sont calculees comme precedemment.\n\
 474    - HAUTEUR NULLE .Initialise les hauteurs d'eau a 0. \n\
 475    - HAUTEUR CONSTANTE. Initialise les hauteurs d'eau a la valeur donnee par le mot-cle HAUTEUR INITIALE. \n\
 476    - PARTICULIERES. Les conditions initiales sur la hauteur d'eau doivent etre precisees dans le sous-programme CONDIN. \n\
 477    - ALTIMETRIE SATELLITE TPXO. Les conditions initiales sur la hauteur  d'eau et les vitesses sont etablies sur \n\
 478       la base des donnees satellite TPXO dont les 8 premiers constistuents ont ete extraits et sauves dans le fichier\n\
 479       BASE DE DONNEES DE MAREE." ,
 480          ang = 'Makes it possible to define the initial conditions with the water depth. The possible values are : \n\
 481    - ZERO ELEVATION. Initializes the free surface elevation to 0. \n The initial water depths are then found by computing the difference between the free surface and the bottom.  \n\
 482    - CONSTANT ELEVATION. Initializes the water elevation to the value given by the keyword \n\
 483    - INITIAL ELEVATION. The initial water depths are computed as in the previous case. \n\
 484    - ZERO DEPTH. Initializes the water depths to 0. \n\
 485    - CONSTANT DEPTH. Initializes the water depths to the value givenby the key-word  INITIAL DEPTH. \n\
 486    - SPECIAL. The initial conditions with the water depth should be stated in the CONDIN subroutine. \n\
 487    - TPXO SATELITE ALTIMETRY. The initial conditions on the free surface and velocities are established from the TPXO satellite program data,\n the harmonic constituents of which are stored in the TIDE DATA BASE file.', ),
 488
 489 #    ------------------------------------
 490      b_initial_elevation = BLOC (condition = "Initial_Conditions == 'Constant elevation'",
 491 #    ------------------------------------
 492 #        ------------------------------------
 493          Initial_Elevation = SIMP(statut = 'o',typ = 'R',
 494 #        ------------------------------------
 495              fr = 'Valeur utilisee avec l''option :  CONDITIONS INITIALES - COTE CONSTANTE',
 496              ang = 'Value to be used with the option : INITIAL CONDITIONS  -CONSTANT ELEVATION' ),
 497      ) , # fin b_initial_elevation
 498
 499 #    ------------------------------------
 500      b_initial_depth = BLOC (condition = "Initial_Conditions == 'Constant depth'",
 501 #    ------------------------------------
 502 #        ------------------------------------
 503          Initial_Depth = SIMP(statut = 'o',typ = 'R',
 504 #        ------------------------------------
 505              fr = 'Valeur utilisee avec l''option : CONDITIONS INITIALES :-HAUTEUR CONSTANTE-',
 506              ang = 'Value to be used along with the option: INITIAL CONDITIONS -CONSTANT DEPTH-' ),
 507          ),# fin b_initial_depth
 508
 509 #    ------------------------------------
 510      b_special = BLOC (condition = "Initial_Conditions == 'Special'",
 511 #    ------------------------------------
 512 #        ------------------------------------
 513          Consigne = SIMP(statut = "o",homo = 'information',typ = "TXM",
 514 #        ------------------------------------
 515              defaut = "The initial conditions with the water depth should be stated in the CONDIN subroutine"),
 516       ), # fin b_special
 517
 518 #PNPN il faut changer la condition pour que cela soit dans maree. il faut une position = global_jdc et remonter # cela
 519 #    ------------------------------------
 520      b_initial_TPXO = BLOC (condition = "Initial_Conditions == 'TPXO satellite altimetry'",
 521 #    ------------------------------------
 522 #        ------------------------------------
 523          Ascii_Database_For_Tide = SIMP( statut = 'o',
 524 #        ------------------------------------
 525              typ = ('Fichier', 'All Files (*)',),
 526              fr = 'Base de donnees de constantes harmoniques tirees du fichier du modele de maree',
 527              ang = 'Tide data base of harmonic constituents extracted from the tidal model file',),
 528          ), # fin b_initial_TPXO
 529
 530 ) # fin INITIAL_STATE
 531
 532 # -----------------------------------------------------------------------
 533 BOUNDARY_CONDITIONS = PROC(nom = "BOUNDARY_CONDITIONS",op = None,
 534 # -----------------------------------------------------------------------
 535             fr = 'On donne un ensemble de conditions par frontiere liquide',
 536             ang = 'One condition set per liquid boundary is given',
 537             #UIinfo = { "groupes" : ( "CACHE", )},
 538             UIinfo = { "groupes" : ( "iiii", )},
 539  # Dans l ideal il faut aller regarder selon les groupes dans le fichier med
 540  # en sortie il faut aller chercher le .cli qui va bien
 541             #Liquid_Boundaries = FACT(statut = 'f',max = '**',
 542             #    Options = SIMP(statut = 'f',typ = 'I',into = ['classical boundary conditions','Thompson method based on characteristics'])
 543             #    Prescribed_Flowrates = SIMP(statut = 'f',typ = 'R'),
 544             #    Prescribed_Elevations = SIMP(statut = 'f',typ = 'R'),
 545             #    Prescribed_Velocity = SIMP(statut = 'f',typ = 'R'),
 546       # ),
 547
 548 # Il va falloir une "traduction dans le langage du dico"
 549 # Il faut seulement l un des 3
 550
 551 #    ------------------------------------
 552      Liquid_Boundaries = FACT(statut = 'f',max = '**',
 553 #    ------------------------------------
 554
 555 #        ------------------------------------
 556          Options = SIMP(statut = 'f',typ = 'I',
 557 #        ------------------------------------
 558             into = ['Classical boundary conditions','Thompson method based on characteristics'],
 559             fr = 'On donne 1 entier par frontiere liquide',
 560             ang = 'One integer per liquid boundary is given',),
 561
 562 #        ------------------------------------
 563          Type_Condition = SIMP(statut = 'o',typ = 'TXM',
 564 # On ajoute le type pour rendre l 'ihm plus lisible
 565 # mais ce mot-cle n existe pas dans le dico
 566 #        ------------------------------------
 567             into = ['Prescribed flowrates', 'Prescribed elevations', 'Prescribed velocity'],),
 568
 569 #        ------------------------------------
 570          b_Flowrates = BLOC (condition = "Type_Condition == 'Prescribed Flowrates'",
 571 #        ------------------------------------
 572 #            ------------------------------------
 573              Prescribed_Flowrates = SIMP(statut = 'o',
 574 #            ------------------------------------
 575                   typ = 'R',
 576                   fr = ' Valeurs des debits imposes aux frontieres liquides entrantes.\n\
 577 Lire la partie du mode d''emploi consacree aux conditions aux limites',
 578                   ang = 'Values of prescribed flowrates at the inflow boundaries.\n\
 579 The section about boundary conditions is to be read in the manual'),
 580              ), # fin b_Flowrates
 581
 582 #        ------------------------------------
 583          b_Elevations = BLOC (condition = "Type_Condition == 'Prescribed Elevations'",
 584 #        ------------------------------------
 585 #            ------------------------------------
 586              Prescribed_Elevations = SIMP(statut = 'o',typ = 'R',
 587 #            ------------------------------------
 588                  fr = 'Valeurs des cotes imposees aux frontieres liquides entrantes.\n\
 589 Lire la partie du mode d''emploi consacree aux conditions aux limites',
 590                  ang = 'Values of prescribed elevations at the inflow boundaries.\n\
 591 The section about boundary conditions is to be read in the manual'),
 592              ), # fin b_Elevations
 593
 594 #        ------------------------------------
 595          b_Velocity = BLOC (condition = "Type_Condition == 'Prescribed Velocity'",
 596 #        ------------------------------------
 597 #            ------------------------------------
 598              Prescribed_Velocity = SIMP(statut = 'o',typ = 'R',
 599 #            ------------------------------------
 600                  fr = 'Valeurs des vitesses imposees aux frontieres liquides entrantes.\n\
 601 Lire la partie du mode d''emploi consacree aux conditions aux limites',
 602                  ang = 'Values of prescribed velocities at the liquid inflow boundaries.\n\
 603 Refer to the section dealing with the boundary conditions'),
 604              ), # fin b_Velocity
 605
 606        ), # fin des Liquid_Boundaries
 607
 608 #      ------------------------------------
 609        Liquid_Boundaries_File = SIMP( statut = 'f',
 610 #      ------------------------------------
 611          typ = ('Fichier', 'All Files (*)',),
 612          fr = 'Fichier de variations en temps des conditions aux limites.\n\
 613 Les donnees de ce fichier seront a lire sur le canal 12.',
 614          ang = 'Variations in time of boundary conditions. Data of this file are read on channel 12.',
 615       ),
 616
 617
 618 #PNPN Attention dans le Dico STAGE-DISCHARGE CURVES
 619 #PNPN regarder le document de reference pour changer non programme
 620 #      ------------------------------------
 621        Stage_Discharge_Curves = SIMP(statut = 'f',typ = 'TXM',
 622 #      ------------------------------------
 623            into = ["No one","Z(Q)","Q(Z)"],
 624            fr = 'Indique si une courbe de tarage doit etre utilisee pour une frontiere',
 625            ang = 'Says if a discharge-elevation curve must be used for a given boundary',),
 626
 627 #      ------------------------------------
 628        b_discharge_curve = BLOC (condition = "Stage_Discharge_Curves != 'no'",
 629 #      ------------------------------------
 630 #            ------------------------------------
 631              Stage_Discharge_Curves_Files = SIMP( statut = 'f',
 632 #            ------------------------------------
 633                 typ = ('Fichier', 'All Files (*)',),
 634                 fr = 'Nom du fichier contenant les courbes de tarage',
 635                 ang = 'Name of the file containing stage-discharge curves',),
 636         ), # fin b_discharge_curve
 637
 638 #      ------------------------------------
 639        Elements_Masked_By_User = SIMP(statut = 'o',typ = bool,
 640 #      ------------------------------------
 641            defaut = False,
 642            fr = 'Si oui remplir le sous-programme maskob',
 643            ang = 'if yes rewrite subroutine maskob',),
 644
 645 #      ------------------------------------
 646       maskob = BLOC (condition = 'Elements_Masked_By_User == True',
 647 #      ------------------------------------
 648 #            ------------------------------------
 649               Consigne = SIMP(statut = "o",homo = 'information',typ = "TXM",
 650 #            ------------------------------------
 651               defaut = "Remplir le sous-programme maskob"),
 652       ) # fin maskob
 653
 654 ) # fin Boundary_Conditions
 655
 656 # -----------------------------------------------------------------------
 657 NUMERICAL_PARAMETERS = PROC(nom = "NUMERICAL_PARAMETERS",op = None,
 658 # -----------------------------------------------------------------------
 659
 660         #UIinfo = { "groupes" : ( "CACHE", )},
 661         UIinfo = { "groupes" : ( "iiii", )},
 662 #      ------------------------------------
 663        Solver_Definition = FACT(statut = 'o',
 664 #      ------------------------------------
 665
 666 #         ------------------------------------
 667           Equations = SIMP(statut = 'o',typ = 'TXM',
 668 #         ------------------------------------
 669              into = ['Saint-Venant EF','Saint-Venant VF','Boussinesq'],
 670              defaut = 'Saint-Venant EF',
 671              fr = 'Choix des equations a resoudre',
 672              ang = 'Choice of equations to solve',),
 673
 674 #         ------------------------------------
 675           Solver = SIMP(statut = 'o',typ = 'TXM',
 676 #         ------------------------------------
 677              into = ["Conjugate gradient", "Conjugate residual","Conjugate gradient on a normal equation",\
 678                      "Minimum error", "CGSTAB", "GMRES", "Direct",],
 679              fr = 'Permet de choisir le solveur utilise pour la resolution de l''etape de propagation. \n\
 680 Toutes les methodes proposees actuellement s''apparentent au Gradient Conjugue. Ce sont :\n\
 681   1 : gradient conjugue 2 : residu conjugue       3 : gradient conjugue sur equation normale \n\
 682   4 : erreur minimale   5 : gradient conjugue carre (non programme) 6 : gradient conjugue carre stabilise (cgstab)\n\
 683   7 : gmres (voir aussi option du solveur) 8 : direct',
 684              ang = 'Makes it possible to select the solver used for solving the propagation step.\n\
 685 All the currently available methods are variations of the Conjugate Gradient method. They are as follows: \n\
 686 1: conjugate gradient 2: conjugate residual 3: conjugate gradient on a normal equation\n\
 687 4: minimum error 5: conjugate gradient squared (not implemented) 6: conjugate gradient squared stabilised (cgstab) \n\
 688 7: gmres (see option for solver) 8: direct',),
 689
 690 #         ------------------------------------
 691           b_gmres = BLOC (condition = "Solver == 'GMRES'",
 692 #         ------------------------------------
 693 #            ------------------------------------
 694              Solver_Option = SIMP(statut = 'o',typ = 'I', defaut = 2, val_min = 2,val_max = 15,
 695 #            ------------------------------------
 696                  fr = 'la dimension de l''espace de KRILOV',
 697                  ang = 'dimension of the KRYLOV space',),
 698           ), # fin b_gmres
 699
 700 #         ------------------------------------
 701           Solver_Accuracy = SIMP(statut = 'o',typ = 'R', defaut = 1e-4,
 702 #         ------------------------------------
 703              fr = 'Precision demandee pour la resolution de l''etape de propagation (cf.  Note de principe).',
 704              ang = 'Required accuracy for solving the propagation step (refer to Principle note).',),
 705
 706 #         ------------------------------------
 707           Maximum_Number_Of_Iterations_For_Solver = SIMP(statut = 'o',typ = 'I', defaut = 40,
 708 #         ------------------------------------
 709              fr = 'Les algorithmes utilises pour la resolution de l''etape de propagation etant iteratifs, \n\
 710 il est necessaire de limiter le nombre d''iterations autorisees.\n\
 711 Remarque : un maximum de 40 iterations par pas de temps semble raisonnable.',
 712              ang = 'Since the algorithms used for solving the propagation step are iterative, \
 713 the allowed number of iterations should be limited.\n\
 714 Note: a maximum number of 40 iterations per time step seems to be reasonable.',),
 715
 716        ), # fin Solver
 717
 718 #      ------------------------------------
 719        Time = FACT(statut = 'o',
 720 #      ------------------------------------
 721        regles = (AU_MOINS_UN('Number_Of_Time_Steps','Duration'),
 722                  EXCLUS('Number_Of_Time_Steps','Duration'),
 723                ),
 724
 725 #          ------------------------------------
 726            Time_Step = SIMP(statut = 'o',
 727 #          ------------------------------------
 728               typ = 'R', defaut = 1,
 729               fr = 'Definit le nombre de pas de temps effectues lors de l''execution du code.',
 730               ang = 'Specifies the number of time steps performed when running the code.'),
 731
 732 #          ------------------------------------
 733            Number_Of_Time_Steps = SIMP(statut = 'f',typ = 'I',
 734 #          ------------------------------------
 735               fr = 'Definit le nombre de pas de temps effectues lors de l''execution du code.',
 736               ang = 'Specifies the number of time steps performed when running the code.'),
 737
 738 #          ------------------------------------
 739            Duration = SIMP(statut = 'f',typ = 'R',
 740 #          ------------------------------------
 741               fr = 'duree de la simulation. alternative au parametre nombre de pas de temps. \n\
 742 On en deduit le nombre de pas de temps en prenant l''entier le plus proche de (duree du calcul/pas de temps).\n\
 743 Si le nombre de pas de temps est aussi donne, on prend la plus grande valeur',
 744               ang = 'duration of simulation. May be used instead of the parameter NUMBER OF TIME STEPS. \n\
 745 The nearest integer to (duration/time step) is taken.  If NUMBER OF TIME STEPS is also given, the greater value is taken',),
 746
 747 # PNPN pour Soizic
 748 #          ------------------------------------
 749            Variable_Time_Step = SIMP(statut = 'f',typ = bool,
 750 #          ------------------------------------
 751               fr = 'Pas de temps variable pour avoir un nombre de courant souhaite',
 752               ang = 'Variable time-step to get a given Courant number'),
 753
 754 #          ------------------------------------
 755            b_var_time = BLOC(condition = "Variable_Time_Step == True" ,
 756 #          ------------------------------------
 757 #            ------------------------------------
 758              Desired_Courant_Number = SIMP(statut = 'o',typ = 'R',
 759 #            ------------------------------------
 760              fr = 'Nombre de Courant souhaite ',
 761              ang = 'Desired Courant number',),
 762            ),
 763
 764 #          ------------------------------------
 765            Original_Date_Of_Time = FACT( statut = 'o',
 766 #          ------------------------------------
 767               fr = "Permet de fixer la date d'origine des temps du modele lors de la prise en compte de la force generatrice de la maree.",
 768               ang = 'Give the date of the time origin of the model when taking into account the tide generating force.',
 769                Year = SIMP(statut = 'o',typ = 'I',val_min = 1900, defaut = 1900),
 770                Month = SIMP(statut = 'o',typ = 'I',val_min = 1,val_max = 12,  defaut = 1),
 771                Day = SIMP(statut = 'o',typ = 'I',val_min = 1,val_max = 31,defaut = 1),),
 772
 773 #          ------------------------------------
 774            Original_Hour_Of_Time = FACT( statut = 'o',
 775 #          ------------------------------------
 776                fr = "Permet de fixer l'heure d'origine des temps du modele lors de la prise en compte de la force generatrice de la maree.",
 777                ang = 'Give the time of the time origin of the model when taking into account the tide generating force.',
 778                Hour = SIMP(statut = 'o',typ = 'I',val_min = 0,val_max = 24, defaut = 0),
 779                Minute = SIMP(statut = 'o',typ = 'I',val_min = 0,val_max = 60, defaut = 0),
 780                Second = SIMP(statut = 'o',typ = 'I',val_min = 0,val_max = 60, defaut = 0),
 781              ),
 782
 783 #          ------------------------------------
 784            Stop_If_A_Steady_State_Is_Reached = SIMP(statut = 'o',
 785 #          ------------------------------------
 786                typ = bool,defaut = 'False'),
 787
 788 #          ------------------------------------
 789            b_stop = BLOC(condition = "Stop_If_A_Steady_State_Is_Reached == True" ,
 790 #          ------------------------------------
 791 #              ------------------------------------
 792                Stop_Criteria = SIMP(statut = 'o',typ = Tuple(3),validators = VerifTypeTuple(('R','R','R')),
 793 #              ------------------------------------
 794                  fr = "Criteres d'arret pour un ecoulement permanent. ces coefficients sont respectivement appliques a\n\
 795     1- U et V 2- H 3- T ",
 796                  ang = 'Stop criteria for a steady state These coefficients are applied respectively to\n\
 797         1- U and V 2- H 3-  T ',),
 798            ), # fin b_stop
 799
 800 #          ------------------------------------
 801            Control_Of_Limit = SIMP(statut = 'o',
 802 #          ------------------------------------
 803                typ = bool, defaut = 'False',
 804                fr = 'Le programme s''arrete si les limites sur u,v,h ou t sont depassees',
 805                ang = 'The program is stopped if the limits on u,v,h, or t are trespassed',),
 806
 807 #          ------------------------------------
 808            b_limit = BLOC(condition = "Control_Of_Limit == True" ,
 809            Limit_Values = FACT(statut = 'o',
 810 #          ------------------------------------
 811                 fr = 'valeurs mini et maxi acceptables  min puis  max',
 812                 ang = 'min and max acceptable values ',
 813
 814 #              ------------------------------------
 815                Limit_Values_H = SIMP(statut = 'o',typ = Tuple(2),
 816 #              ------------------------------------
 817                     validators = VerifTypeTuple(('R','R')), defaut = (-1000,9000)),
 818 #              ------------------------------------
 819                Limit_Values_U = SIMP(statut = 'o',typ = Tuple(2),
 820 #              ------------------------------------
 821                     validators = VerifTypeTuple(('R','R')), defaut = (-1000,1000)),
 822 #              ------------------------------------
 823                Limit_Values_V = SIMP(statut = 'o',typ = Tuple(2),
 824 #              ------------------------------------
 825                     validators = VerifTypeTuple(('R','R')), defaut = (-1000,1000)),
 826 #              ------------------------------------
 827                Limit_Values_T = SIMP(statut = 'o',typ = Tuple(2),
 828 #              ------------------------------------
 829                     validators = VerifTypeTuple(('R','R')), defaut = (-1000,1000)),
 830             ),), # fin Fact et b_limit
 831        ), # Fin de Time
 832
 833 #      ------------------------------------
 834        Linearity = FACT(statut = 'f',
 835 #      ------------------------------------
 836 #          ------------------------------------
 837            Continuity_Correction = SIMP(typ = bool, statut = 'o',
 838 #          ------------------------------------
 839              defaut = False,
 840              fr = 'Corrige les vitesses sur les points avec hauteur imposee ou l equation de continuite n a pas ete resolue',
 841              ang = 'Correction of the velocities on points with a prescribed elevation, where the continuity equation has not been solved',),
 842
 843 #          ------------------------------------
 844            Number_Of_Sub_Iterations_For_Non_Linearity = SIMP(statut = 'o',typ = 'I',
 845 #          ------------------------------------
 846              defaut = 1,
 847              fr = 'Permet de reactualiser, pour un meme pas de temps, les champs convecteur et propagateur \n\
 848 au cours de plusieurs sous-iterations.\n\
 849 A la premiere sous-iteration, ces champs sont donnes par C et le champ de vitesses au pas de temps precedent.\n\
 850 Aux iterations suivantes, ils sont pris egaux au champ de vitesse obtenu a la fin de la sous-iteration precedente. \n\
 851 Cette technique permet d''ameliorer la prise en compte des non linearites.',
 852             ang = 'Used for updating, within one time step, the advection and propagation field.\n\
 853 upon the first sub-iteration, \n\
 854 these fields are given by C and the velocity field in the previous time step. At subsequent iterations, \n\
 855 the results of the previous sub-iteration is used to update the advection and propagation field.\n\
 856 The non-linearities can be taken into account through this technique.',),
 857
 858      ), # Fin Linearity
 859
 860 #      ------------------------------------
 861        Precondionning_setting = FACT(statut = 'f',
 862 #      ------------------------------------
 863
 864 #         ------------------------------------
 865           Preconditionning = SIMP(statut = 'o',typ = 'TXM',
 866 #         ------------------------------------
 867 # PNPN Soizic ? Est ce que c'est une liste
 868 # Comment fait-on  le into est faux : voir l aide
 869 # PN Je propose qu 'on puisse faire +sieurs choix et qu on recalcule en sortie
 870 # ou on propose des choix croisés parce que toutes les combinaisons ne sont pas possibles ?
 871 #
 872               into = [ "Diagonal", "No preconditioning", "Diagonal condensee", "Crout", \
 873                      "Gauss-Seidel", "Diagonal and Crout", "Diagonal condensed and Crout"],
 874               defaut="Diagonal",
 875               fr='Permet de preconditionner le systeme de l etape de propagation afin d accelerer la convergence \n\
 876 lors de sa resolution. Certains preconditionnements sont cumulables : (les diagonaux 2 ou 3 avec les autres)\n\
 877 Pour cette raison on ne retient que les nombres premiers pour designer les preconditionnements. Si l on souhaite en cumuler\n\
 878 plusieurs on formera le produit des options correspondantes.',
 879              ang='Choice of the preconditioning in the propagation step linear system that the convergence is speeded up\n\
 880 when it is being solved.Some operations (either 2 or 3 diagonal preconditioning) can be performed concurrently with the others.\n\
 881 Only prime numbers are therefore kept to denote the preconditioning operations. When several of them are to be performed concurrently,\n\
 882 the product of relevant options shall be made.',
 883           ),
 884 #         ------------------------------------
 885           C_U_Preconditionning = SIMP(typ = bool, statut = 'o', defaut=False,
 886 #         ------------------------------------
 887              fr = 'Changement de variable de H en C dans le systeme lineaire final',
 888              ang = 'Change of variable from H to C in the final linear system'
 889            ),
 890
 891    ),# fin Preconditionnement
 892
 893 #    ------------------------------------
 894      Matrix_Informations = FACT(statut = 'f',
 895 #    ------------------------------------
 896 #         ------------------------------------
 897           Matrix_Vector_Product = SIMP(statut = 'f',typ = 'TXM',
 898 #         ------------------------------------
 899              into = ["Classic", "Frontal"],
 900              fr = 'attention, si frontal, il faut une numerotation speciale des points',
 901              ang = 'beware, with option 2, a special numbering of points is required',
 902           ),
 903 #         ------------------------------------
 904           Matrix_Storage = SIMP(statut = 'f',typ = 'TXM',
 905 #         ------------------------------------
 906              into = ["Classical EBE","Edge-based storage",]
 907           ),
 908      ),# fin Matrix_Informations
 909
 910
 911 #    ------------------------------------
 912      Advection = FACT(statut = 'o',
 913 #    ------------------------------------
 914
 915 #         ------------------------------------
 916           Advection_Propagation = FACT(statut = 'o',
 917 #         ------------------------------------
 918
 919 # PNPNPN recalcul
 920 # Tres differents du dico  liste de 4
 921 # PNPN eclaircir les choix SVP
 922 # soizic. choix 3 et 4 et 13 et 14
 923 #             ------------------------------------
 924               Advection_Of_U_And_V = SIMP(statut = 'o',typ = bool, defaut = False,
 925 #             ------------------------------------
 926                   fr = 'Prise en compte ou non de la convection de U et V.',
 927                   ang = 'The advection of U and V is taken into account or ignored.'),
 928
 929 #                 ------------------------------------
 930                   b_u_v = BLOC( condition = "Advection_Of_U_And_V == True",
 931 #                  ------------------------------------
 932 #                      ------------------------------------
 933                        Type_Of_Advection_U_And_V = SIMP(statut = 'o',typ = 'TXM',position = "global",
 934 #                      ------------------------------------
 935                            into = ["Characteristics", "SUPG", "Conservative N-scheme",  'Conservative N-scheme',\
 936                            'Conservative PSI-scheme', 'Non conservative PSI scheme', 'Implicit non conservative N scheme',\
 937                            'Edge-based N-scheme'],
 938                              defaut = "Characteristics", ),
 939
 940 #                      ------------------------------------
 941                        b_upwind = BLOC(condition = "Type_Of_Advection_U_And_V == 'SUPG'",
 942 #                      ------------------------------------
 943 #                          ------------------------------------
 944                            Upwind_Coefficients_Of_U_And_V = SIMP(statut = 'o',typ = 'R', defaut = 1.)
 945 #                          ------------------------------------
 946                         ), # fin b_upwind
 947                   ),# fin b_u_v
 948
 949 #              ------------------------------------
 950                Advection_Of_H = SIMP(statut = 'o',typ = bool, defaut = False,
 951 #              ------------------------------------
 952                       fr = 'Prise en compte ou non de la convection de H.',
 953                       ang = 'The advection of H is taken into account or ignored.'),
 954
 955 #                  ------------------------------------
 956                    b_h = BLOC( condition = "Advection_Of_H == True",
 957 #                  ------------------------------------
 958 #                      ------------------------------------
 959                        Type_Of_Advection_H = SIMP(statut = 'o',typ = 'TXM',position = "global",
 960 #                      ------------------------------------
 961                            into = ["characteristics", "SUPG", "conservative N-scheme",  'conservative N-scheme',\
 962                               'conservative PSI-scheme', 'non conservative PSI scheme', 'implicit non conservative N scheme',\
 963                               'edge-based N-scheme'],
 964                            defaut = "conservative PSI-scheme",),
 965 #                      ------------------------------------
 966                        b_upwind_H = BLOC(condition = "Type_Of_Advection_H == 'SUPG'",
 967 #                      ------------------------------------
 968 #                          ------------------------------------
 969                            Upwind_Coefficients_Of_H = SIMP(statut = 'o',typ = 'R', defaut = 1.)
 970 #                          ------------------------------------
 971                        ), # fin b_upwind_H
 972                     ),# fin b_h
 973
 974 #              ------------------------------------
 975                Advection_Of_K_And_Epsilon = SIMP(statut = 'o',typ = bool, defaut = False,
 976 #              ------------------------------------
 977                     fr = 'Prise en compte ou non de la convection de Tracer.',
 978                     ang = 'The advection of Tracer is taken into account or ignored.'),
 979
 980 #                  ------------------------------------
 981                    b_k = BLOC( condition = "Advection_Of_K_And_Epsilon == True",
 982 #                  ------------------------------------
 983 #                      ------------------------------------
 984                        Type_Of_Advection_K_And_Epsilon = SIMP(statut = 'o',typ = 'TXM',position = "global",
 985 #                      ------------------------------------
 986                            into = ["Characteristics", "SUPG", "Conservative N-scheme",  'Conservative N-scheme',\
 987                               'Conservative PSI-scheme', 'Non conservative PSI scheme', 'Implicit non conservative N scheme',\
 988                               'Edge-based N-scheme'],
 989                            defaut = "Characteristics",),
 990 #                       ------------------------------------
 991                         b_upwind_k = BLOC(condition = "Type_Of_Advection_K_And_Epsilon == 'SUPG'",
 992 #                       ------------------------------------
 993 #                          ------------------------------------
 994                            Upwind_Coefficients_Of_K_And_Epsilon = SIMP(statut = 'o',typ = 'R', defaut = 1.)
 995 #                          ------------------------------------
 996                          ),# fin b_upwind_k
 997                    ),# fin b_k
 998
 999 #              ------------------------------------
1000                Advection_Of_Tracers = SIMP(statut = 'o',typ = bool, defaut = False,
1001 #              ------------------------------------
1002                     fr = 'Prise en compte ou non de la convection de Tracer.',
1003                     ang = 'The advection of Tracer is taken into account or ignored.'),
1004
1005 #                  ------------------------------------
1006                    b_tracers = BLOC( condition = "Advection_Of_Tracers == True",
1007 #                  ------------------------------------
1008 #                      ------------------------------------
1009                        Type_Of_Advection_Tracers = SIMP(statut = 'o',typ = 'TXM',position = "global",
1010 #                      ------------------------------------
1011                            into = ["Characteristics", "SUPG", "Conservative N-scheme",  'Conservative N-scheme',\
1012                                 'Conservative PSI-scheme', 'Non conservative PSI scheme', 'Implicit non conservative N scheme',\
1013                                 'Edge-based N-scheme'],),
1014 #                       ------------------------------------
1015                         b_upwind_Tracers = BLOC(condition = "Type_Of_Advection_Tracers == 'SUPG'",
1016 #                       ------------------------------------
1017 #                          ------------------------------------
1018                            Upwind_Coefficients_Of_Tracers = SIMP(statut = 'o',typ = 'R', defaut = 1.)
1019 #                          ------------------------------------
1020                         ), # fin b_upwind_Tracers
1021                     ), # fin b_Tracers
1022
1023 #              ------------------------------------
1024                b_max = BLOC( condition = "(Advection_Of_Tracers == True and Type_Of_Advection_Tracers == 'Edge-based N-scheme') or (Advection_Of_K_And_Epsilon == True and Type_Of_Advection_K_And_Epsilon == 'Edge-based N-scheme') or (Advection_Of_U_And_V == True and Type_Of_Advection_U_And_V == 'Edge-based N-scheme') or ( Advection_Of_H == True and Type_Of_Advection_H == 'Edge-based N-scheme')",
1025 #              ------------------------------------
1026 #                  ------------------------------------
1027                    Maximum_Number_Of_Iterations_For_Advection_Schemes = SIMP( statut = 'o',typ = 'I', defaut = 10 ,
1028 #                  ------------------------------------
1029                        fr = 'Seulement pour schemes Edge-based N-scheme',
1030                        ang = 'Only for Edge-based N-scheme',),
1031                 ), # fin b_max
1032         ), # Fin Advection_Propagation
1033
1034 #         ------------------------------------
1035           Scheme_For_Advection_Of_K_Epsilon = SIMP(statut = 'o',typ = 'TXM',
1036 #         ------------------------------------
1037                into = ["No advection", "Characteristics", "Explicit + SUPG", "Explicit leo postma", "Explicit + murd scheme N", "Explicit + murd scheme PSI", "Leo postma for tidal flats", "N-scheme for tidal flats"],
1038                fr = 'Choix du schema de convection pour k et epsilon, remplace FORME DE LA CONVECTION',
1039                ang = 'Choice of the advection scheme for k and epsilon, replaces TYPE OF ADVECTION',),
1040
1041
1042 #PNPNPN
1043 # recalculer la liste de 4
1044 # Attention bloc selon le type de convection
1045 #         ------------------------------------
1046           SUPG = FACT(statut = 'o',
1047 #         ------------------------------------
1048 #             ------------------------------------
1049               Supg_Option_U_And_V = SIMP(statut = 'o', defaut = 'Modified SUPG', typ = 'TXM',
1050 #             ------------------------------------
1051                        into = ['No upwinding', 'Classical SUPG','Modified SUPG']),
1052 #             ------------------------------------
1053               Supg_Option_H = SIMP(statut = 'o', defaut = 'Modified SUPG', typ = 'TXM',
1054 #             ------------------------------------
1055                        into = ['No upwinding', 'Classical SUPG','Modified SUPG']),
1056 #             ------------------------------------
1057               Supg_Option_Tracers = SIMP(statut = 'o', defaut = 'Modified SUPG', typ = 'TXM',
1058 #             ------------------------------------
1059                        into = ['No upwinding', 'Classical SUPG','Modified SUPG']),
1060 #             ------------------------------------
1061               Supg_Option_K_and_Epsilon = SIMP(statut = 'o', defaut = 'Modified SUPG', typ = 'TXM',
1062 #             ------------------------------------
1063                        into = ['No upwinding', 'Classical SUPG','Modified SUPG']),
1064             ), # Fin de SUPG
1065
1066 #         ------------------------------------
1067           Mass_Lumping_On_H = SIMP(statut = 'o',typ = 'R', defaut = 0,
1068 #         ------------------------------------
1069             fr = 'TELEMAC offre la possibilite d''effectuer du mass-lumping sur H ou U.\n\
1070 Ceci revient a ramener tout ou partie (suivant la valeur de ce coefficient) des matrices AM1 (h) ou AM2 (U) \n\
1071 et AM3 (V) sur leur diagonale.  Cette technique permet d''accelerer le code dans des proportions tres\n\
1072 importantes et de le rendre egalement beaucoup plus stable. Cependant les solutions obtenues se trouvent lissees.\n\
1073 Ce parametre fixe le taux de mass-lumping effectue sur h.',
1074             ang = 'TELEMAC provides an opportunity to carry out mass-lumping either on C,H or on the velocity. \n\
1075 This is equivalent to bringing the matrices AM1(h) or AM2(U) and AM3(V) wholly or partly, back onto their diagonal.\n\
1076 Thanks to that technique, the code can be speeded up to a quite significant extent and it can also be made much \n\
1077 more stable. The resulting solutions, however, become artificially smoothed. \n\
1078 This parameter sets the extent of mass-lumping that is performed on h.'),
1079
1080 #         ------------------------------------
1081           Mass_Lumping_On_Velocity = SIMP(statut = 'o', typ = 'R', defaut = 0,
1082 #         ------------------------------------
1083             fr = 'Fixe le taux de mass-lumping effectue sur la vitesse.',
1084             ang = 'Sets the amount of mass-lumping that is performed on the velocity.'),
1085
1086 #         ------------------------------------
1087           Treatment_Of_The_Linear_System = SIMP(statut = 'o', typ = 'TXM',
1088 #         ------------------------------------
1089               into = ["Coupled", "Wave equation"],
1090               defaut = "Coupled",),
1091
1092 #         ------------------------------------
1093           Free_Surface_Gradient_Compatibility = SIMP(statut = 'o',typ = 'R',defaut = 1.,
1094 #         ------------------------------------
1095             fr = 'Des valeurs inferieures a 1 suppriment les oscillations parasites',
1096             ang = 'Values less than 1 suppress spurious oscillations'),
1097
1098
1099      ), # fin Advection
1100
1101 #PNPNPN Il faut recalculer le MCSIM Propagation
1102 #    ------------------------------------
1103      Propagation = FACT(statut = 'o',
1104 #    ------------------------------------
1105
1106 #         ------------------------------------
1107           Linearized_Propagation = SIMP(statut = 'o',typ = bool,defaut = False,
1108 #         ------------------------------------
1109              fr = 'Permet de lineariser l''etape de propagation; \n\
1110 par exemple lors de la realisation de cas tests pour lesquels on dispose d une solution analytique dans le cas linearise.',
1111              ang = 'Provided for linearizing the propagation step; \n\
1112 e.g. when performing test-cases for which an analytical solution in the linearized case is available.' ),
1113
1114 #         ------------------------------------
1115           b_linear = BLOC(condition = "Linearized_Propagation == True ",
1116 #         ------------------------------------
1117 #             ------------------------------------
1118               Mean_Depth_For_Linearity = SIMP(statut = 'o',typ = 'R', defaut = 0.0, val_min = 0,
1119 #             ------------------------------------
1120                fr = 'Fixe la hauteur d eau autour de laquelle s effectue la linearisation lorsque l option PROPAGATION LINEARISEE est choisie.',
1121                ang = 'Sets the water depth about which the linearization is made when the LINEARIZED PROPAGATION OPTION is selected.'),
1122           ), # fin b_linear
1123
1124 #         ------------------------------------
1125           Initial_Guess_for_H = SIMP(statut = 'o',typ = 'TXM',
1126 #         ------------------------------------
1127               into = ['Zero', 'Previous', 'Extrapolation'],
1128               defaut = 'Previous',
1129               fr = 'Tir initial du solveur de l etape de propagation.  Offre la possibilite de modifier la valeur initiale de DH,\n\
1130 accroissement de H, a chaque iteration, dans l etape de propagation en utilisant les valeurs finales de cette variable \n\
1131 aux pas de temps precedents. Ceci peut permettre daccelerer la vitesse de convergence lors de la resolution du systeme.',
1132               ang = 'Initial guess for the solver in the propagation step.  Makes it possible to modify the initial value of H, \n\
1133 upon each iteration in the propagation step, by using the ultimate values this variable had in the earlier time steps.\n\
1134 Thus, the convergence can be speeded up when the system is being solved.',),
1135
1136 #         ------------------------------------
1137           Initial_Guess_for_U = SIMP(statut = 'o',typ = 'TXM',
1138 #         ------------------------------------
1139               into = ['Zero', 'Previous', 'Extrapolation'],
1140               defaut = 'Previous',
1141               fr = 'Tir initial du solveur de l etape de propagation.  Offre la possibilite de modifier la valeur initiale de DH,\n\
1142 accroissement de U, a chaque iteration, dans l etape de propagation en utilisant les valeurs finales de cette variable \n\
1143 aux pas de temps precedents. Ceci peut permettre daccelerer la vitesse de convergence lors de la resolution du systeme.',
1144                ang = 'Initial guess for the solver in the propagation step.  Makes it possible to modify the initial value of U, \n\
1145 upon each iteration in the propagation step, by using the ultimate values this variable had in the earlier time steps.\n\
1146 Thus, the convergence can be speeded up when the system is being solved.',),
1147
1148       ), # fin Propagation
1149
1150 #    ------------------------------------
1151      Discretisation_Implicitation = FACT(statut = 'f',
1152 #    ------------------------------------
1153
1154 #         ------------------------------------
1155           Discretisations_In_Space = SIMP(statut = 'o',typ = 'TXM',
1156 #         ------------------------------------
1157               into = ["Linear", "Quasi-bubble", "Quadratic"],
1158               defaut = "Linear",),
1159
1160 #         ------------------------------------
1161           Implicitation_For_Depth = SIMP(statut = 'o',typ = 'R',defaut = 0.55,
1162 #         ------------------------------------
1163               fr = 'Fixe la valeur du coefficient d''implicitation sur C dans l''etape de propagation (cf.  Note de principe).\n\
1164 Les valeurs inferieures a 0.5 donnent un schema instable.',
1165              ang = 'Sets the value of the implicitation coefficient for C (the celerity of waves) in the propagation step (refer to principle note).\n\
1166 Values below 0.5 result in an unstable scheme.'),
1167
1168 #         ------------------------------------
1169           Implicitation_for_Velocity = SIMP(statut = 'o',typ = 'R',defaut = 0.55,
1170 #         ------------------------------------
1171              fr = 'Fixe la valeur du coefficient d''implicitation sur la vitesse dans l''etape de propagation (cf.  Note de principe).\n\
1172 Les valeurs inferieures a 0.5 donnent un schema instable.',
1173              ang = 'Sets the value of the implicitation coefficient for velocity in the propagation step (refer to principle note).\n\
1174 Values below 0.5 result in an unstable condition.'),
1175
1176 #         ------------------------------------
1177           Implicitation_For_Diffusion_Of_Velocity = SIMP(statut = 'o',typ = 'R',defaut = 0,
1178 #         ------------------------------------
1179             fr = 'Fixe la valeur du coefficient d''implicitation sur les termes de diffusion des vitesses',
1180             ang = 'Sets the value of the implicitation coefficient for the diffusion of velocity',),
1181
1182       ), # fin Discretisation_Implicitation
1183
1184
1185 #    ------------------------------------
1186      Tidal_Flats = SIMP(statut = 'o',typ = bool,defaut = True,
1187 #    ------------------------------------
1188          fr = 'permet de supprimer les tests sur les bancs decouvrants si on est certain qu''il n''y en aura pas, En cas de doute : oui',
1189          ang = 'When no,the specific treatments for tidal flats are by-passed. This spares time, but of course you must be sure that you have no tidal flats'),
1190
1191 #    ------------------------------------
1192      b_tidal_flats = BLOC(condition = 'Tidal_Flats == True',
1193 #    ------------------------------------
1194 #         ------------------------------------
1195           Option_For_The_Treatment_Of_Tidal_Flats = SIMP(statut = 'o',typ = 'TXM',
1196 #         ------------------------------------
1197              into = ["Equations solved everywhere with correction on tidal flats", "Dry elements frozen", "1 but with porosity (defina method)",],
1198              defaut="Equations solved everywhere with correction on tidal flats",),
1199
1200 #             ------------------------------------
1201               b_option_tidal_flats = BLOC(condition = 'Option_For_The_Treatment_Of_Tidal_Flats == "Equations solved everywhere with correction on tidal flats"',
1202 #             ------------------------------------
1203 #                 ------------------------------------
1204                   Treatment_Of_Negative_Depths = SIMP( statut = 'o',typ = 'TXM',
1205 #                 ------------------------------------
1206                      into = [ 'No treatment', 'Smoothing', 'Flux control'],
1207                      defaut = 'Smoothing' ,),
1208               ), # fin bloc b_option_tidal_flats
1209
1210 #         ------------------------------------
1211           Threshold_For_Negative_Depths = SIMP( statut = 'o',typ = 'R', defaut = 0.0 ,
1212 #         ------------------------------------
1213              fr = 'En dessous du seuil, les hauteurs negatives sont lissees',
1214              ang = 'Below the threshold the negative depths are smoothed',),
1215
1216 #         ------------------------------------
1217           H_Clipping = SIMP(statut = 'o',typ = bool,defaut = False,
1218 #         ------------------------------------
1219              fr = 'Determine si on desire ou non limiter par valeur inferieure la hauteur d eau H (dans le cas des bancs decouvrants par exemple).',
1220              ang = 'Determines whether limiting the water depth H by a lower value desirable or not. (for instance in the case of tidal flats)\n\
1221 This key-word may have an influence on mass conservation since the truncation of depth is equivalent to adding mass.',),
1222
1223 #             ------------------------------------
1224               b_clipping = BLOC(condition = 'H_Clipping == True',
1225 #             ------------------------------------
1226 #                 ------------------------------------
1227                   Minimum_Value_Of_Depth = SIMP( statut = 'o',typ = 'R', defaut = 0.0 ,
1228 #                 ------------------------------------
1229                       fr = 'Fixe la valeur minimale de a lorsque loption CLIPPING DE H est activee.',
1230                       ang = 'Sets the minimum H value when option H CLIPPING is implemented. Not fully implemented.',),
1231               ), # fin b_clipping
1232     ), # fin bloc b_tidal_flats
1233
1234 #    ------------------------------------
1235      Various = FACT(
1236 #    ------------------------------------
1237 #         ------------------------------------
1238           Finite_Volume_Scheme = SIMP( statut = 'o',typ = 'TXM',
1239 #         ------------------------------------
1240               into = [ "Roe scheme", "Kinetic order 1", "Kinetic order 2", "Zokagoa scheme order 1",\
1241                      "Tchamen scheme order 1", "HLLC scheme order 1", "WAF scheme order 2"],
1242               defaut = "Kinetic order 1",),
1243
1244 #         ------------------------------------
1245          Newmark_Time_Integration_Coefficient = SIMP( statut = 'o',typ = 'TXM',
1246 #         ------------------------------------
1247              defaut = "Euler explicite",
1248              into = ["Euler explicite","Order 2 in time"],),
1249
1250 #         ------------------------------------
1251           Option_For_Characteristics = SIMP( statut = 'o',typ = 'TXM',
1252 #         ------------------------------------
1253             defaut = "Strong" ,
1254             into = ['Strong','Weak',],),
1255
1256      ),# fin Various
1257
1258 #    ------------------------------------
1259      Mass_Lumping_For_Weak_Characteristics = SIMP(statut = 'f',typ = 'R',defaut = 0,
1260 #    ------------------------------------
1261         fr = 'Applique a la matrice de masse',
1262         ang = 'To be applied to the mass matrix',
1263      ),
1264
1265 )# fin NUMERICAL_PARAMETERS
1266
1267 # -----------------------------------------------------------------------
1268 PHYSICAL_PARAMETERS = PROC(nom = "PHYSICAL_PARAMETERS",op = None,
1269 # -----------------------------------------------------------------------
1270 #    ------------------------------------
1271      Atmosphere = FACT(statut = 'o',
1272 #    ------------------------------------
1273
1274 #         ------------------------------------
1275           Wind = SIMP(statut = 'o',typ = bool,defaut = False,
1276 #         ------------------------------------
1277              fr = 'Prise en compte ou non des effets du vent.',
1278              ang = 'Determines whether the wind effects are to be taken into account or not.'),
1279
1280 #         ------------------------------------
1281           b_Wind = BLOC(condition = "Wind == True",
1282 #         ------------------------------------
1283 #             ------------------------------------
1284               Wind_Velocity_along_X = SIMP(statut = 'o',typ = 'R', defaut = 0.,
1285 #             ------------------------------------
1286                  fr = 'Composante de la vitesse du vent suivant l''axe des x (m/s).',
1287                  ang = 'Wind velocity, component along x axis (m/s).',),
1288
1289 #             ------------------------------------
1290               Wind_Velocity_along_Y = SIMP(statut = 'o',typ = 'R',defaut = 0.,
1291 #             ------------------------------------
1292                  fr = 'Composante de la vitesse du vent suivant l''axe des y (m/s).',
1293                  ang = 'Wind velocity, component along y axis (m/s).',),
1294
1295 #             ------------------------------------
1296               Threashold_Depth_for_Wind = SIMP(statut = 'o',typ = 'R',defaut = 0.,
1297 #             ------------------------------------
1298                  fr = 'Retire la force due au vent dans les petites profondeurs',
1299                  ang = 'Wind is not taken into account for small depths' ),
1300
1301 #             ------------------------------------
1302               Coefficient_Of_Wind_Influence = SIMP( statut = 'o',typ = 'R', defaut = 0.0 ,
1303 #             ------------------------------------
1304                  fr = 'Fixe la valeur du coefficient d entrainement du vent (cf.  Note de principe).',
1305                  ang = 'Sets the value of the wind driving coefficient.  Refer to principle note.',),
1306
1307 #             ------------------------------------
1308               Option_For_Wind = SIMP( statut = 'o',typ = 'TXM', defaut = 0 ,
1309 #             ------------------------------------
1310                  into = ["No wind","Constant in time and space","Variable in time","Variable in time and space"],
1311                  fr = 'donne les options pour introduire le vent',
1312                  ang = 'gives option for managing the wind'),
1313
1314 #             ------------------------------------
1315               file_for_wind = BLOC (condition = 'Option_For_Wind == "Variable in time" or Option_For_Wind == "Variable in time and space"',
1316 #             ------------------------------------
1317 #                  ------------------------------------
1318                    Consigne = SIMP(statut = "o",homo = 'information',typ = "TXM",
1319 #                  ------------------------------------
1320                           defaut = "give formated file 3"),
1321               ), # fin bloc file_for_wind
1322
1323 #             ------------------------------------
1324               speed_for_wind = BLOC (condition = 'Option_For_Wind == "Constant in time and space"',
1325 #             ------------------------------------
1326 #                  ------------------------------------
1327                    Speed_And_Direction_Of_Wind = SIMP( statut = 'o', defaut = (0.0, 0.0) ,
1328 #                  ------------------------------------
1329                       typ = Tuple(2),validators = VerifTypeTuple(('R','R')),
1330                       fr = 'Donne la vitesse et la direction (en degres de 0 a 360, 0 etant y = 0 et x = +inf) du vent',
1331                       ang = 'gives the speed and direction (degre (from 0 to 360), 0 given y = 0 anx x = +infinity)',),
1332               ), # speed_for_wind
1333
1334           ), # fin b_Wind
1335
1336 #         ------------------------------------
1337           Air_Pressure = SIMP(statut = 'o',typ = bool, defaut = False,
1338 #         ------------------------------------
1339                 fr = 'Permet de decider si l''on prend ou non en compte l''influence d''un champ de pression.',
1340                 ang = 'Provided to decide whether the influence of an atmosphere field is taken into account or not.'),
1341
1342 #         ------------------------------------
1343           b_air = BLOC(condition = "Air_Pressure == True",
1344 #         ------------------------------------
1345 #              ------------------------------------
1346                Value_Of_Atmospheric_Pressure = SIMP( statut = 'o',typ = 'R',
1347 #              ------------------------------------
1348                   defaut = 100000.0 ,
1349                   fr = 'donne la valeur de la pression atmospherique lorsquelle est constante en temps et en espace',
1350                   ang = 'gives the value of atmospheric pressure when it is contant in time and space',),
1351            ), # fin b_air
1352
1353 #         ------------------------------------
1354           Rain_or_Evaporation = SIMP(statut = 'o',typ = bool,
1355 #         ------------------------------------
1356               defaut = False,
1357               fr  = 'Pour ajouter un apport ou une perte d''eau en surface.',
1358               ang = 'to add or remove water at the free surface. ',),
1359
1360 #         -----------------------------------
1361           b_Rain = BLOC(condition = "Rain_or_Evaporation == True",
1362 #         ------------------------------------
1363 #              ------------------------------------
1364                Rain_or_Evaporation_in_mm_perday = SIMP(statut = 'o',typ = 'I',defaut = 0.),
1365 #              ------------------------------------
1366           ), # fin b_Rain
1367
1368     ), # fin atmosphere
1369
1370 #    ------------------------------------
1371      Friction_Data = SIMP(statut = 'o',typ = bool,defaut = False),
1372 #    ------------------------------------
1373 #    ------------------------------------
1374      b_Friction = BLOC(condition = "Friction_Data == True",
1375      Friction_Setting = FACT(statut = 'o',
1376 #    ------------------------------------
1377 #         ------------------------------------
1378           Friction_Data_File = SIMP( statut = 'o',
1379 #         ------------------------------------
1380                typ = ('Fichier', ';;All Files (*)'),
1381                fr = 'fichier de donnees pour le frottement',
1382                ang = 'friction data file',),
1383
1384 #         ------------------------------------
1385           Depth_In_Friction_Terms = SIMP( statut = 'o',typ = 'TXM',
1386 #         ------------------------------------
1387                defaut = "Nodal" ,
1388                into = ("Nodal", "Average"),),
1389
1390 #         ------------------------------------
1391           Law_Of_Bottom_Friction = SIMP( statut = 'o',typ = 'TXM',
1392 #         ------------------------------------
1393                defaut = 'No friction' ,
1394                into = ('No friction', 'Haaland', 'Chezy', 'Strickler', 'Manning', 'Nikuradse','Log law','Colebrooke_white'),
1395                fr = 'selectionne le type de formulation utilisee pour le calcul du frottement sur le fond.',
1396                ang = 'Selects the type of formulation used for the bottom friction.',),
1397
1398 #              ------------------------------------
1399                b_Law_Friction = BLOC(condition = "Law_Of_Bottom_Friction!= 'No friction'",
1400 #              ------------------------------------
1401 #                  ------------------------------------
1402                    Friction_Coefficient = SIMP( statut = 'o',typ = 'R',
1403 #                  ------------------------------------
1404                          defaut = 50.0 ,
1405                          fr = 'Fixe la valeur du coefficient de frottement pour la formulation choisie.  \
1406 Attention, la signification de ce chiffre varie suivant la formule choisie : \
1407 1 : coefficient lineaire 2 : coefficient de Chezy 3 : coefficient de Strickler \
1408 4 : coefficient de Manning 5 : hauteur de rugosite de Nikuradse',
1409                          ang = 'Sets the value of the friction coefficient for the selected formulation. \
1410 It is noteworthy that the meaning of this figure changes according to the selected formula (Chezy, Strickler, etc.) : \
1411 1 : linear coefficient 2 : Chezy coefficient 3 : Strickler coefficient 4 : Manning coefficient 5 : Nikuradse grain size',),
1412               ), # Fin b_Law_Friction
1413
1414 #              ------------------------------------
1415                b_Colebrooke_White = BLOC(condition = "Law_Of_Bottom_Friction == 'Colebrooke_white'",
1416 #              ------------------------------------
1417 #                  ------------------------------------
1418                    Manning_Default_Value_For_Colebrook_white_Law = SIMP( statut = 'o',typ = 'R',
1419 #                  ------------------------------------
1420                        defaut = 0.02 ,
1421                        fr = 'valeur par defaut du manning pour la loi de frottement de  Colebrook-White ',
1422                        ang = 'Manning default value for the friction law of Colebrook-White ',),
1423                ), # Fin b_Colebrooke_White
1424
1425 #         ------------------------------------
1426           Non_submerged_Vegetation_Friction = SIMP( statut = 'o',typ = bool,
1427 #         ------------------------------------
1428               defaut = False ,
1429               fr = 'calcul du frottement du a la vegetation non submergee',
1430               ang = 'friction calculation of the non-submerged vegetation',),
1431
1432 #              ------------------------------------
1433                b_Non_Sub = BLOC(condition = ' Non_submerged_Vegetation_Friction == True',
1434 #              ------------------------------------
1435 #                  ------------------------------------
1436                    Diameter_Of_Roughness_Elements = SIMP( statut = 'o',typ = 'R',
1437 #                  ------------------------------------
1438                        defaut = 0.006 ,
1439                        fr = 'diametre des elements de frottements',
1440                        ang = 'diameter of roughness element',),
1441
1442 #                  ------------------------------------
1443                    Spacing_Of_Roughness_Elements = SIMP( statut = 'o',typ = 'R',
1444 #                  ------------------------------------
1445                       defaut = 0.14 ,
1446                       fr = 'espacement des elements de frottement',
1447                       ang = 'spacing of rouhness element',),
1448             ), # Fin b_Non_Sub
1449
1450 #         ------------------------------------
1451           Law_Of_Friction_On_Lateral_Boundaries = SIMP( statut = 'o',typ = 'TXM',
1452 #         ------------------------------------
1453               defaut = "No friction" ,
1454               into = ("No friction", "Haaland", "Chezy", "Strickler",  "Manning", "Nikuradse", "Log law", "Colebrook-white"),
1455               fr = 'selectionne le type de formulation utilisee pour le calcul du frottement sur les parois laterales.',
1456               ang = 'Selects the type of formulation used for the friction on lateral boundaries.',),
1457
1458 # PNPNPN soizic ?Ne faut-il pas un bloc sur Law_Of_Friction_On_Lateral_Boundaries
1459 #         ------------------------------------
1460           Roughness_Coefficient_Of_Boundaries = SIMP( statut = 'o',typ = 'R',
1461 #         ------------------------------------
1462               defaut = 100.0 ,
1463               fr = 'Fixe la valeur du coefficient de frottement sur les frontieres solides avec un regime turbulent rugueux\n\
1464  sur les bords du domaine.  meme convention que pour le coefficient de frottement',
1465              ang = 'Sets the value of the friction coefficient of the solid boundary with the bed roughness option. Same meaning than friction coefficient',),
1466
1467 #         ------------------------------------
1468           Maximum_Number_Of_Friction_Domains = SIMP( statut = 'o',typ = 'I',
1469 #         ------------------------------------
1470               defaut = 10 ,
1471               fr = 'nombre maximal de zones pouvant etre definies pour le frottement. Peut etre augmente si necessaire',
1472               ang = 'maximal number of zones defined for the friction.  Could be increased if needed',),
1473
1474 #         ------------------------------------
1475           Bottom_Smoothings = SIMP( statut = 'o',typ = 'I', defaut = 0 ,
1476 #         ------------------------------------
1477               fr = 'Nombre de lissages effectues sur la topographie.  chaque lissage, effectue a l aide dune matrice de masse, est conservatif.\n\
1478 Utilise lorsque les donnees de bathymetrie donnent des resultats trop irreguliers apres interpolation.',
1479               ang = 'Number of smoothings on bottom topography.  each smoothing is mass conservative.  \n\
1480 to be used when interpolation of bathymetry on the mesh gives very rough results.',),
1481
1482 #         ------------------------------------
1483           Threshold_Depth_For_Receding_Procedure = SIMP(statut = 'o',typ = 'R',defaut = 0 ,
1484 #         ------------------------------------
1485               fr = 'Si > 0., declenche la procedure de ressuyage qui evite le franchissement parasite des digues mal discretisees',
1486              ang = 'If > 0., will trigger the receding procedure that avoids overwhelming of dykes which are too loosely discretised ',),
1487
1488      ), # fin du fact Friction
1489      ), # Fin du bloc Friction
1490
1491
1492 #    ------------------------------------
1493      Parameter_Estimation = FACT(statut = 'f',
1494 #    ------------------------------------
1495 #         ------------------------------------
1496           Parameter_Estimation = SIMP( statut = 'o',typ = 'TXM', into = ["Friction","Frottement","Steady"],
1497 #         ------------------------------------
1498                fr = 'Liste des parametres a estimer',
1499                ang = 'List of parameter to be estimated',),
1500
1501 #         ------------------------------------
1502           Definition_Of_Zones = SIMP(typ = bool, statut = 'o', defaut = False,
1503 #         ------------------------------------
1504                fr = 'Declenche l''appel a def_zones, pour donner un numero de zone a chaque point',
1505                ang = 'Triggers the call to def_zones to give a zone number to every point',),
1506
1507 #              ------------------------------------
1508                b_def_zone = BLOC (condition = 'Definition_Of_Zones == True',
1509 #              ------------------------------------
1510 #                  ------------------------------------
1511                    Consigne = SIMP(statut = "o",homo = 'information',typ = "TXM", defaut = "complete DEF_ZONES subroutine"),
1512 #                  ------------------------------------
1513                ), # fin b_def_zone
1514
1515 #         ------------------------------------
1516           Identification_Method = SIMP( statut = 'o',typ = 'TXM',
1517 #         ------------------------------------
1518                into = ["List of tests", "Gradient simple", "Conj gradient", "Lagrange interp."],
1519                defaut = 'GRadient simple',),
1520
1521 #         ------------------------------------
1522           Maximum_Number_Of_Iterations_For_Identification = SIMP(statut = 'o',typ = 'I',defaut = 20,
1523 #         ------------------------------------
1524               fr = 'chaque iteration comprend au moins un calcul direct et un calcul adjoint',
1525               ang = 'every iteration implies at least a direct and an adjoint computation', ),
1526
1527 #         ------------------------------------
1528           Cost_Function = SIMP(statut = "f",typ = 'TXM',
1529 #         ------------------------------------
1530               defaut = 'Computed with h, u , v',
1531               into = ['Computed with h, u , v', 'Computed with c, u , v'],),
1532
1533 #         ------------------------------------
1534          Tolerances_For_Identification = FACT( statut = 'o',
1535 #         ------------------------------------
1536 # PNPNPN recalculer en liste de 4 reels
1537 #             ------------------------------------
1538               Tolerance_sur_H = SIMP( statut = 'o',typ = 'R', defaut=1.E-3,
1539 #             ------------------------------------
1540                    fr  = "precision absolue sur H",
1541                    ang = "absolute precision on H",),
1542 #             ------------------------------------
1543               Tolerance_sur_U = SIMP( statut = 'o',typ = 'R', defaut=1.E-3,
1544 #             ------------------------------------
1545                    fr  = "precision absolue sur U",
1546                    ang = "absolute precision on U",),
1547 #             ------------------------------------
1548               Tolerance_sur_V = SIMP( statut = 'o',typ = 'R', defaut=1.E-3,
1549 #             ------------------------------------
1550                    fr  = "precision absolue sur V",
1551                    ang = "absolute precision on V",),
1552 #             ------------------------------------
1553               Tolerance_sur_cout = SIMP( statut = 'o',typ = 'R', defaut=1.E-4,
1554 #             ------------------------------------
1555                    fr  = "precision relative sur la fonction cout",
1556                    ang = "relative precision on the cost function",),
1557                 ),# fin Tolerances_For_Identification
1558
1559       ), #  fin fact Parameter_Estimation
1560
1561 #    ------------------------------------
1562      Number_Of_Sources = SIMP( statut = 'o',typ = 'I', defaut = 0 ,),
1563 #    ------------------------------------
1564 # Attention a la sortie a reformatter. voir page 68 du user manuel V7
1565
1566 #       ------------------------------------
1567         sources_exists = BLOC(condition = "Number_Of_Sources!= 0",
1568 #       ------------------------------------
1569
1570 #           ------------------------------------
1571             Sources_File = SIMP( statut = 'o',
1572 #           ------------------------------------
1573                 typ = ('Fichier', 'All Files (*)',),
1574                 fr = 'Nom du fichier contenant les informations variables en temps des sources',
1575                 ang = 'Name of the file containing time-dependent information on sources',),
1576
1577 #PNPNPNPN saisir autant de source que le nombre
1578 #           ------------------------------------
1579             Source = FACT(statut = 'o',
1580 #           ------------------------------------
1581                  max = "**",
1582 #               ------------------------------------
1583                 Abscissae_Of_Sources = SIMP( statut = 'o',
1584 #               ------------------------------------
1585                     typ = Tuple(2),validators = VerifTypeTuple(('R','R')),
1586                     fr = 'Valeurs des abscisses des sources de debit et de traceur.',
1587                     ang = 'abscissae of sources of flowrate and/or tracer',),
1588
1589 #               ------------------------------------
1590                 Ordinates_Of_Sources = SIMP( statut = 'o',
1591 #               ------------------------------------
1592                    typ = Tuple(2),validators = VerifTypeTuple(('R','R')),
1593                    fr = 'Valeurs des ordonnees des sources de debit et de traceur.',
1594                    ang = 'ordinates of sources of flowrate and/or tracer',),
1595
1596 #               ------------------------------------
1597                 Water_Discharge_Of_Sources = SIMP( statut = 'o',
1598 #               ------------------------------------
1599                    typ = Tuple(2),validators = VerifTypeTuple(('R','R')),
1600                    fr = 'Valeurs des debits des sources.',
1601                    ang = 'values of water discharge of sources',),
1602
1603 #               ------------------------------------
1604                 Velocities_Of_The_Sources_Along_X = SIMP( statut = 'f',
1605 #               ------------------------------------
1606                    typ = Tuple(2),validators = VerifTypeTuple(('R','R')),
1607                    fr = 'Vitesses du courant a chacune des sources. Si elles ne sont pas donnees, on considere que la vitesse est celle du courant',
1608                    ang = 'Velocities at the sources. If they are not given, the velocity of the flow at this location is taken',),
1609
1610 #               ------------------------------------
1611                 Velocities_Of_The_Sources_Along_Y = SIMP( statut = 'f',
1612 #               ------------------------------------
1613                    typ = Tuple(2),validators = VerifTypeTuple(('R','R')),
1614                    fr = 'Vitesses du courant a chacune des sources',
1615                    ang = 'Velocities at the sources',),
1616
1617         ), # Fin du Fact Source
1618
1619 #           ------------------------------------
1620             Type_Of_Sources = SIMP(statut = 'o',typ = 'TXM',into = ["Normal","Dirac"],
1621 #           ------------------------------------
1622                    fr = 'Source portee par une base elements finis  Source portee  par une fonction de Dirac',
1623                    ang = 'Source term multiplied by a finite element basis,  Source term multiplied by a Dirac function',),
1624
1625     ),#fin bloc source - exits
1626
1627 #  ------------------------------------
1628     Water_Density = SIMP(statut = 'o',typ = 'R',defaut = 1000.,
1629 #  ------------------------------------
1630          fr = 'Fixe la valeur de la masse volumique de l eau.',
1631          ang = 'set the value of water density',
1632     ),
1633
1634 #  ------------------------------------
1635     Gravity_Acceleration = SIMP(statut = 'o',typ = 'R',defaut = 9.81,
1636 #  ------------------------------------
1637         fr = 'Fixe la valeur de l acceleration de la pesanteur.',
1638         ang = 'Set the value of the acceleration due to gravity.',
1639       ),
1640
1641 )# fin PHYSICAL_PARAMETERS
1642
1643 # -----------------------------------------------------------------------
1644 POST_PROCESSING = PROC(nom = "POST_PROCESSING",op = None,
1645 # -----------------------------------------------------------------------
1646
1647 #  ------------------------------------
1648    Graphic_Printouts = FACT(statut = 'f',
1649 #  ------------------------------------
1650 #       ------------------------------------
1651         Variables_For_Graphic_Printouts = SIMP(statut = 'o',max = "**", typ = 'TXM',
1652 #       ------------------------------------
1653                 into=[ "Velocity along X axis  (m/s)", "Velocity along Y axis  (m/s)", "Wave celerity  (m/s)", "Water depth  (m)",
1654                       "Free surface elevation  (m)", "Bottom elevation  (m)", "Froude number  ", "Scalar flowrate of fluid  (m2/s)",
1655                       "Tracer 1 etc. ", "Turbulent kinetic energy in K-Epsilon model  (J/kg)", "Dissipation of turbulent energy  (W/kg)",
1656                       "Turbulent viscosity of K-Epsilon model  (m2/s)", "Flowrate along X axis  (m2/s)", "Flowrate along Y axis  (m2/s)",
1657                       "Scalar velocity  (m/s)", "Wind along X axis  (m/s)", "Wind along Y axis  (m/s)", "Air pressure  (Pa)",
1658                       "Friction coefficient", "Drift along X  (m)", "Drift along Y  (m)", "Courant number ", "Supplementary variable N ",
1659                       "Supplementary variable O ", "Supplementary variable R ", "Supplementary variable Z  ", "Maximum elevation",
1660                       "Time of maximum elevation ", "Maximum velocity", "Time of maximum velocity", "Friction velocity  "],),
1661
1662 #       ------------------------------------
1663         Graphic_Printout_Period = SIMP(statut = 'o', typ = 'I',defaut = 1,
1664 #       ------------------------------------
1665                     fr = 'Determine la periode en nombre de pas de temps d''impression des VARIABLES POUR LES SORTIES GRAPHIQUES \n\
1666                          dans le FICHIER DES RESULTATS.',
1667                     ang = 'Determines, in number of time steps, the printout period for the VARIABLES FOR GRAPHIC PRINTOUTS in the RESULTS FILE.' ,),
1668
1669 #       ------------------------------------
1670         Number_Of_First_TimeStep_For_Graphic_Printouts = SIMP(statut = 'o', typ = 'I',defaut = 1,
1671 #       ------------------------------------
1672                    fr = 'Determine le nombre de pas de temps a partir duquel debute l''ecriture des resultats dans le listing.',
1673                    ang = 'Determines the number of time steps after which the results are first written into the listing.'),
1674                   ), # fin Graphic_Printouts
1675
1676 #PNPN Attention - il existe un mot clef Listing_Printouts
1677 #  ------------------------------------
1678   Listing_Printouts = FACT(statut = 'f',
1679 #  ------------------------------------
1680
1681 #       ------------------------------------
1682           Results_File_Format = SIMP( statut = 'o',typ = 'TXM',into = ['Serafin','MED','SerafinD'], defaut = 'Serafin',
1683 #       ------------------------------------
1684                                 fr = 'Format du fichier de resultats. Les valeurs possibles sont : \n\
1685      - SERAFIN : format standard simple precision pour Telemac;  \n\
1686      - SERAFIND: format standard double precision pour Telemac; \n\
1687      - MED     : format MED base sur HDF5' ,
1688                                ang = 'Results file format. Possible values are:\n \
1689      - SERAFIN : classical single precision format in Telemac;\n\
1690      - SERAFIND: classical double precision format in Telemac; \n\
1691      - MED     : MED format based on HDF5' ,
1692                                    ),
1693
1694 #PNPNPN Soizic ? il faudrait mettre les mots clefs dans le meme paragraphe
1695 #       ------------------------------------
1696         Results_File = SIMP( statut = 'o',
1697 #       ------------------------------------
1698                typ = ('Fichier', 'Steering Files (*.cas);;All Files (*)',),
1699                fr = 'Nom du fichier dans lequel sont ecrits les resultats du calcul avec la periodicite donnee  PERIODE POUR LES SORTIES GRAPHIQUES.',
1700                ang = 'Name of the file into which the computation results shall be written, the periodicity being given by  GRAPHIC PRINTOUT PERIOD.',),
1701 #       ------------------------------------
1702         Listing_Printout_Period = SIMP(statut = 'o', typ = 'I',defaut = 1,
1703 #       ------------------------------------
1704           fr = 'Determine la periode en nombre de pas de temps d''impression des variables',
1705           ang = 'Determines, in number of time steps, the printout period for the variables',),
1706
1707 #       ------------------------------------
1708         Variables_To_Be_Printed = SIMP(statut = 'o',max = "**", typ = 'TXM',
1709 #       ------------------------------------
1710             into = [ "Velocity along X axis (m/s)", "Velocity along Y axis (m/s)", "Wave celerity (m/s)", "Water depth (m)",
1711                    "Free surface elevation (m)", "Bottom elevation (m)", "Froude number", "Scalar flowrate of fluid (m2/s)",
1712                    "Tracer", "Turbulent kinetic energy in K-Epsilon model (J/kg)", "Dissipation of turbulent energy (W/kg)",
1713                    "Turbulent viscosity of K-Epsilon model (m2/s)", "Flowrate along x axis (m2/s)", "Flowrate along y axis (m2/s)",
1714                    "Scalar velocity (m/s)", "Wind along x axis (m/s)", "Wind along y axis (m/s)", "Air pressure (Pa)",
1715                    "Friction coefficient", "Drift along x  (m)", "Drift along y  (m)", "Courant number",
1716                    "Supplementary variable N", "Supplementary variable O", "Supplementary variable R", "Supplementary variable Z"]),
1717
1718    ),# fin Listing_Printouts
1719
1720 #  ------------------------------------
1721    Formatted_Results_File = SIMP( statut = 'f',
1722 #  ------------------------------------
1723         typ = ('Fichier','All Files (*)',),
1724         fr = 'Fichier de resultats formate mis a la disposition de l utilisateur. \
1725 Les resultats a placer dans ce fichier seront a ecrire sur le canal 29.',
1726        ang = 'Formatted file of results made available to the user.  \
1727 The results to be entered into this file shall be written on channel 29.',),
1728
1729 # PNPNPN --> a harmoniser . demander aux devpeurs
1730 #  ------------------------------------
1731    Debugger = SIMP(typ = 'I' , statut = 'o',
1732 #  ------------------------------------
1733         defaut = 0,
1734         into = [0,1],
1735         fr= 'Pour imprimer la sequence des appels, mettre 1',
1736         ang = 'If 1, calls of subroutines will be printed in the listing',),
1737
1738 #  ------------------------------------
1739    Output_Of_Initial_Conditions = SIMP(typ = bool, statut = 'o',
1740 #  ------------------------------------
1741         defaut = True,
1742         fr = 'Si Vrai, impression des conditions initiales dans les resultats',
1743         ang = 'If True, output of initial conditions in the results'),
1744
1745 #  ------------------------------------
1746    Information_About_Solver = SIMP(typ = bool, statut = 'f',
1747 #  ------------------------------------
1748        defaut = False,
1749        fr = "Si vrai, Donne a chaque pas de temps le nombre d'iterations necessaires a la convergence du solveur de l'etape de propagation.",
1750        ang = "if True, prints the number of iterations that have been necessary to get the solution of the linear system.",),
1751
1752 #  ------------------------------------
1753    Binary_Results_File = SIMP( statut = 'f',
1754 #  ------------------------------------
1755          typ = ('Fichier', ';;All Files (*)',),
1756          fr = "Fichier de resultats code en binaire mis a la disposition de l'utilisateur.\n\
1757 Les resultats a placer dans ce fichier seront a ecrire sur le canal 28.",
1758          ang = "Additional binary-coded result file made available to the user. \n\
1759 The results to be entered into this file shall be written on channel 28.",),
1760
1761 #  ------------------------------------
1762   Controls = FACT( statut='f',
1763 #  ------------------------------------
1764 #      ------------------------------------
1765        Controls_Section = SIMP(statut = 'f',typ = Tuple(2),validators = VerifTypeTuple(('I','I')),
1766 #      ------------------------------------
1767             fr = 'Couples de points (numeros globaux dans le maillage) entre lesquels les debits instantanes et cumules seront donnes.',
1768             ang = 'Couples of points (global numbers in the mesh) defining sections where the instantaneous and cumulated discharges will be given',),
1769
1770 #      ------------------------------------
1771        Printing_Cumulated_Flowrates = SIMP( statut = 'o',typ = bool, defaut = False ,
1772 #      ------------------------------------
1773             fr = 'impression du flux cumule a travers les sections de controle',
1774             ang = 'printing the cumulated flowrates through control sections',),
1775
1776 #      ------------------------------------
1777        Compatible_Computation_Of_Fluxes = SIMP( statut = 'o',typ = bool, defaut = False ,
1778 #      ------------------------------------
1779            fr = 'flux a travers les sections de controle, calcul compatible avec l impermeabilite sous forme faible',
1780            ang = 'flowrates through control sections, computation compatible with the weak formulation of no-flux boundary condition',),
1781
1782 #      ------------------------------------
1783        Sections_Input_File = SIMP( statut = 'f', typ = ('Fichier', 'All Files (*)'),
1784 #      ------------------------------------
1785           fr = 'sections input file, partitioned',
1786           ang = 'sections input file, partitioned',),
1787
1788 #      ------------------------------------
1789        Sections_Output_File = SIMP( statut = 'f', typ = ('Fichier', 'All Files (*)'),
1790 #      ------------------------------------
1791           fr = 'sections output file, written by the master',
1792           ang = 'sections output file, written by the master',),
1793
1794   ),# fin controls
1795 ) # FIN POST-PRO
1796
1797
1798 # -----------------------------------------------------------------------
1799 CONSTRUCTION_WORKS_MODELLING = PROC(nom = "CONSTRUCTION_WORKS_MODELLING",op = None,
1800 # -----------------------------------------------------------------------
1801
1802 # PNPNPN : Il faudrait harmoniser . soizic ?
1803 # Attention calculer le logique BREACH
1804
1805 #      ------------------------------------
1806        Number_Of_Culverts = SIMP( statut = 'o',typ = 'I',
1807 #      ------------------------------------
1808             defaut = 0 ,
1809             fr = 'Nombre de siphons traites comme des termes sources ou puits. Ces siphons doivent etre decrits comme des sources \
1810 dans le fichier cas. Leurs caracteristiques sont donnees dans le fichier de donnees des siphons (voir la documentation ecrite)',
1811             ang = 'Number of culverts treated as source terms.  They must be described as sources in the domain\
1812  and their features are given in the culvert data file (see written documentation)',),
1813 #           ------------------------------------
1814             culvert_exists = BLOC(condition = "Number_Of_Culverts!= 0",
1815 #           ------------------------------------
1816 #               ------------------------------------
1817                 Culvert_Data_File = SIMP( statut = 'o',typ = ('Fichier', 'All Files (*)',),
1818 #               ------------------------------------
1819                     fr = 'Fichier de description des siphons presents dans le modele',
1820                     ang = 'Description of culvert existing in the model',),
1821             ), # fin bloc culvert_exists
1822
1823 #      ------------------------------------
1824        Number_Of_Tubes = SIMP( statut = 'o',typ = 'I',
1825 #      ------------------------------------
1826              defaut = 0 ,
1827              fr = 'Nombre de buses ou ponts traites comme des termes sources ou puits. Ces buses doivent etre decrits comme des sources\n\
1828 dans le fichier cas. Leurs caracteristiques sont donnees dans le fichier de donnees des buses (voir la documentation ecrite)',
1829              ang = 'Number of tubes or bridges treated as source terms.  They must be described as sources in the domain \n\
1830 and their features are given in the tubes data file (see written documentation)',),
1831 #          ------------------------------------
1832             b_Tubes = BLOC(condition = "Number_Of_Tubes!= 0",
1833 #          ------------------------------------
1834 #               ------------------------------------
1835                 Tubes_Data_File = SIMP( statut = 'o',
1836 #               ------------------------------------
1837                     typ = ('Fichier', 'All Files (*)',),
1838                     fr = 'Fichier de description des buses/ponts presents dans le modele',
1839                     ang = 'Description of tubes/bridges existing in the model',),
1840             ), # in bloc b_Tubes
1841
1842 #      ------------------------------------
1843        Number_Of_Weirs = SIMP(statut = 'o',typ = 'I',defaut = 0,
1844 #      ------------------------------------
1845              fr = 'Nombre de seuils qui seront traites par des conditions aux limites. \n\
1846 Ces seuils doivent etre decrits comme des frontieres du domaine de calcul',
1847              ang = 'Number of weirs that will be treated by boundary conditions.',
1848      ),
1849 #          ------------------------------------
1850            b_Weirs = BLOC(condition = "Number_Of_Weirs!= 0",
1851 #          ------------------------------------
1852 #               ------------------------------------
1853                 Weirs_Data_File = SIMP( statut = 'o',
1854 #               ------------------------------------
1855                     typ = ('Fichier', 'All Files (*)',),
1856                     fr = 'Fichier de description des seuils presents dans le modele',
1857                     ang = 'Description of weirs existing in the model',),
1858
1859 #              ------------------------------------
1860                Type_Of_Weirs = SIMP( statut = 'o',typ = 'TXM',
1861 #              ------------------------------------
1862                    into = ["Horizontal with same number of nodes upstream/downstream (Historical solution with bord)",
1863                        "General (New solution with sources points)"],
1864                    defaut = "Horizontal with same number of nodes upstream/downstream (Historical solution with bord)",
1865                    fr = 'Méthode de traitement des seuils ',
1866                    ang = 'Method for treatment of weirs',),
1867           ),# fin b_Weirs
1868
1869 #      ------------------------------------
1870       Breach = SIMP(statut = 'f',typ = bool,defaut = False,
1871 #      ------------------------------------
1872          fr = 'Prise en compte de breches dans le calcul par modification altimetrique dans le maillage.',
1873          ang = 'Take in account some breaches during the computation by modifying the bottom level of the mesh.',),
1874
1875 #          ------------------------------------
1876            b_Breaches = BLOC (condition = 'Breach == True',
1877 #          ------------------------------------
1878 #              ------------------------------------
1879                Breaches_Data_File = SIMP( statut = 'o',typ = ('Fichier', 'All Files (*)',),
1880 #              ------------------------------------
1881                    fr = 'Fichier de description des breches',
1882                    ang = 'Description of breaches',),
1883          ), # fin b_Breaches
1884
1885 #     ------------------------------------
1886       Vertical_Structures = SIMP(statut = 'o',typ = bool,defaut = False,
1887 #     ------------------------------------
1888          fr = 'Prise en compte de la force de trainee de structures verticales',
1889          ang = 'drag forces from vertical structures are taken into account',),
1890
1891 #          ------------------------------------
1892            maskob = BLOC (condition = 'Vertical_Structures == True',
1893 #          ------------------------------------
1894 #              ------------------------------------
1895                Consigne = SIMP(statut = "o",homo = 'information',typ = "TXM",
1896 #              ------------------------------------
1897                defaut = "subroutine DRAGFO must then be implemented"),
1898            ), # fin maskob
1899
1900 ) # Fin CONSTRUCTION_WORKS_MODELLING
1901
1902 # -----------------------------------------------------------------------
1903 TRACERS = PROC(nom = "TRACERS",op = None,
1904 # -----------------------------------------------------------------------
1905 #      ------------------------------------
1906        Boundary_conditions = FACT(statut = 'o',
1907 #      ------------------------------------
1908 #          ------------------------------------
1909            Treatment_Of_Fluxes_At_The_Boundaries = SIMP( statut = 'f',typ = 'TXM',
1910 #          ------------------------------------
1911                into = ["Priority to prescribed values","Priority to fluxes"],
1912                fr = 'Utilise pour les schemas SUPG, PSI et N, \n\
1913 si Priorité aux flux, on ne retrouve pas exactement les valeurs imposees des traceurs,mais le flux est correct',
1914              ang = 'Used so far only with the SUPG, PSI and N schemes.\n\
1915 if Priority to fluxes, Dirichlet prescribed values are not obeyed,but the fluxes are correct',),
1916         ), # fin Boundary_conditions
1917 )# FIN TRACERS
1918
1919 # -----------------------------------------------------------------------
1920 GENERAL_PARAMETERS = PROC(nom = "GENERAL_PARAMETERS",op = None,
1921 # -----------------------------------------------------------------------
1922
1923 #      ------------------------------------
1924        Spherical_Coordinates = SIMP(typ = bool,statut = 'o',defaut = False,
1925 #      ------------------------------------
1926            fr = 'Choix des coordonnees spheriques pour la realisation du calcul ( pour les grands domaines de calcul).',
1927            ang = 'Selection of spherical coordinates to perform the computation (for large computation domains).'),
1928
1929 #      ------------------------------------
1930        b_Spher = BLOC(condition = 'Spherical_Coordinates == True',
1931 #      ------------------------------------
1932 #          ------------------------------------
1933            Latitude_Of_Origin_Point = SIMP(typ = 'R',statut = 'o',defaut = 48.,
1934 #          ------------------------------------
1935                fr = 'Determine l origine utilisee pour le calcul de latitudes lorsque l on effectue un calcul en coordonnees spheriques.',
1936                ang = 'Determines the origin used for computing latitudes when a computation is made in spherical coordinates.this latitude\n\
1937 is in particular used to compute the Coriolis force. In cartesian coordinates, Coriolis coefficient is considered constant.'),
1938
1939 #          ------------------------------------
1940             Spatial_Projection_Type = SIMP(statut = 'o',typ = 'TXM',
1941 #          ------------------------------------
1942                into = ["Mercator","Latitude longitude"]),
1943        ), # fin b_Spher
1944
1945 #      ------------------------------------
1946        b_Spher_faux = BLOC(condition = 'Spherical_Coordinates == False',
1947 #      ------------------------------------
1948 #          ------------------------------------
1949            Spatial_Projection_Type = SIMP(statut = 'o',typ = 'TXM',
1950 #          ------------------------------------
1951                into = ["Cartesian, not georeferenced","Mercator","Latitude longitude"],
1952                defaut = "Cartesian, not georeferenced",),
1953        ), # fin b_Spher_faux
1954
1955 ) # Fin GENERAL_PARAMETERS
1956
1957
1958 # -----------------------------------------------------------------------
1959 TURBULENCE = PROC(nom = "TURBULENCE",op = None,
1960 # -----------------------------------------------------------------------
1961 # A Reclasser
1962
1963 #    -----------------------------------------------------------------------
1964      Turbulence_Model = SIMP( statut = 'o',typ = 'TXM', defaut = "Constant Viscosity",
1965 #    -----------------------------------------------------------------------
1966           into = ("Constant Viscosity", "Elder", "K-Epsilon Model", "Smagorinski"),
1967           fr = 'Pour  Elder, il faut pas oublier d ajuster les deux valeurs du mot-cle : COEFFICIENTS ADIMENSIONNELS DE DISPERSION\n\
1968 Pour K-Epsilon Model, ce meme parametre doit retrouver sa vraie valeur physique car elle est utilisee comme telle dans le modele de turbulence',
1969     ang = 'When Elder, the two values of key-word : NON-DIMENSIONAL DISPERSION COEFFICIENTS are used \n\
1970 When K-Epsilon Model, this parameter should recover its true physical value, since it is used as such in the turbulence model.',),
1971
1972 #          ------------------------------------
1973            b_turbu_const = BLOC(condition = 'Turbulence_Model == "Constant Viscosity"',
1974 #          ------------------------------------
1975 #              ------------------------------------
1976                Velocity_Diffusivity = SIMP( statut = 'o',typ = 'R',
1977 #              ------------------------------------
1978                    defaut = 1.E-6,
1979                    fr = 'Fixe de facon uniforme pour l ensemble du domaine la valeur du coefficient de diffusion de viscosite globale (dynamique + turbulente).\n\
1980 Cette valeur peut avoir une influence non negligeable sur la forme et la taille des recirculations.',
1981                    ang = 'Sets, in an even way for the whole domain, the value of the coefficient of global (dynamic+turbulent) viscosity. \n\
1982 this value may have a significant effect both on the shapes and sizes of recirculation zones.',),
1983             ), # fin b_turbu_const
1984
1985 #          ------------------------------------
1986            b_turbu_elder = BLOC(condition = 'Turbulence_Model == "Elder"',
1987 #          ------------------------------------
1988 #              ------------------------------------
1989                Non_Dimensional_Dispersion_Coefficients = SIMP (statut = 'o',
1990 #              ------------------------------------
1991                    typ = Tuple(2),validators = VerifTypeTuple(('R','R')),defaut = (6.,0.6),
1992                    fr = 'coefficients longitudinal et transversal dans la formule de Elder.',
1993                    ang = 'Longitudinal and transversal coefficients in elder s formula.  Used only with turbulence model number 2',),
1994            ), # fin bloc b_turbu_elder
1995
1996 # PNPN soizic ? ne faut-il pas un bloc
1997 #    -----------------------------------------------------------------------
1998      Accuracy_Of_K = SIMP( statut = 'o',typ = 'R', defaut = 1e-09 ,
1999 #    -----------------------------------------------------------------------
2000             fr = 'Fixe la precision demandee sur k pour le test d arret dans letape de diffusion et termes sources du modele k-epsilon.',
2001             ang = 'Sets the required accuracy for computing k in the diffusion and source terms step of the k-epsilon model.',),
2002
2003 # PNPN soizic ? ne faut-il pas un bloc
2004 #    -----------------------------------------------------------------------
2005      Accuracy_Of_Epsilon = SIMP( statut = 'o',typ = 'R', defaut = 1e-09 ,
2006 #    -----------------------------------------------------------------------
2007             fr = 'Fixe la precision demandee sur epsilon pour le test darret dans letape de diffusion et termes sources de k et epsilon.',
2008             ang = 'Sets the required accuracy for computing epsilon in the diffusion and source-terms step of the k-epsilon model.',),
2009
2010 #    -----------------------------------------------------------------------
2011      Time_Step_Reduction_For_K_epsilon_Model = SIMP( statut = 'f',typ = 'R', defaut = 1.0 ,
2012 #    -----------------------------------------------------------------------
2013            fr = 'Coefficient reducteur du pas de temps pour le modele k-epsilon (qui est normalement identique a celui du systeme hydrodynamique).\n\
2014 Utilisation deconseillee',
2015            ang = 'Time step reduction coefficient for k-epsilon model (which is normally same the same as that of the hydrodynamic system).\n\
2016 Not recommended for use.',),
2017
2018 #    -----------------------------------------------------------------------
2019      Maximum_Number_Of_Iterations_For_K_And_Epsilon = SIMP( statut = 'o',typ = 'I',
2020 #    -----------------------------------------------------------------------
2021            defaut = 50 ,
2022            fr = 'Fixe le nombre maximum diterations accepte lors de la resolution du systeme diffusion-termes sources du modele k-epsilon.',
2023            ang = 'Sets the maximum number of iterations that are acceptable when solving the diffusion source-terms step of the k-epsilon model.',),
2024
2025 #    -----------------------------------------------------------------------
2026      Turbulence_Model_For_Solid_Boundaries = SIMP( statut = 'o',typ = 'TXM',
2027 #    -----------------------------------------------------------------------
2028            defaut = 'Rough' ,
2029            into = ('Smooth', 'Rough'),
2030            fr = 'Permet de choisir le regime de turbulence aux parois ',
2031            ang = 'Provided for selecting the type of friction on the walls',),
2032
2033 #    -----------------------------------------------------------------------
2034       Solver_For_K_epsilon_Model = SIMP( statut = 'o',typ = 'TXM',
2035 #    -----------------------------------------------------------------------
2036            defaut = "Conjugate gradient" ,
2037            into = ("Conjugate gradient", "Conjugate residuals", "Conjugate gradient on normal equation",
2038                    "Minimum error", "Conjugate gradient squared", "Conjugate gradient squared stabilised (CGSTAB)",
2039                    "GMRES", "Direct"),
2040            fr = 'Permet de choisir le solveur utilise pour la resolution du systeme du modele k-epsilon',
2041            ang = 'Makes it possible to select the solver used for solving the system of the k-epsilon model.',),
2042
2043 #        -----------------------------------------------------------------------
2044          b_gmres = BLOC(condition = 'Solver_For_K_epsilon_Model == "GMRES"',
2045 #        -----------------------------------------------------------------------
2046 #            -----------------------------------------------------------------------
2047              Option_For_The_Solver_For_K_epsilon_Model = SIMP( statut = 'o',typ = 'I',
2048 #            -----------------------------------------------------------------------
2049                   defaut = 2 ,val_min = 2,val_max = 15,
2050                   fr = 'le mot cle est la dimension de lespace de KRILOV (valeurs conseillees entre 2 et 7)',
2051                   ang = 'dimension of the krylov space try values between 2 and 7',),
2052          ), # fin bloc b_gmres
2053
2054 #    -----------------------------------------------------------------------
2055      Preconditioning_For_K_epsilon_Model = SIMP( statut = 'o',typ = 'TXM',
2056 #    -----------------------------------------------------------------------
2057          defaut = 'Diagonal' ,
2058          into = ("Diagonal", "No preconditioning", "Diagonal condensed", "Crout", "Diagonal and crout", "Diagonal condensed and crout"),
2059          fr = 'Permet de preconditionner le systeme relatif au modele k-epsilon',
2060          ang = 'Preconditioning of the linear system in the diffusion step of the k-epsilon model.',
2061      ),
2062 #    -----------------------------------------------------------------------
2063      Information_About_K_Epsilon_Model = SIMP(statut = 'o',typ = bool,defaut = True,
2064 #    -----------------------------------------------------------------------
2065         fr = 'Donne le nombre d iterations du solveur de l etape de diffusion et termes sources du modele k-epsilon.',
2066         ang = 'Gives the number of iterations of the solver in the diffusion and source terms step of the k-epsilon model.',
2067      ),
2068 )# fin TURBULENCE
2069
2070 # -----------------------------------------------------------------------
2071 PARTICULE = PROC(nom = "PARTICULE",op = None,
2072 # -----------------------------------------------------------------------
2073 #    -----------------------------------------------------------------------
2074       Number_Of_Drogues = SIMP(statut = 'o',typ = 'I',defaut = 0,
2075 #    -----------------------------------------------------------------------
2076       fr = 'Permet d''effectuer un suivi de flotteurs',
2077       ang = 'Number of drogues in the computation.',),
2078
2079 #    -----------------------------------------------------------------------
2080      Algae_Transport_Model = SIMP( statut = 'o',typ = bool, defaut = False ,
2081 #    -----------------------------------------------------------------------
2082           fr = 'Si oui, les flotteurs seront des algues',
2083           ang = 'If yes, the floats or particles will be algae',),
2084
2085 #        -----------------------------------------------------------------------
2086          algae_exists = BLOC(condition = "Algae_Transport_Model == True",
2087 #        -----------------------------------------------------------------------
2088 #            -----------------------------------------------------------------------
2089              Algae_Type = SIMP( statut = 'o',typ = 'TXM',
2090 #            -----------------------------------------------------------------------
2091                  into = ["Sphere", "Iridaea flaccida (close to ulva)", "Pelvetiopsis limitata", "Gigartina leptorhynchos"],
2092                  defaut = "Sphere",
2093                  fr = 'Type des algues. Pour sphere les algues seront modelisees comme des spheres, pour les autres choix voir Gaylord et al.(1994)',
2094                  ang = 'Algae type. For sphere, the algae particles will be modeled as spheres, for the other choices see Gaylord et al.(1994)',),
2095
2096 #            -----------------------------------------------------------------------
2097              Diametre_Of_Algae = SIMP( statut = 'o',typ = 'R', defaut = 0.1 ,
2098 #            -----------------------------------------------------------------------
2099                  fr = 'Diametre des algues en m',
2100                  ang = 'Diametre of algae in m',),
2101
2102 #            -----------------------------------------------------------------------
2103              Density_Of_Algae = SIMP( statut = 'o',typ = 'R', defaut = 1050.0 ,
2104 #            -----------------------------------------------------------------------
2105                  fr = 'Masse volumique des algues en kg/m3',
2106                  ang = 'Density of algae in kg/m3',),
2107
2108 #            -----------------------------------------------------------------------
2109              Thickness_Of_Algae = SIMP( statut = 'o',typ = 'R', defaut = 0.01 ,
2110 #            -----------------------------------------------------------------------
2111                  fr = 'Epaisseur des algues en m',
2112                  ang = 'Thickness of algae in m',),
2113       ), # fin algae
2114
2115
2116 #    -----------------------------------------------------------------------
2117      Oil_Spill_Model = SIMP( statut = 'o',typ = bool, defaut = False ,
2118 #    -----------------------------------------------------------------------
2119          fr = 'pour declencher le modele de derive de nappes, dans ce cas le fichier de commandes migrhycar est necessaire',
2120          ang = 'will trigger the oil spill model, in this case the migrhycar steering file is needed',),
2121
2122 #    -----------------------------------------------------------------------
2123      oil_exists = BLOC(condition = "Oil_Spill_Model == True",
2124 #    -----------------------------------------------------------------------
2125 #        -----------------------------------------------------------------------
2126          Oil_Spill_Steering_File = SIMP( statut = 'o',typ = ('Fichier', 'All Files (*)',),
2127 #        -----------------------------------------------------------------------
2128              fr = 'Contient les donnees pour le modele de derive de nappes',
2129              ang = 'Contains data for the oil spill model',),
2130      ), # fin oil_exists
2131
2132 #    -----------------------------------------------------------------------
2133      drogues_exists = BLOC(condition = "Number_Of_Drogues!= 0 or Algae_Transport_Model == True or Oil_Spill_Model == True",
2134 #    -----------------------------------------------------------------------
2135 #        -----------------------------------------------------------------------
2136          Drogues_File = SIMP( statut = 'o',typ = ('Fichier', 'All Files (*)',),
2137 #        -----------------------------------------------------------------------
2138              fr = 'Fichier de resultat avec les positions des flotteurs',
2139              ang = 'Results file with positions of drogues',),
2140
2141 #        -----------------------------------------------------------------------
2142          Printout_Period_For_Drogues = SIMP(statut = 'o',typ = 'I',defaut = 1,
2143 #        -----------------------------------------------------------------------
2144               fr = 'Nombre de pas de temps entre 2 sorties de positions de flotteurs dans le fichier des resultats binaire supplementaire\n\
2145 N affecte pas la qualite du calcul de la trajectoire',
2146               ang = 'Number of time steps between 2 outputs of drogues positions in the binary file',),
2147      ),#fin drogues ou algae
2148
2149
2150 #    -----------------------------------------------------------------------
2151      Stochastic_Diffusion_Model = SIMP( statut = 'o',typ = 'I', defaut = 0 ,
2152 #    -----------------------------------------------------------------------
2153          fr = 'Pour les particules : flotteurs, algues, hydrocarbures',
2154          ang = 'Meant for particles: drogues, algae, oil spills',),
2155
2156 #    -----------------------------------------------------------------------
2157      Number_Of_Lagrangian_Drifts = SIMP( statut = 'o',typ = 'I', defaut = 0 ,
2158 #    -----------------------------------------------------------------------
2159          fr = 'Permet deffectuer simultanement plusieurs calculs de derives lagrangiennes initiees a des pas differents',
2160          ang = 'Provided for performing several computations of lagrangian drifts starting at different times.',),
2161
2162 #    -----------------------------------------------------------------------
2163      b_cons = BLOC(condition = "Number_Of_Lagrangian_Drifts != 0",
2164 #    -----------------------------------------------------------------------
2165 #        -----------------------------------------------------------------------
2166          Consigne = SIMP(statut = "o",homo = 'information',typ = "TXM",
2167 #        -----------------------------------------------------------------------
2168              defaut = "Add A and G in the VARIABLES FOR GRAPHIC PRINTOUTS key-word in POST_PROCESSING SECTION"),
2169     ), # fin b_cons
2170
2171 )# fin PARTICULE