From f816c2d0bcb113534dfa3cd70e50b76d174df608 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@Germany>
Date: Tue, 20 Dec 2016 15:33:16 +0100
Subject: [PATCH] COMP: include BuildIssues.txt for known build issues

- fixed library path for VTK.
  They should use lib/ and not lib64/
---
 BuildIssues.txt                       | 47 +++++++++++++++++++++++++++
 etc/config.csh/vtk                    | 10 ++++--
 etc/config.sh/vtk                     | 12 +++++--
 src/functionObjects/graphics/Allwmake |  4 ++-
 4 files changed, 68 insertions(+), 5 deletions(-)
 create mode 100644 BuildIssues.txt

diff --git a/BuildIssues.txt b/BuildIssues.txt
new file mode 100644
index 0000000000..c2392c2db0
--- /dev/null
+++ b/BuildIssues.txt
@@ -0,0 +1,47 @@
+OpenFOAM-v1612+
+==================
+Known Build Issues
+==================
+
+--------------
+Intel Compiler
+--------------
+
+  Since OpenFOAM uses C++11, a fairly recent version is required.
+
+  The Intel compiler - icc (ICC) 17.0.0 20160721 - has a bug that
+  will result in these types of error messages.
+
+    MatrixSpaceI.H(492): error: no instance of overloaded function
+    "Foam::MatrixSpace<Form, Cmpt, Mrows, Ncols>::Block<SubTensor,
+    BRowStart, BColStart>::operator=" matches the specified type
+
+
+  There is a update patch for the icc compiler to address this bug.
+
+
+---
+VTK
+---
+
+If using the runTimePostProcessing to create on-the-fly images, you
+can either simply just compile ParaView-5.0.1 and these libraries will
+be used.
+
+If you decide to use a separate VTK compilation (for example for
+off-screen rendering), it is advisable to reuse the VTK libraries that
+are provided with ParaView-5.0.1, by making an appropriate symlink
+prior to using makeVTK. This doesn't just reduce diskspace, but works
+much better than using the VTK-7.1.0.tar file.
+
+Building runTimePostProcessing with the 'plain' VTK-7.1.0 libraries
+generally works, but yields odd error and unpleasant looking errors
+when exiting:
+
+    symbol lookup error: .../linux64Gcc/VTK-7.1.0/lib/libvtkCommonExecutionModel-7.1.so.1:
+    undefined symbol: _ZN33vtkFilteringInformationKeyManager13ClassFinalizeEv
+
+    symbol lookup error: .../linux64Gcc/VTK-7.1.0/lib/libvtkCommonDataModel-7.1.so.1:
+    undefined symbol: _ZN49vtkInformationQuadratureSchemeDefinitionVectorKeyD1Ev
+
+--
diff --git a/etc/config.csh/vtk b/etc/config.csh/vtk
index d98dfb6ddb..e09a045570 100644
--- a/etc/config.csh/vtk
+++ b/etc/config.csh/vtk
@@ -28,13 +28,18 @@
 #     Setup file for VTK (and MESA)
 #     Sourced from OpenFOAM-<VERSION>/etc/cshrc
 #
-#     The library path is not adjusted with the paths specified here do not exist
+#     The library path is only adjusted when the paths specified here
+#     actually exist at the time of sourcing.
 #
 # Note
 #     When building OpenFOAM, any changes made here MUST be made in the
 #     equivalent config.sh version too, since that is the one which will
 #     be used during the build process.
 #
+# It is recommended to use the VTK sources from ParaView 5.0.1.
+#
+# See the BuildIssues.txt about problems that can be encountered when using
+# the 'plain' VTK sources.
 #------------------------------------------------------------------------------
 
 set vtk_version=VTK-7.1.0
@@ -51,7 +56,8 @@ endif
 
 # Set paths if binaries are present
 if ( -r $VTK_DIR ) then
-    _foamAddLib $VTK_DIR/lib$WM_COMPILER_LIB_ARCH
+    # Uses lib/ and not lib64/
+    _foamAddLib $VTK_DIR/lib
 else
     unset VTK_DIR
 endif
diff --git a/etc/config.sh/vtk b/etc/config.sh/vtk
index a0fa15f693..e4295df927 100644
--- a/etc/config.sh/vtk
+++ b/etc/config.sh/vtk
@@ -28,11 +28,18 @@
 #     Setup file for VTK (and MESA)
 #     Sourced from OpenFOAM-<VERSION>/etc/bashrc
 #
-#     The library path is not adjusted with the paths specified here do not exist
+#     The library path is only adjusted when the paths specified here
+#     actually exist at the time of sourcing.
 #
 # Note
 #     When _foamAddLib is unset
 #         - the vtk_version, mesa_version variables are retained.
+#           (for future integration into ThirdParty build)
+#
+# It is recommended to use the VTK sources from ParaView 5.0.1.
+#
+# See the BuildIssues.txt about problems that can be encountered when using
+# the 'plain' VTK sources.
 #------------------------------------------------------------------------------
 
 vtk_version=VTK-7.1.0
@@ -54,7 +61,8 @@ then
     # Set paths if binaries are present
     if [ -r $VTK_DIR ]
     then
-        _foamAddLib $VTK_DIR/lib$WM_COMPILER_LIB_ARCH
+        # Uses lib/ and not lib64/
+        _foamAddLib $VTK_DIR/lib
     else
         unset VTK_DIR
     fi
diff --git a/src/functionObjects/graphics/Allwmake b/src/functionObjects/graphics/Allwmake
index fc5ea8144b..e665220999 100755
--- a/src/functionObjects/graphics/Allwmake
+++ b/src/functionObjects/graphics/Allwmake
@@ -1,4 +1,6 @@
 #!/bin/sh
 cd ${0%/*} || exit 1    # Run from this directory
 
-./runTimePostProcessing/Allwmake
+runTimePostProcessing/Allwmake
+
+#------------------------------------------------------------------------------