]> SALOME platform Git repositories - plugins/ghs3dprlplugin.git/commitdiff
Salome HOME
COTECH: Update names of DISTENE products V7_5_0a1
authoreap <eap@opencascade.com>
Thu, 11 Sep 2014 15:08:57 +0000 (19:08 +0400)
committereap <eap@opencascade.com>
Thu, 11 Sep 2014 15:08:57 +0000 (19:08 +0400)
  Almost full replacement of old names

doc/salome/gui/GHS3DPRLPLUGIN/doxyfile.in
doc/salome/gui/GHS3DPRLPLUGIN/doxyfile_py.in
doc/salome/gui/GHS3DPRLPLUGIN/images/ghs3dprl_parameters_basic.png
doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprl_hypo.doc
doc/salome/gui/GHS3DPRLPLUGIN/input/ghs3dprlplugin_python_interface.doc
doc/salome/gui/GHS3DPRLPLUGIN/input/index.doc
resources/SalomeApp.xml
src/GHS3DPRLPlugin/GHS3DPRLPluginBuilder.py

index 46be5e9d472bc8c41514207e97ec80c0e6ba3433..e94567382450040dee10a7daa73013b6fab49b75 100755 (executable)
@@ -20,7 +20,7 @@
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME      = "SALOME GHS3DPRLPLUGIN User's Guide"
+PROJECT_NAME      = "SALOME MG-Tetra Parallel plug-in User's Guide"
 OUTPUT_DIRECTORY  = GHS3DPRLPLUGIN
 CREATE_SUBDIRS   = NO
 OUTPUT_LANGUAGE   = English
index c6f479c67b61b97063f38a84a0cd55723f1b7932..b56202d1ee440732b16914f13afeda98fc66cd6a 100755 (executable)
@@ -20,7 +20,7 @@
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME           = "SALOME GHS3DPRLPLUGIN User's Guide"
+PROJECT_NAME           = "SALOME MG_Tetra Parallel Plug-in User's Guide"
 OUTPUT_DIRECTORY       = GHS3DPRLPLUGIN
 CREATE_SUBDIRS        = NO
 OUTPUT_LANGUAGE        = English
index cdf1c3d7b363b9d22349bfe2b52b1d4e6f8d4c37..78b369556114e5d4ab9ee5edcf3ae43e7e62c5af 100644 (file)
Binary files a/doc/salome/gui/GHS3DPRLPLUGIN/images/ghs3dprl_parameters_basic.png and b/doc/salome/gui/GHS3DPRLPLUGIN/images/ghs3dprl_parameters_basic.png differ
index 7b09aea7eaf54e4c5255fac9b9698ec77bf20484..867f796d17227bd16250774e04f6a1960321050b 100644 (file)
@@ -1,10 +1,11 @@
 /*!
 
-\page ghs3dprl_hypo_page MG-Tetra-hpc (Parallel) Parameters hypothesis
+\page ghs3dprl_hypo_page MG-Tetra Parallel Parameters hypothesis
 
-\n MG-Tetra-hpc Parameters hypothesis works only with <b>MG-Tetra-hpc</b> code (formerly tepal)
-which is the parallel implementation of MeshGems-Tetra (formerly TetMesh-GHS3D) algorithm. 
-This algorithm is a DISTENE commercial software, its use requires a licence.
+\n MG-Tetra Parameters hypothesis works only with <b>MG-Tetra</b>
+meshing algorithm which uses <b>MG-Tetra-hpc</b> code (formerly tepal)
+which is the parallel implementation of MG-Tetra (formerly TetMesh-GHS3D) algorithm. 
+This algorithm is a DISTENE commercial software, its use requires a license.
 \n
 See http://www.distene.com and http://www.meshgems.com/volume-meshing-meshgems-tetra.html.
 \n MG-Tetra-hpc (Tepal V3 in fact) gives the possibility to generate a partitioned
@@ -14,7 +15,7 @@ The launch of this version is described below.
 configuration with 64Go RAM to only try to make a partition of a mesh with
 200 million tetrahedrons, no result guaranteed (in 2010).
 \n
-\note The Plugin doesn't load in the Memory the supposedly large resulting meshes. 
+\note The plug-in doesn't load in the memory the supposedly large resulting meshes. 
 The meshes are saved in MED files and can be imported in the user-defined location via menu File-Import-MED Files.
 \n Pay attention, that Salome GUI needs 2Go RAM to load a MED
 file with 5 million tetrahedrons.
@@ -27,7 +28,7 @@ file with 5 million tetrahedrons.
 </li>
 <li>
 <b>MED Name</b> - allows to define the path and the prefix of the 
-resulting MED files ("DOMAIN" by default). 
+resulting MED files ("DOMAIN" by default).
 If the path is not defined, the environment variable $SALOME_TMP_DIR
 is used. If $SALOME_TMP_DIR is not defined as well, the environment
 variable $TMP is used.
@@ -38,42 +39,45 @@ The initial skin (triangles) will be meshed (tetrahedrons) and partitioned
 in Nb_Part by the elementary algorithm implemented in Tepal.<br>
 </li>
 <li>
-<b>Keep Files</b> - if this box is checked, input files of Tepal 
-(GHS3DPRL.points and GHS3DPRL.faces) are not deleted after use (...if the
+<b>Keep Files</b> - if this box is checked, input files of MG-Tetra-hpc
+(GHS3DPRL.points and GHS3DPRL.faces) are not deleted after use (if the
 background mode was not used).
 </li>
 <li>
-<b>Tetra_hpc in Background</b> - if this box is checked, Tetra_hpc execution
+<b>Tetra_hpc in Background</b> - if this box is checked, MG-Tetra-hpc execution
 and MED file generation are launched in background mode and the user
-can even exit Salome. Pay attention that in this case Tepal algorithm works
+can even exit Salome. Pay attention that in this case MG-Tetra-hpc algorithm works
 independently of "killSalome.py", and sometimes on another host.
 </li>
 <li>
-<b>Merge subdomains</b> - if this box is checked, merge the subdomains 
+<b>Merge subdomains</b> - if this box is checked, merge the sub-domains 
 into one mesh and write the output .mesh(b).
 </li>
 <li>
-<b>Tag subdomains</b> - if this box is checked, use the parallel subdomain 
+<b>Tag subdomains</b> - if this box is checked, use the parallel sub-domain 
 index as tag into the merged output mesh or not (used in combination with the 
-merge_subdomains option).
+<b>Merge subdomains</b> option).
 </li>
 <li>
-<b>Output interfaces</b> - if this box is checked, write the parallel subdomains interface 
-triangles into the merged output mesh (used in combination with the merge_subdomains option).
+<b>Output interfaces</b> - if this box is checked, write the parallel
+sub-domains interface triangles into the merged output mesh (used in
+combination with the <b>Merge subdomains</b> option).
 </li>
 <li>
-<b>Discard subdomains</b> - if this box is checked, discard the parallel subdomains 
+<b>Discard subdomains</b> - if this box is checked, discard the parallel sub-domains 
 (mesh, global numbering and interfaces).
 </li>
 
 <h1>Modifying MG-Tetra-hpc Advanced Parameters</h1><br>
-GHS3DPRL Plugin launches a standalone binary executable <b>tetrahpc2med</b>.<br>
-tetrahpc2med launches tetra_hpc, waits for the end of computation, and
-converts the resulting output tepal files into MED files.<br>
+MG-Tetra Parallel plug-in launches a standalone binary
+executable <b>tetrahpc2med</b>.<br>
+tetrahpc2med launches MG_Tetra-hpc, waits for the end of computation, and
+converts the resulting output files into MED files.<br>
 Some advanced optional parameters are accessible as arguments.<br>
 
-If keep_files option is checked, it is possible to re-launch tetrahpc2med
-or tetra_hpc in the Terminal as a command with custom parameters.<br>
+If <b>Keep Files</b> option is checked, it is possible to re-launch 
+\a tetrahpc2med or MG-Tetra-hpc in the Terminal as a command with
+custom parameters.<br> 
 
 <li>
 <b>Advanced tetrahpc2med Parameters</b> - type <b>tetrahpc2med --help</b> in the Terminal. <p>
@@ -185,8 +189,8 @@ Options:
 \n
 </li>
 
-<h1>Saving user's preferred GHS3DPRL Advanced Parameters</h1><br>
-GHS3DPRL Plugin launches standalone binary executable tetrahpc2med.<br>
+<h1>Saving user's preferred MG-Tetra Parallel Advanced Parameters</h1><br>
+MG-Tetra Parallel plug-in launches standalone binary executable tetrahpc2med.<br>
 You may rename file tetrahpc2med as tetrahpc2med.exe for example, and replace
 tetrahpc2med by a shell script at your convenience to overriding parameters.
 <br>... or else $PATH modification... .<br>
@@ -220,7 +224,7 @@ This 2014 beta-version needs MPI, (openmpi was used). To use it you have to proc
 #we have renamed binary executable tepal as tepal64_v2.exe.
 #typical command to launch tepal v1 :
 #tepal -f /tmp/myname/GHS3DPRL -n 16 > /tmp/myname/tepal.log
-#this file is an exemple to transform this call for tepal v2.0, 
+#this file is an example to transform this call for tepal v2.0, 
 #   (beta version using .mesh input file)
 #you have to adapt for your convenience.
 
@@ -233,7 +237,7 @@ This 2014 beta-version needs MPI, (openmpi was used). To use it you have to proc
 #third problem  is convert tepal v2 output files GHS3DPRL*.mesh
 #               to v1 input files GHS3DPRL*.faces an GHS3DPRL*.points.
 
-#you have to work on the same physical disk and same path input and ouput files : $SAME_DIR
+#you have to work on the same physical disk and same path input and output files : $SAME_DIR
 #you have to work on different physical disk but same path and name for executable files 
 #    (and shared libraries) : $DIFF_DIR
 
@@ -265,7 +269,7 @@ export LD_LIBRARY_PATH=$DIFF_DIR/openmpi-1.3.1_install/lib:${LD_LIBRARY_PATH}
 export LD_LIBRARY_PATH=$DIFF_DIR/tepal-2.0.0/bin/Linux_64:${LD_LIBRARY_PATH}
 export PATH=$DIFF_DIR/tepal-2.0.0/bin/Linux_64:$PATH
 
-#small test betweeen friends
+#small test between friends
 #rm hostnames.log
 #mpirun -n $4 hostname >> hostnames.log
 
@@ -275,7 +279,7 @@ export DLIM8VAR="dlim8 1:1:29030@is142356/0016175ef08c::a1ba...9e19"
 export SIMULOGD_LICENSE_FILE=29029@is142356 
 export LICENSE_FILE=/product/distene/dlim8.var.sh
 
-#mpirun with necessary set envenvironment
+#mpirun with necessary set environment
 export TMP_ENV="-x PATH -x LD_LIBRARY_PATH -x DISTENE_LICENSE_FILE -x DLIM8VAR \
                 -x SIMULOGD_LICENSE_FILE -x LICENSE_FILE"
 #mpirun $TMPENV -n $4 which tepal64_v2.exe >> hostnames.log
@@ -286,7 +290,7 @@ mpirun $TMPENV -n $4 tepal64_v2.exe --in $IN_FILES.mesh --out $IN_FILES.mesh --v
 #convert output files tepalv1 format
 /through_salome_path/mesh2facespoints.py $IN_FILES
 
-#copy ouputs files from $SAME_DIR to local current directory (something like /tmp/myname)
+#copy output files from $SAME_DIR to local current directory (something like /tmp/myname)
 cp -f hostnames.log $IN_DIR
 cp -f $IN_FILES* $IN_DIR
 
index eb4b482e62505d9e14ef1e08e7504958e37b12a9..eb50bc172f390c0eb0220bc5029b132a047eb1b0 100644 (file)
@@ -2,8 +2,19 @@
 
 \page ghs3dprlplugin_python_interface_page Python Interface
 
-Python package GHS3DPRLPluginBuilder defines several classes, destined for creation of the 3D meshes.
+\note The former name of MG-Tetra Parallel meshing algorithm is \a GHS3DPRL and names
+of the corresponding classes and modules still include \a "GHS3DPRL".
 
-GHS3DPRL meshing plugin dynamically adds several methods to the smeshBuilder.Mesh class to create meshing algorithms.
+Python package GHS3DPRLPluginBuilder defines
+GHS3DPRLPluginBuilder.GHS3DPRL_Algorithm class providing access
+to the MG-Tetra Parallel meshing algorithm and its parameters.
+
+You can get an instance of this class by calling
+smeshBuilder.Mesh.Tetrahedron(algo=smeshBuilder.MG_Tetra_Parallel) or 
+smeshBuilder.Mesh.Tetrahedron(algo=smeshBuilder.GHS3DPRL). This call
+creates an algorithm (if not yet exist), assigns it to the mesh and
+returns an instance of GHS3DPRLPluginBuilder.GHS3DPRL_Algorithm to the caller.
+
+The class of algorithm has methods to set up meshing parameters.
 
 */
index 8ae4fafac0bb49f02e080a32174d28bc5eef9c9d..e887994acbe6ea8d2da027fcb56e30dff0f6dc4c 100644 (file)
@@ -1,18 +1,21 @@
 /*!
 
-\mainpage Introduction to GHS3DPRLPLUGIN
+\mainpage Introduction to MG-Tetra Parallel plug-in
 
-\b GHS3DPRLPLUGIN plugin is destined for:
+\b MG-Tetra Parallel plug-in adds MG-Tetra Parallel (former GHS3DPRL) meshing
+algorithm to the SALOME Mesh module.
+
+\b MG-Tetra Parallel plug-in is destined for:
 - Meshing 3D geometric entities: volumes are split into tetrahedral (pyramidal) elements.
 - Generating 3D meshes from 2D meshes, working without geometrical objects.
 
-\note GHS3DPRLPLUGIN plugin uses MG-Tetra-hpc (formerly Tepal) commercial mesher and require a
+\note MG-Tetra Parallel plug-in uses MG-Tetra-hpc (formerly Tepal) commercial mesher and require a
 license to be used within the Mesh module.
 
-To manage parameters of the GHS3DPRLPLUGIN use \subpage ghs3dprl_hypo_page.
+To manage parameters of the MG-Tetra Parallel mesher use \subpage ghs3dprl_hypo_page.
 
-Also all GHS3DPRLPLUGIN functionalities are accessible via
-\subpage ghs3dprlplugin_python_interface_page "GHS3DPRLPLUGIN Python interface".
+Also all MG-Tetra Parallel functionalities are accessible via
+\subpage ghs3dprlplugin_python_interface_page "MG-Tetra Parallel Python interface".
 
 
 \image html image2.gif "Example of a tetrahedral 3D mesh"
index 970ada4fd00d129f53452fe5876f47bfdf7ff0c9..048cbe843cb494ed5c5bc9e0ea28efa53f6f7611 100644 (file)
@@ -27,6 +27,6 @@
     <parameter name="plugins" value="NETGENPlugin,GHS3DPlugin,GHS3DPRLPlugin"/>
   </section>
   <section name="smesh_help" >
-    <parameter name="Plug-ins/GHS3DPRL plugin User's Guide" value="${GHS3DPRLPLUGIN_ROOT_DIR}/share/doc/salome/gui/GHS3DPRLPLUGIN/index.html"/>
+    <parameter name="Plug-ins/MG-Tetra Parallel plugin User's Guide" value="${GHS3DPRLPLUGIN_ROOT_DIR}/share/doc/salome/gui/GHS3DPRLPLUGIN/index.html"/>
   </section>
 </document>
index cec63fda5b91002e120ad18aee86df3ffb47f055..241b8e7a7ada680ea21e1d47c662d9b727911b81 100644 (file)
@@ -19,7 +19,7 @@
 
 ##
 # @package GHS3DPRLPluginBuilder
-# Python API for the GHS3DPRL meshing plug-in module.
+# Python API for the MG-Tetra Parallel meshing plug-in module.
 
 from salome.smesh.smesh_algorithm import Mesh_Algorithm
 from salome.smesh.smeshBuilder import AssureGeomPublished
@@ -32,7 +32,7 @@ except ImportError:
     noGHS3DPRLPlugin = 1
     pass
 
-# Optimization level of GHS3D
+# Optimization level of MG-Tetra Parallel
 # V3.1
 None_Optimization, Light_Optimization, Medium_Optimization, Strong_Optimization = 0,1,2,3
 # V4.1 (partialy redefines V3.1). Issue 0020574
@@ -50,7 +50,7 @@ GHS3DPRL = MG_Tetra_Parallel
 # Algorithms
 #----------------------------
 
-## Tetrahedron GHS3DPRL 3D algorithm
+## Tetrahedron MG-Tetra Parallel 3D algorithm
 #
 #  It can be created by calling smeshBuilder.Mesh.Tetrahedron( smeshBuilder.MG_Tetra_Parallel )
 class GHS3DPRL_Algorithm(Mesh_Algorithm):
@@ -60,7 +60,7 @@ class GHS3DPRL_Algorithm(Mesh_Algorithm):
     meshMethod = "Tetrahedron"
     ## type of algorithm used with helper function in smeshBuilder.Mesh class
     #  @internal
-    algoType   = GHS3DPRL
+    algoType   = MG_Tetra_Parallel
     ## doc string of the method in smeshBuilder.Mesh class
     #  @internal
     docHelper  = "Creates tetrahedron 3D algorithm for volumes"