doc/salome/gui/HYDRO/input/mainpage.doc

   1
   2 /**
   3   @file
   4   \brief Help for the main page of the HYDROGUI module
   5 */
   6
   7 /**
   8   @mainpage
   9
  10   <b>The HYDRO documentation is divided in several parts:</b>
  11  - <b>a tutorial in French:</b> <A HREF="../HYDRO_tutorial/index.html">Here </A> or <A HREF="../HYDRO_tutorial/moduleHYDRO_tutoriel.pdf">in a pdf file</A>
  12  - <b>the same tutorial in English:</b> <A HREF="../HYDRO_English_tutorial/index.html">Here </A> or <A HREF="../HYDRO_English_tutorial/moduleHYDRO_tutorial.pdf">in a pdf file</A>
  13  - <b>the reference documentation below </b>
  14
  15   <hr>
  16
  17   The HYDRO GUI project has been developed for a hydrodynamic laboratory in the EDF R&D company
  18   in the domain of the landscape modelling (construction of channels, dams, changing the course of the rivers etc).
  19   It represents a pre-processor for the geometry modelling of the natural and artificial objects on the landscape.
  20   The user starts work with raster maps where he can create analytic curves and regions describing the existing natural objects,
  21   such as banks, coasts, lakes, rivers etc. Also he can create artificial objects (channel, dam) using the algorithms of the geometry modelling.
  22   The objects are referenced to the real territory using the geodesic coordinates.
  23    Finally the constructed landscape study is prepared for the further meshing and using in the hydrodynamic solvers.
  24
  25   The HYDRO module is implemented on the base of the SALOME platform and powered by the OpenCascade and SALOME platforms.
  26
  27   It supports the following features:
  28   - raster maps (import from files and georeferencement by geodesic coordinates);
  29   - geometry curves (creation on the map and import from SALOME GEOM module);
  30   - geometry objects (creation and import from SALOME GEOM module);
  31   - support of natural objects (immersible zones, lakes, rivers) and artificial objects (obstacles, channels, dams);
  32   - georeferencement of the objects when the objects are connected with points on real territory using the geodesic coordinates;
  33   - geometry algorithms on analytic objects (extrusion, partition) for complex objects construction;
  34   - support of the results of the territory level measurement (bathymetry);
  35   - partition of objects on zones of intersection and specifying the properties for these zones;
  36
  37   In the perspective the pre-processor can be completed by the post-processor showing the calculated results.
  38
  39   The HYDROGUI module supports the following objects:
  40   - \ref imzone "Immersible zone"
  41   - \ref p_profile "Profile"
  42         - \ref create_profile  "Create profile"
  43         - \ref import_profile  "Import profile"
  44         - \ref georeferencement_profile  "Profile georeferencement"
  45   - \ref art_digue "Digue"
  46   - \ref art_channel "Channel"
  47   - \ref obstacle  "Obstacle"
  48         - \ref box_obstacle  "Create Box obstacle"
  49         - \ref cylinder_obstacle  "Create Cylinder obstacle"
  50         - \ref import_obstacle_GEOM  "Import obstacle from GEOMETRY"
  51         - \ref import_obstacle  "Import obstacle from file"
  52         - \ref translate_obstacle "Translation of an obstacle"
  53
  54
  55   - \ref polyline3d "Polyline 3D"
  56   - \ref polyline "Polyline"
  57         - \ref export_polyline "Export polyline"
  58         - \ref import_polyline "Import polyline"
  59   - \ref bathymetry "Bathymetry"
  60   - \ref strickler_table "Strickler table"
  61         - \ref export_strickler_table "Export strickler table"
  62         - \ref import_strickler_table "Import strickler table"
  63   - \ref stream "Stream"
  64         - \ref impimage "Find bottom"
  65         - \ref profilesinterpolation "Profiles interpolation"
  66   - \ref image "Image"
  67         - \ref impimage "Import image"
  68         - \ref fuseimages "Fuse images"
  69         - \ref cutimages "Cut images"
  70         - \ref splitimage "Split image"
  71  - \ref calculation_case "Calculation case"
  72
  73 The HYDROGUI module supports the following \ref general_services "services":<br>
  74
  75
  76   - \ref general_services "General services"
  77         - \ref preferences  "Preferences"
  78         - \ref save "Save file"
  79         - \ref open "Open file"
  80         - \ref dump_study "Dump study"
  81         - \ref load_script "Load script"
  82         - \ref undo_redo "Undo/Redo actions"
  83         - \ref copy_paste "Copy/Paste object(s)"
  84         - \ref delete "Delete object(s)"
  85         - \ref color "Color object"
  86         - \ref show_hide "Show/Hide object(s)"
  87         - \ref update "Update object"
  88         - \ref rename "Rename object"
  89         - \ref submersible "Submersible"
  90         - \ref copy_position "Copy position"
  91         - \ref change_layer_order "Change layer order"
  92         - \ref local_cs "Local CS"
  93
  94
  95 */