Salome HOME
Porting to Python 3
[plugins/ghs3dprlplugin.git] / doc / salome / gui / GHS3DPRLPLUGIN / input / ghs3dprl_hypo.doc
index 7b09aea7eaf54e4c5255fac9b9698ec77bf20484..ba404144b51e495e86757e5353d4e279319ee561 100644 (file)
@@ -1,10 +1,11 @@
 /*!
 
-\page ghs3dprl_hypo_page MG-Tetra-hpc (Parallel) Parameters hypothesis
+\page ghs3dprl_hypo_page MG-Tetra_HPC 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.
@@ -23,11 +24,11 @@ file with 5 million tetrahedrons.
 
 <ul>
 <li>
-<b>Name</b> - allows to define the name of the hypothesis (MG-Tetra Parallel Parameters by default).
+<b>Name</b> - allows to define the name of the hypothesis (MG-Tetra_HPC Parameters by default).
 </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,56 @@ 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>Tetra_hpc Multithread</b> - if this box is checked, MG-Tetra-hpc execution
+is with mg_tetra_hpc.exe (multithread version), else mg_tetra_hpc_mpi.exe (MPI distributed version).
+</li>
+<li>
+<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>
 
+\image html ghs3dprl_parameters_advanced.png
+
+In \b Advanced tab page you can specify not exposed options of MG_Tetra-hpc.
+
+<b>Add option</b> adds a line to the table where you can type an option and its value as text.
+A check box in the first column activates/deactivates the option of the current row. A deactivated option will be erased upon pressing \a Ok.
+
 <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_HPC 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 +200,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_HPC Advanced Parameters</h1><br>
+MG-Tetra_HPC 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 +235,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 +248,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 +280,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 +290,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 +301,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
 
@@ -352,16 +367,17 @@ algo2d.SetGeometricMesh(0)
 # 3D mesh with tetra-hpc (formerly tepal v3 (2014))
 # ----------------------------------------------------
 
-algo3d = m.Tetrahedron(smeshBuilder.MG_Tetra_Parallel)
+algo3d = m.Tetrahedron(smeshBuilder.MG_Tetra_HPC)
 
 algo3d.SetMEDName(results)
 algo3d.SetNbPart(4)
 algo3d.SetBackground(False)
+algo3d.SetMultithread(False)
 algo3d.SetKeepFiles(False)
-algo3d.SetToMergeSubdomains(False)
-algo3d.SetToTagSubdomains(False)
-algo3d.SetToOutputInterfaces(False)
-algo3d.SetToDiscardSubdomains(False)
+algo3d.SetGradation(1.05)
+algo3d.SetMinSize(0)
+algo3d.SetMaxSize(0)
+
 
 # Launch meshers
 # --------------
@@ -372,9 +388,9 @@ status = m.Compute()
 # ----------
 
 if os.access(results+".xml", os.F_OK):
-    print "Ok: tetra_hpc"
+    print("Ok: tetra_hpc")
 else:
-    print "KO: tetra_hpc"
+    print("KO: tetra_hpc")
 \endcode
 \n
 </li>