README

   1 *******************************
   2 About SALOME MG-CADSurf plug-in
   3 *******************************
   4
   5 SALOME MG-CADSurf plug-in adds DISTENE MG-CADSurf (former BLSURF) meshing algorithm
   6 to the SALOME Mesh module.
   7
   8 MG-CADSurf meshing algorithm is destined for generation of 2D meshes basing
   9 on the 2D geometric entities (faces).
  10
  11 For more information please visit the SALOME platform web site:
  12
  13   <http://www.salome-platform.org/>
  14
  15 =======
  16 License
  17 =======
  18
  19 SALOME platform is distributed under the GNU Lesser General Public License.
  20 See COPYING file for more details.
  21
  22 Also, additional information can be found at SALOME platform web site:
  23
  24   <http://www.salome-platform.org/downloads/license/>
  25
  26 ============
  27 Installation
  28 ============
  29
  30 --------------
  31 Pre-requisites
  32 --------------
  33
  34 SALOME platform relies on a set of third-party softwares; some of them are needed
  35 at build time only, while other ones are needed in runtime also.
  36
  37 For more information about the pre-requisites please visit SALOME platform web
  38 site:
  39
  40 * Check Release Notes and Software Requirements of the latest SALOME release at
  41
  42   <http://www.salome-platform.org/downloads/current-version/>
  43
  44 * Pre-requisites page at SALOME web site:
  45
  46   <http://www.salome-platform.org/downloads/license/>
  47
  48 Note: SALOME MG-CADSurf plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry
  49 and SALOME Mesh as pre-requisites.
  50
  51 ------------------
  52 Basic Installation
  53 ------------------
  54
  55 The build procedure of the SALOME platform is implemented with CMake.
  56 In order to build the plug-in you have to do the following actions:
  57
  58 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  59
  60 2. Create a build directory:
  61
  62    % mkdir BLSURFPLUGIN_BUILD
  63
  64 3. Configure the build procedure:
  65
  66    % cd BLSURFPLUGIN_BUILD
  67    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  68
  69    where
  70    - <mode> is either Release or Debug (default: Release);
  71    - <installation_directory> is a destination folder to install SALOME MG-CADSurf
  72      plug-in (default: /usr);
  73    - <path_to_src_dir> is a path to the SALOME MG-CADSurf plug-in sources directory.
  74
  75    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-CADSurf
  76    plug-in will be configured for installation to the /usr directory that requires
  77    root permissions to complete the installation.
  78
  79 4. Build and install:
  80
  81    % make
  82    % make install
  83
  84    This will install SALOME MG-CADSurf plug-in to the <installation_directory>
  85    specified to cmake command on the previous step.
  86
  87 -------------------
  88 Custom installation
  89 -------------------
  90
  91 SALOME MG-CADSurf plug-in supports a set of advanced configuration options;
  92 for more details learn CMakeLists.txt file in the root source directory.
  93
  94 You can also use other options of cmake command to customize your installation.
  95 Learn more about available options by typing
  96
  97    % cmake --help
  98
  99 =====
 100 Usage
 101 =====
 102
 103 * Start SALOME.
 104
 105 * Create new study.
 106
 107 * Activate Geometry module and create simple geometry object.
 108
 109 * Activate Mesh module.
 110
 111 * Invoke menu "Mesh/Create Mesh".
 112
 113 * Select previously created geometry object by clicking it with the
 114   mouse in the Object Browser.
 115
 116 * In the "Create mesh" dialog box:
 117   - activate "2D" page;
 118   - In the "Algorithm" combo box select "MG-CADSurf";
 119   - Click on the button at the right of the "Hypothesis" combo box and
 120     select "MG-CADSurf parameters" item in the drop-down menu.
 121
 122 * In the "Hypothesis Construction" dialog box set parameters of MG-CADSurf
 123   meshing algorithm and click "OK" button
 124
 125 * In the "Create mesh" dialog box Click "Apply & Close" button to
 126   define mesh and close the dialog box
 127
 128 * In the Object Browser select "Mesh_1" object, invoke context popup
 129 menu for it by clicking right mouse button and select "Compute" item
 130
 131 The resulting mesh created with MG-CADSurf plugin will be shown in the 3D
 132 viewer.
 133
 134 =============
 135 Documentation
 136 =============
 137
 138 The directory doc contains additional documentation file of SALOME MG-CADSurf
 139 plug-in.
 140
 141 ===============
 142 Troubleshooting
 143 ===============
 144
 145 Please, send a mail to webmaster.salome@opencascade.com.