X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=f15a49b8df36d4a1669a674473bc6e4558ad0f8b;hb=1bd53c649e6e3fb7d322a5fc2a6e6881ee6b13f7;hp=7289e6515561c1b2b537d6c563ed71d6853d71c9;hpb=58d0fa02d026abb84dd205a07f19335c457c01d7;p=plugins%2Fghs3dprlplugin.git diff --git a/README b/README index 7289e65..f15a49b 100644 --- a/README +++ b/README @@ -1,128 +1,148 @@ -SALOME platform -GHS3DPRL meshing plugin ------------------------------- +************************************** +About SALOME MG-Tetra Parallel plug-in +************************************** -Contents: +SALOME MG-Tetra Parallel plug-in adds DISTENE MG-Tetra Parallel (former GHS3DPRL) +meshing algorithm to the SALOME Mesh module. -1. Pre-requisites -2. Installation -3. Launch SALOME with GHS3DPRLPLUGIN -4. GHS3DPRLPLUGIN plugin usage +MG-Tetra Parallel plug-in is destined for: +- Meshing of 3D geometric entities: volumes are split into tetrahedral (pyramidal) + elements. +- Generating of 3D meshes from 2D meshes, working without geometrical objects. ------------------ -1. Pre-requisites ------------------ +For more information please visit the SALOME platform web site: -The information in this file assumes that: + -* The SALOME platform is installed to the directory -* The GHS3DPRL (Tepal) product is installed to the directory /ghs3dprl +======= +License +======= ---------------- -2. Installation ---------------- +SALOME platform is distributed under the GNU Lesser General Public License. +See COPYING file for more details. -2.1. Unpack GHS3DPRLPLUGIN module sources +Also, additional information can be found at SALOME platform web site: -cd -tar zxf GHS3DPRLPLUGIN_SRC.tgz + -2.2. Build GHS3DPRLPLUGIN module +============ +Installation +============ -* set environment +-------------- +Pre-requisites +-------------- -bash -cd -source env_build.sh -export GHS3DPRLHOME=/ghs3dprl +SALOME platform relies on a set of third-party softwares; some of them are needed +at build time only, while other ones are needed in runtime also. -Note: you can avoid setting GHS3DPRLHOME environment variable but use ---with-ghs3dprl key of configure script instead. You can also compile -plugin withour GHS3DPRL product installation. But you'll need to add -path to the tepal executable to the PATH environment variable in order -to use GHS3DPRL meshing plugin within SALOME. +For more information about the pre-requisites please visit SALOME platform web +site: -* configure build system +* Check Release Notes and Software Requirements of the latest SALOME release at -cd GHS3DPRLPLUGIN_SRC -./build_configure + -cd .. -mkdir GHS3DPRLPLUGIN_BUILD -cd GHS3DPRLPLUGIN_BUILD -../GHS3DPRLPLUGIN_SRC/configure --prefix=/GHS3DPRLPLUGIN_INSTALL +* Pre-requisites page at SALOME web site: -Note: you can use --with-ghs3dprl option to pass the root directory of -ghs3dprl product to the configure script. In this case you can avoid -setting GHS3DPRLHOME environment variable. Try 'configure --help' -command to learn more about available configure script options. + -Check "Summary" area in the log output of the configure script to -verify that all pre-requisites required for the successful compilation -of GHS3DPRLPLUFIN module have been found. All pre-requisite products -should have status "yes". If any product has status "no", the -compilation procedure will fail (the only exception is GHS3DPRL -product which is not required for the successful compilation of the -plugin; it is needed in run-time only). +Note: SALOME MG-Tetra Parallel plug-in needs SALOME KERNEL, SALOME GUI, +SALOME Geometry and SALOME Mesh as pre-requisites. -* compile and install plugin module +------------------ +Basic Installation +------------------ -make -make install +The build procedure of the SALOME platform is implemented with CMake. +In order to build the plug-in you have to do the following actions: -exit +1. Set up environment for pre-requisites (see "Pre-requisites" section above). -If the compilation is finished successfully (make and make install -steps are finished without errors) the GHS3DPRLPLUGIN meshing module -should be installed in the directory /GHS3DPRLPLUGIN_INSTALL. +2. Create a build directory: ----------------------------------- -3. Launch SALOME with GHS3DPRLPLUGIN ----------------------------------- + % mkdir GHS3DPRLPLUGIN_BUILD -* set environment +3. Configure the build procedure: -bash -cd -source env_products.sh + % cd GHS3DPRLPLUGIN_BUILD + % cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= -export GHS3DPRLPLUGIN_ROOT_DIR=/GHS3DPRLPLUGIN_INSTALL -export SalomeAppConfig=${GHS3DPRLPLUGIN_ROOT_DIR}/share/salome/resources/ghs3dprlplugin -export PATH=/ghs3dprl:${PATH + where + - is either Release or Debug (default: Release); + - is a destination folder to install SALOME MG-Tetra + Parallel plug-in (default: /usr); + - is a path to the SALOME MG-Tetra Parallel plug-in sources + directory. -* run SALOME + Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-Tetra + Parallel plug-in will be configured for installation to the /usr directory that + requires root permissions to complete the installation. -runSalome +4. Build and install: ----------------------------- -4. GHS3DPRLPLUGIN plugin usage ----------------------------- + % make + % make install -* Create new study + This will install SALOME MG-Tetra Parallel plug-in to the + specified to cmake command on the previous step. -* Activate Geometry module and create simple geometry object +------------------- +Custom installation +------------------- -* Activate Mesh module +SALOME MG-Tetra Parallel plug-in supports a set of advanced configuration options; +for more details learn CMakeLists.txt file in the root source directory. -* Invoke menu "Mesh/Create Mesh" +You can also use other options of cmake command to customize your installation. +Learn more about available options by typing + + % cmake --help + +===== +Usage +===== + +* Start SALOME. + +* Create new study. + +* Activate Geometry module and create simple geometry object. + +* Activate Mesh module. + +* Invoke menu "Mesh/Create Mesh". * Select previously created geometry object by clicking it with the -mouse in the Object Browser + mouse in the Object Browser. * In the "Create mesh" dialog box: -- activate "3D" page -- In the "Algorithm" combo box select "GHS3DPRL" -- Click on the button at the right of the "Hypothesis" combo box and -select "GHS3DPRL parameters" item in the drop-down menu + - activate "3D" page; + - In the "Algorithm" combo box select "MG-Tetra Parallel"; + - Click on the button at the right of the "Hypothesis" combo box and + select "MG-Tetra Parallel Parameters" item in the drop-down menu. -* In the "Hypothesis Construction" dialog box set parameters of GHS3DPRL - meshing algorithm and click "OK" button +* In the "Hypothesis Construction" dialog box set parameters of + meshing algorithm and click "OK" button. * In the "Create mesh" dialog box Click "Apply & Close" button to - define mesh and close the dialog box + define mesh and close the dialog box. * In the Object Browser select "Mesh_1" object, invoke context popup -menu for it by clicking right mouse button and select "Compute" item + menu for it by clicking right mouse button and select "Compute" item. -The resulting mesh created with GHS3DPRL plugin will be shown in the 3D +The resulting mesh created with MG-Tetra Parallel plugin will be shown in the 3D viewer. + +============= +Documentation +============= + +The directory doc contains additional documentation file of SALOME MG-Tetra +Parallel plug-in. + +=============== +Troubleshooting +=============== + +Please, send a mail to webmaster.salome@opencascade.com.