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