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