doc/basic.rst

   1 ..
   2    Copyright (C) 2012-2013 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 ############
  21 Simple Usage
  22 ############
  23
  24 Running a Telemac case
  25 ======================
  26
  27 .. |run_pytel_button| image:: /_static/create_case_pytel.png
  28    :align: middle
  29
  30 To run a Telemac case from Salome-Hydro, activate HydroSolver module and click
  31 on the button |run_pytel_button|. A new dialog appears (the *Eficas* interface)
  32 that let you choose the case file, dictionary, geometry file, etc. When all the
  33 desired files are selected, save this case description file. It will appear in
  34 Salome object browser. Right-click on the item in the object browser and select
  35 "Compute case" in the popup menu. Telemac will start the computation and the
  36 execution log will be shown in a terminal.
  37
  38 **Note**: In case of a crash or errors, check your */tmp* directory to find log
  39 files.
  40
  41 **Warning**: If you use the *Universal* distribution of Salome-Hydro on a
  42 platform that does not include gfortran 4.4.5 or a compatible version, you will
  43 not be able to use a user fortran file with your Telemac case.
  44
  45 Running a Telemac 2D case with the API
  46 ======================================
  47
  48 .. |create_t2d_api_button| image:: /_static/create_case2d.png
  49    :align: middle
  50
  51 To run a Telemac 2D case through the TELEMAC2D API from Salome-Hydro, activate
  52 HydroSolver module and click on the button |create_t2d_api_button|. A new
  53 dialog appears that let you choose the case file, dictionary, geometry file,
  54 etc. When all the desired files are selected, save this case description file.
  55 It will appear in Salome object browser. Right-click on the item in the object
  56 browser and select "Compute case" in the popup menu. Telemac will start the
  57 computation.
  58
  59 **Note**: Nothing is shown in the interface for now with this service. Check
  60 your */tmp* directory to find log files.
  61
  62 **Warning**: If you use the *Universal* distribution of Salome-Hydro on a
  63 platform that does not include gfortran 4.4.5 or a compatible version, you will
  64 not be able to use a user fortran file with your Telemac 2D case.
  65
  66 **Warning**: Due to a remaining bug, it is mandatory with this service to have a
  67 *CONFIG* file in the same directory as the case file, containing the
  68 declarations for *LU* and *LNG* variables.
  69
  70 Running a Mascaret case
  71 =======================
  72
  73 .. |create_mascaret_button| image:: /_static/create_case1d.png
  74    :align: middle
  75
  76 To run a Mascaret case from Salome-Hydro, activate HydroSolver module and click
  77 on the button |create_mascaret_button|. A new dialog appears that let you
  78 choose the case file, dictionary, geometry file, etc. You can also add several
  79 output variables with the parameter "VARIABLE_SORTIE". The name ("NOM") is
  80 free, but the Mascaret variable ("VARIABLE_MASCARET") must use a specific
  81 syntax inspired by Mascaret API. This syntax is
  82 *Type.NomVar.SubVar(idx1, idx2, idx3)*, where *Type* is "Etat" or "Modele",
  83 *NomVar* and *SubVar* are variables names (*SubVar* is not necessary for all
  84 variables), and *idxX* are indexes if the variable is an array. For instance,
  85 *Etat.Z(1,0,0)* is the water heigth on the first section of the model.
  86
  87 When all the desired files are selected, save this case description file. It
  88 will appear in Salome object browser. Right-click on the item in the object
  89 browser and select "Compute case" in the popup menu. Mascaret will start the
  90 computation of the case. Unfortunately, Mascaret logs are not available yet
  91 through Mascaret API, so the only output available is the value of the
  92 specified output variables.
  93
  94 **Note**: In case of a crash or errors, check your */tmp* directory to find log
  95 files.