Merge from V6_main_20120808 08Aug12

[plugins/netgenplugin.git] / src / NETGEN / ReadMeForNgUsers

diff --git a/src/NETGEN/ReadMeForNgUsers b/src/NETGEN/ReadMeForNgUsers
index 4abb2b18d677a9f1e061bc84c9fce1a01f1ae197..7d982a80803a6d56266c830bfa6ce2cfc4de690f 100644 (file)
--- a/src/NETGEN/ReadMeForNgUsers
+++ b/src/NETGEN/ReadMeForNgUsers
@@ -1,23 +1,78 @@
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------
+# Notes for Netgen >= 4.9
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------
+
+Netgen can be find at http://www.hpfem.jku.at/netgen/
+
+1. How to build Netgen for Netgen Plugin
+------------------------------
+
+1.1. Download Netgen archive (here netgen-4.9.12.tar.gz) and unpack it
+
+1.2. Configure the netgen compilation. The "good" options are
+     ../netgen-4.9.12/configure \ 
+        --prefix=THE_INSTALLATION_PATH \
+        --with-occ=${CASROOT} \
+        CXXFLAGS="-I${TOGL_HOME}/include" \
+        LDFLAGS="-L${TOGL_HOME}/lib/Togl1.7"
+
+1.3. Compile the netgen product
+     make then make install
+
+1.4. Patch the installation directory to copy include files
+     needed by NETGEN Plugin. Use the script
+     NETGENPLUGIN_SRC/src/NETGEN/netgen_copy_include_for_salome
+     to achieve that. The first argument is the directory containing
+     the Netgen sources. The second argument is THE_INSTALLATION_PATH
+
+Erwan ADAM
+erwan.adam@cea.fr
+
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------
+# Notes for Netgen 4.5
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------
+
 The Netgen 4.5 from the web location : http://www.hpfem.jku.at/netgen/
 (CVS access) is used in the SMESH Module of Salome3 distribution.
 
-How to build Netgen for Salome
+1. How to build Netgen for Salome
 ------------------------------
 
-Patch the netgen 4.5 distribution:
+1.1. Download Netgen 4.5 from the NETGEN home site (see above).
+
+1.2. Unpack the downloaded Netgen 4.5 archive 
+     (hereafter we assume that this is netgen45 directory)
+
+1.3. Patch the netgen 4.5 distribution for SALOME:
 
 $ cd netgen45
 $ patch -p1 < patch_directory/netgen45ForSalome.patch
 
-Then run makeForSalome.sh (it will be created by the patch):
+1.4. For 64-bit platform you also need to apply another patch:
+
+$ cd netgen45
+$ patch -p1 < patch_directory/netgen45lib64.patch
+
+1.5. Set CASROOT environment variable to OCCT installation path,
+     since Netgen 4.5 requires Open CASCADE Technology:
+
+$ setenv CASROOT <occt_installation_path>
+
+1.6. Compile and install netgen 4.5. To do this, simply run 
+     makeForSalome.sh script (it is created from the patch):
+
 $ sh makeForSalome.sh
 
 
-Additional information for maintainers
+2. Additional information for maintainers
 --------------------------------------
 
-The file check_NETGENPLUGIN.m4 assumes
-that Netgen is installed in the directory <netgen_installation_path> as follow:
+The file check_NETGEN.m4 assumes that Netgen is installed in 
+the directory <netgen_installation_path> as follow:
 
 prompt> ls <netgen_installation_path>
 
@@ -50,17 +105,16 @@ edgeflw.hpp             hpref_pyramid.hpp    msghandler.hpp      sparsmat.hpp
 
 prompt> ls <netgen_installation_path>/lib
 
-LINUX/
-
-prompt> ls <netgen_installation_path>/lib/LINUX
-
 libcsg.a  libgeom2d.a  libla.a   libnginterface.a  libopti.a
 libgen.a  libgprim.a   libmesh.a  libocc.a         libstlgeom.a
 
+The library files can be also installed in the LINUX or LINUX64
+subfolder of the lib directory.
+
 All the libraries *.a should be compiled without the option -DOPENGL.
 netgen45 is assumed to be the directory downloaded from the above web
 location archive of Netgen. The library 
-<netgen_installation_path>/lib/LINUX/libnginterface.a should contain the objects
+<netgen_installation_path>/lib/libnginterface.a should contain the objects
 nglib.o (from netgen45/libsrc/interface/nglib.cpp) and ngnewdelete.o
 (from netgen45/ngtcltk/ngnewdelete.cpp).
 
@@ -72,7 +126,12 @@ nglib.o and ngnewdelete.o to the library libnginterface.a and
 recompile the libraries only.
 All this job is done by applying the patch and running the script makeForSalome.sh.
 
-Th suggested patch alters some Netgen sources to compile them.
+The suggested patch alters some Netgen sources to compile them.
 
 Michael SAZONOV
 m-sazonov@opencascade.com
+
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------
+# ------------------------------------------------------------------