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 export BLSURFHOME=<salome>/blsurf
  39
  40 Note: you can avoid setting BLSURFHOME environment variable but use
  41 --with-blsurf key of configure script instead.
  42
  43 * configure build system
  44
  45 cd BLSURFPLUGIN_SRC
  46 ./build_configure
  47
  48 cd ..
  49 mkdir BLSURFPLUGIN_BUILD
  50 cd BLSURFPLUGIN_BUILD
  51 ../BLSURFPLUGIN_SRC/configure --prefix=<salome>/BLSURFPLUGIN_INSTALL
  52
  53 Note: you can use --with-blsurf option to pass the root directory of
  54 blsurf product to the confogure script. In this case you can avoid
  55 setting BLSURFHOME environment variable. Try 'configure --help'
  56 command to learn more about available configure script options.
  57
  58 Check "Summary" area in the log output of the configure script to
  59 verify that all pre-requisites required for the successful compilation
  60 of BLSURFPLUFIN module have been found. All pre-requisite products
  61 should have status "yes". If any product has status "no", the
  62 compilation procedure will fail.
  63
  64 * compile and install plugin module
  65
  66 make
  67 make install
  68
  69 exit
  70
  71 If the compilation is finished successfully (make and make install
  72 steps are finished without errors) the BLSURFPLUGIN meshing module
  73 should be installed in the directory <salome>/BLSURFPLUGIN_INSTALL.
  74
  75 ----------------------------------
  76 3. Launch SALOME with BLSURFPLUGIN
  77 ----------------------------------
  78
  79 * set environment
  80
  81 bash
  82 cd <salome>
  83 source env_products.sh
  84
  85 export BLSURFPLUGIN_ROOT_DIR=<salome>/BLSURFPLUGIN_INSTALL
  86 export SalomeAppConfig=${BLSURFPLUGIN_ROOT_DIR}/share/salome/resources/blsurfplugin
  87 export DISTENE_LICENSE_FILE=<salome>/dlim8.key
  88
  89 Note: DISTENE_LICENSE_FILE environment variable should point to the
  90 blsurf product license file.
  91
  92 * run SALOME
  93
  94 runSalome
  95
  96 ----------------------------
  97 4. BLSURFPLUGIN plugin usage
  98 ----------------------------
  99
 100 * Create new study
 101
 102 * Activate Geometry module and create simple geometry object
 103
 104 * Activate Mesh module
 105
 106 * Invoke menu "Mesh/Create Mesh"
 107
 108 * Select previously created geometry object by clicking it with the
 109 mouse in the Object Browser
 110
 111 * In the "Create mesh" dialog box:
 112 - activate "2D" page
 113 - In the "Algorithm" combo box select "BLSURF"
 114 - Click on the button at the right of the "Hypothesis" combo box and
 115 select "BLSURF parameters" item in the drop-down menu
 116
 117 * In the "Hypothesis Construction" dialog box set parameters of BLSURF
 118   meshing algorithm and click "OK" button
 119
 120 * In the "Create mesh" dialog box Click "Apply & Close" button to
 121   define mesh and close the dialog box
 122
 123 * In the Object Browser select "Mesh_1" object, invoke context popup
 124 menu for it by clicking right mouse button and select "Compute" item
 125
 126 The resulting mesh created with BLSURF plugin will be shown in the 3D
 127 viewer.