README

   1 SALOME platform
   2 HYBRID meshing plugin
   3 ------------------------------
   4
   5 Contents:
   6
   7 1. Pre-requisites
   8 2. Installation
   9 3. Launch SALOME with HYBRIDPLUGIN
  10 4. HYBRIDPLUGIN 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 HYBRID (Tepal) product is installed to the directory <salome>/hybridprl
  20
  21 ---------------
  22 2. Installation
  23 ---------------
  24
  25 2.1. Unpack HYBRIDPLUGIN module sources
  26
  27 cd <salome>
  28 tar zxf HYBRIDPLUGIN_SRC.tgz
  29
  30 2.2. Build HYBRIDPLUGIN module
  31
  32 * set environment
  33
  34 bash
  35 cd <salome>
  36 source env_build.sh
  37
  38 * cmake build procedure
  39
  40 mkdir HYBRIDPLUGIN_BUILD
  41 cd HYBRIDPLUGIN_BUILD
  42 cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<HYBRIDPLUGIN_INSTALL> ../HYBRIDPLUGIN_SRC
  43
  44 ,where <Mode> is build mode (Release or Debug),
  45 <HYBRIDPLUGIN_INSTALL> is a destination folder to install
  46 HYBRIDPLUGIN module of SALOME.
  47
  48 Verify that all pre-requisites required for the successful compilation
  49 of HYBRIDPLUGIN module have been found.
  50
  51 * compile and install plugin module
  52
  53 make
  54 make install
  55
  56 exit
  57
  58 If the compilation is finished successfully (make and make install
  59 steps are finished without errors) the HYBRIDPLUGIN meshing module
  60 should be installed in the directory <HYBRIDPLUGIN_INSTALL>.
  61
  62 ----------------------------------
  63 3. Launch SALOME with HYBRIDPLUGIN
  64 ----------------------------------
  65
  66 * set environment
  67
  68 bash
  69 cd <salome>
  70 source env_products.sh
  71
  72 export HYBRIDPLUGIN_ROOT_DIR=<HYBRIDPLUGIN_INSTALL>
  73 export SalomeAppConfig=${HYBRIDPLUGIN_ROOT_DIR}/share/salome/resources/hybridprlplugin
  74 export PATH=<salome>/hybridprl:${PATH
  75
  76 * run SALOME
  77
  78 runSalome
  79
  80 ----------------------------
  81 4. HYBRIDPLUGIN plugin usage
  82 ----------------------------
  83
  84 * Create new study
  85
  86 * Activate Geometry module and create simple geometry object
  87
  88 * Activate Mesh module
  89
  90 * Invoke menu "Mesh/Create Mesh"
  91
  92 * Select previously created geometry object by clicking it with the
  93 mouse in the Object Browser
  94
  95 * In the "Create mesh" dialog box:
  96 - activate "3D" page
  97 - In the "Algorithm" combo box select "HYBRID"
  98 - Click on the button at the right of the "Hypothesis" combo box and
  99 select "HYBRID parameters" item in the drop-down menu
 100
 101 * In the "Hypothesis Construction" dialog box set parameters of HYBRID
 102   meshing algorithm and click "OK" button
 103
 104 * In the "Create mesh" dialog box Click "Apply & Close" button to
 105   define mesh and close the dialog box
 106
 107 * In the Object Browser select "Mesh_1" object, invoke context popup
 108 menu for it by clicking right mouse button and select "Compute" item
 109
 110 The resulting mesh created with HYBRID plugin will be shown in the 3D
 111 viewer.