along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
#########################################
-Launch of the TELEMAC simulation case
+Lancement du calcul TELEMAC
#########################################
.. |HYDROSolver| image:: /../_static/HYDROSolver.png
.. |CasPytelFinCalcul| image:: /../_static/CasPytelFinCalcul.png
:align: middle
+.. |eficas_05| image:: /../_static/eficas_05.png
+ :align: middle
+
+.. |eficas_06| image:: /../_static/eficas_06.png
+ :align: middle
+
+.. |eficas_07| image:: /../_static/eficas_07.png
+ :align: middle
+
+.. |eficas_08| image:: /../_static/eficas_08.png
+ :align: middle
-The HYDROSolver module must now be activated via the module scrolling list or with the |HYDROSolver| icon in the ribbon.
+.. |eficas_09| image:: /../_static/eficas_09.png
+ :align: middle
+
+.. |eficas_10| image:: /../_static/eficas_10.png
+ :align: middle
+
+The HYDROSolver module must now be activated via the module scrolling list or with the |HYDROSolver| icon in the ribbon.
This module is responsible for the Telemac and Mascaret numerical modelling and their couplings.
Creating the PYTEL Calculation Case
in the hydro menu or in a ribbon icon.
* **Note**: The ribbon icons for the module currently in use (at the top right) are not necessarily visible:
- the pop-up menu (right click) in the ribbon shows the groups of icons displayed and those that are not and allows them to be managed.
-
-A new window appears in the main view: the *Eficas Pytel* Viewer. Its ribbon contains the commands for creating, opening, saving
-and editing Pytel calculation cases.
-
- |CreateCasePytel|
-
-It is necessary to redefine the main files of interest to the case here, which means retrieving and completing elements defined
-in the previous step, so there will be a few repetitions.
-
-A new Pytel case is created with the *New* command in the *Eficas Pytel* Viewer ribbon. In the new view pane, select the *PYTEL* command
-in the central panel.
-
- |SelectCommandPytel|
-
-The left hand panel displays the case tree, the structure of which appears progressively as the case is built:
-the red entries are invalid, the green are valid and the yellow are incomplete. The red status indicator of an invalid entry
-is applied recursively to all items in the corresponding hierarchy up to the root.
-All terminal (leaf) nodes displayed in red or yellow have to be corrected or completed in order to create a valid case.
-
-The central panel indicates the available list of optional commands.
-
- |CasPytel|
-
-Select the REPERTOIRE_TRAVAIL (*Working directory*) Keyword option.
-
-This directory will contain the intermediate files that are relevant to the calculation.
-The name of an *existing directory, other than the directory containing the original files*, must be entered and validated.
-You can, for example, create a subdirectory *work* in the case data directory.
-
-The directory appears in the tree with a green status indicator.
-
- |CasPytelRepTravail|
-
-Next, select the compulsory Case File command (*FICHIER_CAS*), showing a red status in the tree, then find the existing file and validate.
-
- |CasPytelFichierCas|
-
-The status command in the tree turns green.
-
-Now click on Pytel in the tree to see the *MED input* and *MED output* optional commands and select the former: *ENTREE_MED*.
+ the pop-up menu (right click) in the ribbon shows the groups of icons displayed and those that are not and allows them to be managed.
-The command appears in the tree, in yellow, indicating that it is incomplete.
+ |eficas_05|
- |CasPytelEntreeMedIncomplete|
+ |eficas_06|
-The two rubrics in red have to be completed with the names of the boundary conditions files and the mesh file containing the altitude field.
+Use the file previously created with EFICAS.
-The same has to be done for the output file, *SORTIE_MED*. Here, a non-existent file name can be given.
+ |eficas_07|
-Once everything is complete and valid, save the case with the *Save* button in the Eficas window.
+Save PYTEL case.
- |CasPytelSave|
+ |eficas_08|
-The case now appears in the study tree.
+The case appears in the study tree.
|CasPytelArbre|
Launching the PYTEL Calculation Case
====================================
-The *Compute Case* command of the Case menu is used to launch the Telemac simulation.
+The *Compute Case* command of the Case menu is used to launch the Telemac simulation
- |CasPytelComputeCase|
+ |eficas_09|
-While the calculation is running, an onscreen listing of the computation (log file) is displayed in a window.
+While the calculation is running, an onscreen listing of the computation (log file) is displayed in a window.
- |CasPytelCalcul|
+ |eficas_10|
-The window can be closed at the end of the computation.
+The window can be closed at the end of the computation.
|CasPytelFinCalcul|
along with SALOME HYDRO module. If not, see <http://www.gnu.org/licenses/>.
#########################################
-TELEMAC data entry
+TELEMAC setup
#########################################
+.. |HYDROSolver| image:: /../_static/HYDROSolver.png
+ :align: middle
+ :width: 16pt
+ :height: 16pt
+
+.. |eficas_04| image:: /../_static/eficas_04.png
+ :align: middle
+ :width: 16pt
+ :height: 16pt
+
.. |genereCondlim| image:: /../_static/genereCondlim.png
:align: middle
-Once the mesh is generated with the altimetry data, it remains to define the nature of the boundary condition regions,
-the values of the flow rate and water depth boundary conditions over time and all the physical and numerical model parameters.
-The Telemac manual should be consulted for the parameter definitions.
+.. |eficas_01| image:: /../_static/eficas_01.png
+ :align: middle
+
+.. |eficas_02| image:: /../_static/eficas_02.png
+ :align: middle
+
+.. |eficas_03| image:: /../_static/eficas_03.png
+ :align: middle
+
+.. |eficas_20| image:: /../_static/eficas_20.png
+ :align: middle
+
+.. |eficas_21| image:: /../_static/eficas_21.png
+ :align: middle
+
+.. |eficas_22| image:: /../_static/eficas_22.png
+ :align: middle
+
+.. |eficas_23| image:: /../_static/eficas_23.png
+ :align: middle
+
+Once the mesh is generated with the altimetry data, it remains to define the nature of the boundary condition regions,
+the values of the flow rate and water depth boundary conditions over time and all the physical and numerical model parameters.
+The TELEMAC manual should be consulted for the parameter definitions.
This information is compiled in several text files (ASCII) that are now going to be generated or manually edited.
**The abovementioned files will be stored in the same directory as the mesh.**
+You must activate the HYDROSOLVER module, through the scrolling list of imodules, or its icon in the banner: |HYDROSolver|.
+The HYDROSOLVER module supports physico-numerical data setup and calculations for codes
+TELEMAC and MASCARET and their couplings.
+
Characterization of boundary regions
====================================
-The boundary condition regions were defined in the previous steps and are incorporated by named groups of mesh elements.
+The boundary condition regions were defined in the previous
+steps and are incorporated by named groups of mesh elements.
The *condlim.bcd* file associates specific types of boundary condition (inlet, outlet, wall, etc.) to each group.
-Four integer values define a boundary condition type.
+Four integer values define a boundary condition type.
-The first line indicates the number of boundary conditions defined and is followed by four lines:
-one per boundary condition. Each line contains four integers (the type) as well as the name of the group.
+The first line indicates the number of boundary conditions defined and is followed by four lines:
+one per boundary condition. Each line contains four integers (the type) as well as the name of the group.
-Nous pouvons générer le fichier à partir de la commande *Edit boundary conditions file* du module *HYDROSOLVER*.
+This file caan be created with de command *Edit boundary conditions file* from *HYDROSOLVER* module.
-Il faut définir en entrée le chemin du fichier MED utilisé, et en sortie, le chemind du fichier des zones de conditions limites.
-L'entree *Boundary condition file* ne sert que pour lire un fichier existant.
+The path of the MED file used must be defined as input, and the file path of the boundary condition fields as output.
+The *Boundary condition file* entry is used only to read/edit an existing file.
-Il faut sélectionner le type de condition limite sur les zones amont, aval, bord gauche et droit, et ne rien mettre sur les autres groupes.
+You must select the boundary condition type on the upstream, downstream, left and right bank,
+and do not put anything on the other groups.
|genereCondlim|
-
+
The result file looks like this:
.. literalinclude:: ../condlim.bcd
:lines: 1-
* **Note**: It is no longer necessary to create the .cli file specified in the Telemac manual,
- which lists all the boundary condition nodes with the types associated. This file is automatically generated.
+ which lists all the boundary condition nodes with the types associated. This file is automatically generated.
Values of the discharge and water elevation boundary conditions
===============================================================
-The *init.lqd* file contains the values of the flow rate and water depth boundary conditions over time.
-Reference should be made to the Telemac manual for more precise details on the file definition.
+The *init.lqd* file contains the values of the flow rate and water depth boundary conditions over time.
+Reference should be made to the Telemac manual for more precise details on the file definition.
.. literalinclude:: ../init.lqd
:lines: 1-
The *init.cas* file lists the other files, which must be in the same directory.
It then gives the different physical and numerical parameters required for the simulation (calculation case).
-As mentioned before, the Telemac manual should be consulted for the definition of these parameters.
+As mentioned before, the Telemac manual should be consulted for the definition of these parameters.
* **Note**: for version 1.0 (March 2016), the presence of a Fortran file is compulsory, even if it only contains one comment line
- (it is necessary to force the recompilation of the TELEMAC executable). In the init.cas file,
- the comment in front of the FORTRAN FILE keyword must be deleted and the corresponding file created.
+ (it is necessary to force the recompilation of the TELEMAC executable). In the init.cas file,
+ the comment in front of the FORTRAN FILE keyword must be deleted and the corresponding file created.
.. literalinclude:: ../init.cas
:lines: 1-
-
+
+Steering file setup through EFICAS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are 2 methods to perform this, with the module *HYDROSOLVER*:
+
+* **with the menus:** in HYDRO menu, click on *Edit cas file*
+
+ |eficas_01|
+
+* **with the icons:** When the Hydrosolver module is activated, new buttons appear in the toolbar.
+ Right click on Edit case file
+
+ |eficas_02|
+
+Click New to create a case file.
+
+ |eficas_03|
+
+Complete all red items. When a sub-heading or heading is complete it changes to green.
+Some green items are setup with the default value but the user can overwrite them.
+Save (regularly) the created case. To do this, go to *File/Save* or *Save as*
+or click on the icon |eficas_04|.
+The file will be saved as *.comm* or *.jdc*.
+
+How EFICAS works?
+~~~~~~~~~~~~~~~~~
+
+In thecentral interface, at the level of the heading, in the right-hand section entitled Settings *NOM DE RUBRIQUE*,
+optional keywords appear and can be added to the corresponding sub-heading,
+by double-clicking the square box in front of the keyword.
+
+**Example:** To add the keyword *Control_section* in *Output_Files*. Double-click on the right:
+
+ |eficas_20|
+
+It appears in the *Output_Files* sub-section. In the central screen, other keywords appears in the right part under the title
+*Control_Section*. I can add them in the same way.
+
+ |eficas_21|
+
+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:
+
+|eficas_22|
+
+If you click on the keyword with the mouse the help appears at the bottom left:
+
+ |eficas_23|
+
+**Parameters by section and sub-section**
+
+In *Computation_Environment*, by default, we find:
+
+ * *Initialization*: concerns input data files such as the geometry file and the boundary conditions file.
+ To take the title into account, type the desired name and enter.
+
+ * *Restart*: to restart from a previous computation.
+
+ * *Output_files*: result files, listing and their options.
+
+In *Hydro*, by default, we find:
+
+ * *Boundary_Conditions*: boundary condition files
+ (files for liquid boundaries, stage-discharge curves, prescribed elevation or flowrate…)
+
+ * *Physical_Parameters_Hydro*: Physical parameters for hydrodynamics. Waves, meteo, source terms…
+
+ * *Numerical_Parameters_Hydro*: Numerical parameters for hydrodynamics, linear system options.
+
+In *General_Parameters*, by default, we find:
+
+ * *Debugger*: debugger mode or not.
+
+ * *Time*: time step, duration…
+
+ * *Location*: coordinates origin…
+
+In *Numerical_Parameters*, by default, we find:
+
+ * *Solver_Info*: solver setup
+
+ * *Discretizations_Implicitation*: implicitation for depth, velocity, space discretization…
+
+ * *Propagation_Info*
+
+ * *Advection_Info*: mass lumping, free surface gradient compatibility…
+
+ * *Diffusion*: velocity diffusion, option for velocity diffusion…
+
+ * *Automatic_Differentiation*
+
+ * *Advanced*: matrix storage, matrix-vector product…
+
+**Developement in progress**
+
+In the end, the user can choose from pre-filled "template case files". These include:
+
+ * A flood model case file,
+
+ * A maritime model case file,
+
+ * A thermal case model file.
+
.. only:: html
:ref:`ref_exempleInondation`
