doc/salome/tutorial/english/english_miseEnDonneesTelemac.rst

   1 ..
   2    Copyright (C) 2015-2016 EDF
   3
   4    This file is part of SALOME HYDRO module.
   5
   6    SALOME HYDRO module is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    SALOME HYDRO module is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with SALOME HYDRO module.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 #########################################
  20 TELEMAC setup
  21 #########################################
  22
  23 .. |HYDROSolver| image:: /../_static/HYDROSolver.png
  24    :align: middle
  25    :width: 16pt
  26    :height: 16pt
  27
  28 .. |eficas_04| image:: /../_static/eficas_04.png
  29    :align: middle
  30    :width: 16pt
  31    :height: 16pt
  32
  33 .. |genereCondlim| image:: /../_static/genereCondlim.png
  34    :align: middle
  35
  36 .. |eficas_01| image:: /../_static/eficas_01.png
  37    :align: middle
  38
  39 .. |eficas_02| image:: /../_static/eficas_02.png
  40    :align: middle
  41
  42 .. |eficas_03| image:: /../_static/eficas_03.png
  43    :align: middle
  44
  45 .. |eficas_20| image:: /../_static/eficas_20.png
  46    :align: middle
  47
  48 .. |eficas_21| image:: /../_static/eficas_21.png
  49    :align: middle
  50
  51 .. |eficas_22| image:: /../_static/eficas_22.png
  52    :align: middle
  53
  54 .. |eficas_23| image:: /../_static/eficas_23.png
  55    :align: middle
  56
  57 Once the mesh is generated with the altimetry data, it remains to define the nature of the boundary condition regions,
  58 the values of the flow rate and water depth boundary conditions over time and all the physical and numerical model parameters.
  59 The TELEMAC manual should be consulted for the parameter definitions.
  60
  61 This information is compiled in several text files (ASCII) that are now going to be generated or manually edited.
  62
  63 **The abovementioned files will be stored in the same directory as the mesh.**
  64
  65 You must activate the HYDROSOLVER module, through the scrolling list of imodules, or its icon in the banner: |HYDROSolver|.
  66 The HYDROSOLVER module supports physico-numerical data setup and calculations for codes
  67 TELEMAC and MASCARET and their couplings.
  68
  69 Characterization of boundary regions
  70 ====================================
  71
  72 The boundary condition regions were defined in the previous
  73 steps and are incorporated by named groups of mesh elements.
  74
  75 The *condlim.bcd* file associates specific types of boundary condition (inlet, outlet, wall, etc.) to each group.
  76 Four integer values define a boundary condition type.
  77
  78 The first line indicates the number of boundary conditions defined and is followed by four lines:
  79 one per boundary condition. Each line contains four integers (the type) as well as the name of the group.
  80
  81 This file caan be created with de command  *Edit boundary conditions file* from *HYDROSOLVER* module.
  82
  83 The path of the MED file used must be defined as input, and the file path of the boundary condition fields as output.
  84 The *Boundary condition file* entry is used only to read/edit an existing file.
  85
  86 You must select the boundary condition type on the upstream, downstream, left and right bank,
  87 and do not put anything on the other groups.
  88
  89   |genereCondlim|
  90
  91 The result file looks like this:
  92
  93 .. literalinclude:: ../condlim.bcd
  94     :lines: 1-
  95
  96 * **Note**: It is no longer necessary to create the .cli file specified in the Telemac manual,
  97     which lists all the boundary condition nodes with the types associated. This file is automatically generated.
  98
  99 Values of the discharge and water elevation boundary conditions
 100 ===============================================================
 101
 102 The *init.lqd* file contains the values of the flow rate and water depth boundary conditions over time.
 103 Reference should be made to the Telemac manual for more precise details on the file definition.
 104
 105 .. literalinclude:: ../init.lqd
 106     :lines: 1-
 107
 108 Physical and numerical parameters of the simulation
 109 ===================================================
 110
 111 The *init.cas* file lists the other files, which must be in the same directory.
 112 It then gives the different physical and numerical parameters required for the simulation (calculation case).
 113 As mentioned before, the Telemac manual should be consulted for the definition of these parameters.
 114
 115 * **Note**: for version 1.0 (March 2016), the presence of a Fortran file is compulsory, even if it only contains one comment line
 116   (it is necessary to force the recompilation of the TELEMAC executable). In the init.cas file,
 117   the comment in front of the FORTRAN FILE keyword must be deleted and the corresponding file created.
 118
 119 .. literalinclude:: ../init.cas
 120     :lines: 1-
 121
 122 Steering file setup through EFICAS
 123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 124
 125 There are 2 methods to perform this, with the module *HYDROSOLVER*:
 126
 127 * **with the menus:** in HYDRO menu, click on *Edit cas file*
 128
 129   |eficas_01|
 130
 131 * **with the icons:** When the Hydrosolver module is activated, new buttons appear in the toolbar.
 132   Right click on Edit case file
 133
 134   |eficas_02|
 135
 136 Click New to create a case file.
 137
 138   |eficas_03|
 139
 140 Complete all red items. When a sub-heading or heading is complete it changes to green.
 141 Some green items are setup with the default value but the user can overwrite them.
 142 Save (regularly) the created case. To do this, go to *File/Save* or *Save as*
 143 or click on the icon |eficas_04|.
 144 The file will be saved as *.comm* or *.jdc*.
 145
 146 How EFICAS works?
 147 ~~~~~~~~~~~~~~~~~
 148
 149 In thecentral interface, at the level of the heading, in the right-hand section entitled Settings *NOM DE RUBRIQUE*,
 150 optional keywords appear and can be added to the corresponding sub-heading,
 151 by double-clicking the square box in front of the keyword.
 152
 153 **Example:** To add the keyword *Control_section* in *Output_Files*. Double-click on the right:
 154
 155   |eficas_20|
 156
 157 It appears in the *Output_Files* sub-section. In the central screen, other keywords appears in the right part under the title
 158 *Control_Section*. I can add them in the same way.
 159
 160   |eficas_21|
 161
 162 It is also possible to have the help of the keyword. To do this, simply move the mouse over the keyword and the help appears:
 163
 164 |eficas_22|
 165
 166 If you click on the keyword with the mouse the help appears at the bottom left:
 167
 168   |eficas_23|
 169
 170 **Parameters by section and sub-section**
 171
 172 In *Computation_Environment*, by default, we find:
 173
 174  * *Initialization*: concerns input data files such as the geometry file and the boundary conditions file.
 175     To take the title into account, type the desired name and enter.
 176
 177  * *Restart*: to restart from a previous computation.
 178
 179  * *Output_files*: result files, listing and their options.
 180
 181 In *Hydro*, by default, we find:
 182
 183  * *Boundary_Conditions*: boundary condition files
 184    (files for liquid boundaries, stage-discharge curves, prescribed elevation or flowrate…)
 185
 186  * *Physical_Parameters_Hydro*: Physical parameters for hydrodynamics. Waves, meteo, source terms…
 187
 188  * *Numerical_Parameters_Hydro*: Numerical parameters for hydrodynamics, linear system options.
 189
 190 In *General_Parameters*, by default, we find:
 191
 192  * *Debugger*: debugger mode or not.
 193
 194  * *Time*: time step, duration…
 195
 196  * *Location*: coordinates origin…
 197
 198 In *Numerical_Parameters*, by default, we find:
 199
 200  * *Solver_Info*: solver setup
 201
 202  * *Discretizations_Implicitation*: implicitation for depth, velocity, space discretization…
 203
 204  * *Propagation_Info*
 205
 206  * *Advection_Info*: mass lumping, free surface gradient compatibility…
 207
 208  * *Diffusion*: velocity diffusion, option for velocity diffusion…
 209
 210  * *Automatic_Differentiation*
 211
 212  * *Advanced*: matrix storage, matrix-vector product…
 213
 214 **Developement in progress**
 215
 216 In the end, the user can choose from pre-filled "template case files". These include:
 217
 218   * A flood model case file,
 219
 220   * A maritime model case file,
 221
 222   * A thermal case model file.
 223
 224 .. only:: html
 225
 226    :ref:`ref_exempleInondation`