README

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