README

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