README

   1 **************************************
   2 About SALOME MG-Tetra Parallel plug-in
   3 **************************************
   4
   5 SALOME MG-Tetra Parallel plug-in adds DISTENE MG-Tetra Parallel (former GHS3DPRL)
   6 meshing algorithm to the SALOME Mesh module.
   7
   8 MG-Tetra Parallel plug-in is destined for:
   9 - Meshing of 3D geometric entities: volumes are split into tetrahedral (pyramidal)
  10   elements.
  11 - Generating of 3D meshes from 2D meshes, working without geometrical objects.
  12
  13 For more information please visit the SALOME platform web site:
  14
  15   <https://www.salome-platform.org/>
  16
  17 =======
  18 License
  19 =======
  20
  21 SALOME platform is distributed under the GNU Lesser General Public License.
  22 See COPYING file for more details.
  23
  24 ============
  25 Installation
  26 ============
  27
  28 --------------
  29 Pre-requisites
  30 --------------
  31
  32 SALOME platform relies on a set of third-party softwares; some of them are needed
  33 at build time only, while other ones are needed in runtime also.
  34
  35 For more information about the pre-requisites please visit SALOME platform web
  36 site:
  37
  38 * Check Release Notes and Software Requirements of the latest SALOME release at
  39
  40   <https://www.salome-platform.org/?page_id=15/>
  41
  42 Note: SALOME MG-Tetra Parallel plug-in needs SALOME KERNEL, SALOME GUI,
  43 SALOME Geometry and SALOME Mesh as pre-requisites.
  44
  45 ------------------
  46 Basic Installation
  47 ------------------
  48
  49 The build procedure of the SALOME platform is implemented with CMake.
  50 In order to build the plug-in you have to do the following actions:
  51
  52 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  53
  54 2. Create a build directory:
  55
  56    % mkdir GHS3DPRLPLUGIN_BUILD
  57
  58 3. Configure the build procedure:
  59
  60    % cd GHS3DPRLPLUGIN_BUILD
  61    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  62
  63    where
  64    - <mode> is either Release or Debug (default: Release);
  65    - <installation_directory> is a destination folder to install SALOME MG-Tetra
  66      Parallel plug-in (default: /usr);
  67    - <path_to_src_dir> is a path to the SALOME MG-Tetra Parallel plug-in sources
  68      directory.
  69
  70    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-Tetra
  71    Parallel plug-in will be configured for installation to the /usr directory that
  72    requires root permissions to complete the installation.
  73
  74 4. Build and install:
  75
  76    % make
  77    % make install
  78
  79    This will install SALOME MG-Tetra Parallel plug-in to the <installation_directory>
  80    specified to cmake command on the previous step.
  81
  82 -------------------
  83 Custom installation
  84 -------------------
  85
  86 SALOME MG-Tetra Parallel plug-in supports a set of advanced configuration options;
  87 for more details learn CMakeLists.txt file in the root source directory.
  88
  89 You can also use other options of cmake command to customize your installation.
  90 Learn more about available options by typing
  91
  92    % cmake --help
  93
  94 =====
  95 Usage
  96 =====
  97
  98 * Start SALOME.
  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 "3D" page;
 113   - In the "Algorithm" combo box select "MG-Tetra Parallel";
 114   - Click on the button at the right of the "Hypothesis" combo box and
 115     select "MG-Tetra Parallel Parameters" item in the drop-down menu.
 116
 117 * In the "Hypothesis Construction" dialog box set parameters of
 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 MG-Tetra Parallel plugin will be shown in the 3D
 127 viewer.
 128
 129 =============
 130 Documentation
 131 =============
 132
 133 The directory doc contains additional documentation file of SALOME MG-Tetra
 134 Parallel plug-in.
 135
 136 ===============
 137 Troubleshooting
 138 ===============
 139
 140 Please, send a mail to webmaster.salome@opencascade.com.