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