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