README

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