README

   1 SALOME platform
   2 GHS3DPRL meshing plugin
   3 ------------------------------
   4
   5 Contents:
   6
   7 1. Pre-requisites
   8 2. Installation
   9 3. Launch SALOME with GHS3DPRLPLUGIN
  10 4. GHS3DPRLPLUGIN plugin usage
  11
  12 -----------------
  13 1. Pre-requisites
  14 -----------------
  15
  16 The information in this file assumes that:
  17
  18 * The SALOME platform is installed to the directory <salome>
  19 * The GHS3DPRL (Tepal) product is installed to the directory <salome>/ghs3dprl
  20
  21 ---------------
  22 2. Installation
  23 ---------------
  24
  25 2.1. Unpack GHS3DPRLPLUGIN module sources
  26
  27 cd <salome>
  28 tar zxf GHS3DPRLPLUGIN_SRC.tgz
  29
  30 2.2. Build GHS3DPRLPLUGIN module
  31
  32 * set environment
  33
  34 bash
  35 cd <salome>
  36 source env_build.sh
  37 export GHS3DPRLHOME=<salome>/ghs3dprl
  38
  39 Note: you can avoid setting GHS3DPRLHOME environment variable but use
  40 --with-ghs3dprl key of configure script instead. You can also compile
  41 plugin withour GHS3DPRL product installation. But you'll need to add
  42 path to the tepal executable to the PATH environment variable in order
  43 to use GHS3DPRL meshing plugin within SALOME.
  44
  45 * configure build system
  46
  47 cd GHS3DPRLPLUGIN_SRC
  48 ./build_configure
  49
  50 cd ..
  51 mkdir GHS3DPRLPLUGIN_BUILD
  52 cd GHS3DPRLPLUGIN_BUILD
  53 ../GHS3DPRLPLUGIN_SRC/configure --prefix=<salome>/GHS3DPRLPLUGIN_INSTALL
  54
  55 Note: you can use --with-ghs3dprl option to pass the root directory of
  56 ghs3dprl product to the configure script. In this case you can avoid
  57 setting GHS3DPRLHOME environment variable. Try 'configure --help'
  58 command to learn more about available configure script options.
  59
  60 Check "Summary" area in the log output of the configure script to
  61 verify that all pre-requisites required for the successful compilation
  62 of GHS3DPRLPLUFIN module have been found. All pre-requisite products
  63 should have status "yes". If any product has status "no", the
  64 compilation procedure will fail (the only exception is GHS3DPRL
  65 product which is not required for the successful compilation of the
  66 plugin; it is needed in run-time only).
  67
  68 * compile and install plugin module
  69
  70 make
  71 make install
  72
  73 exit
  74
  75 If the compilation is finished successfully (make and make install
  76 steps are finished without errors) the GHS3DPRLPLUGIN meshing module
  77 should be installed in the directory <salome>/GHS3DPRLPLUGIN_INSTALL.
  78
  79 ----------------------------------
  80 3. Launch SALOME with GHS3DPRLPLUGIN
  81 ----------------------------------
  82
  83 * set environment
  84
  85 bash
  86 cd <salome>
  87 source env_products.sh
  88
  89 export GHS3DPRLPLUGIN_ROOT_DIR=<salome>/GHS3DPRLPLUGIN_INSTALL
  90 export SalomeAppConfig=${GHS3DPRLPLUGIN_ROOT_DIR}/share/salome/resources/ghs3dprlplugin
  91 export PATH=<salome>/ghs3dprl:${PATH
  92
  93 * run SALOME
  94
  95 runSalome
  96
  97 ----------------------------
  98 4. GHS3DPRLPLUGIN plugin usage
  99 ----------------------------
 100
 101 * Create new study
 102
 103 * Activate Geometry module and create simple geometry object
 104
 105 * Activate Mesh module
 106
 107 * Invoke menu "Mesh/Create Mesh"
 108
 109 * Select previously created geometry object by clicking it with the
 110 mouse in the Object Browser
 111
 112 * In the "Create mesh" dialog box:
 113 - activate "3D" page
 114 - In the "Algorithm" combo box select "GHS3DPRL"
 115 - Click on the button at the right of the "Hypothesis" combo box and
 116 select "GHS3DPRL parameters" item in the drop-down menu
 117
 118 * In the "Hypothesis Construction" dialog box set parameters of GHS3DPRL
 119   meshing algorithm and click "OK" button
 120
 121 * In the "Create mesh" dialog box Click "Apply & Close" button to
 122   define mesh and close the dialog box
 123
 124 * In the Object Browser select "Mesh_1" object, invoke context popup
 125 menu for it by clicking right mouse button and select "Compute" item
 126
 127 The resulting mesh created with GHS3DPRL plugin will be shown in the 3D
 128 viewer.