#                            -*- mode: org; -*-
#
#+TITLE:                 OpenFOAM Third-Party packages
#+AUTHOR:            The OpenFOAM Foundation / OpenCFD Ltd.
#+DATE:                           2016-10-14
#+LINK:                     http://www.openfoam.org
#+OPTIONS: author:nil ^:{}
# Copyright (c) 2014-2016 OpenFOAM Foundation.
# Copyright (c) 2016 OpenCFD Ltd.

* Description
  Scripts for building third-party packages.
* Build Order:
  + makeGcc   (recommended if the system gcc is < 4.7)
  + Allwmake  (Builds OpenMPI, Scotch etc.)
  + makeCmake (if the system cmake version is < 2.8.8)
  + makeParaView
*** Optional Build Components:
    + makeLLVM  (Replaces makeGcc in the above description
    - to use clang as compiler)
    + makeADIOS (Only required for ADIOS support)
    + makeCCMIO (Only required for conversion of STAR-CCM+ meshes)
    + Allclean  (Only required to save disk space)
* Versions and locations to download the third party packages
*** Gcc C++ Compiler
    The minimum version of gcc required is 4.5.0
    + gcc   http://gcc.gnu.org/releases.html
    + gmp   http://gmplib.org/
            ftp://ftp.gnu.org/gnu/gmp/gmp-6.1.0.tar.bz2
    + mpfr  http://www.mpfr.org/
            ftp://ftp.gnu.org/gnu/mpfr/mpfr-3.1.4.tar.bz2
    + mpc   http://www.multiprecision.org/
            ftp://ftp.gnu.org/gnu/mpc/mpc-1.0.3.tar.gz
*** Parallel Processing
***** Scotch
      + Scotch/PtScotch: https://gforge.inria.fr/frs/download.php/file/34099/scotch_6.0.3.tar.gz
***** OpenMPI
      + OpenMPI: http://www.open-mpi.org/software/ompi/v1.10/downloads/openmpi-1.10.2.tar.bz2
*** ParaView
    + cmake          http://www.cmake.org/files/v3.5/cmake-3.5.2.tar.gz
    + ParaView-4.4.0 http://www.paraview.org/files/v4.4/ParaView-v4.4.0-source.tar.gz
    + ParaView-5.0.1 http://www.paraview.org/files/v5.0/ParaView-v5.0.1-source.tar.gz
    but may need patching to compile (See [[Notes]]).
*** ADIOS
    + https://github.com/ornladios/ADIOS/archive/v1.10.0.tar.gz
*** CGAL
    + CGAL        https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.8/CGAL-4.8.tar.xz
    + CGAL        https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.8.1/CGAL-4.8.1.tar.xz
    + boost       https://sourceforge.net/projects/boost/files/boost/1.61.0/boost_1_61_0.tar.bz2/download
*** Miscellaneous
    + FFTW        http://www.fftw.org/fftw-3.3.4.tar.gz
    + libccmio    http://portal.nersc.gov/svn/visit/trunk/third_party/libccmio-2.6.1.tar.gz
* Notes
*** Building ADIOS
    + Currently requires GNU autoconf tools (eg, autoconf, autoheader, automake)
    for its configuration.
    + Optionally uses zlib, bzip2 development headers (eg, zlib-devel, libbz2-devel).
*** Building Scotch
    + The zlib library and zlib development headers are required.
* Notes
*** Building ParaView-4.3.1/4.4.0/5.0.0/5.0.1
    The ParaView-4.3.1/4.4.0/5.0.0 source-pack provided by KitWare will not
    build and install correctly without a minor correction: lines 653-656
    (650-653 in ParaView-5.0.0, 659-662 in ParaView-5.0.1) must be removed or
    commented from file
    /ThirdParty-???/ParaView-[45].?.?/Qt/Components/CMakeLists.txt/ after
    unpacking and renaming the ParaView-[45].?.? directory.  This is because the
    file ui_pqExportStateWizard.h referred to in
    #+begin_src C
    if(PARAVIEW_INSTALL_DEVELOPMENT_FILES)
      install(FILES "${CMAKE_CURRENT_BINARY_DIR}/ui_pqExportStateWizard.h"
              DESTINATION "${VTK_INSTALL_INCLUDE_DIR}")
    endif()
    #+end_src
    does not exist and cannot be installed causing the build and installation to
    fail.

    Additionally for ParaView-4.4.0 there is a bug in the STL reader.
    (see http://www.openfoam.org/mantisbt/view.php?id=1887).

    For ParaView-4.4.0 and ParaView-5.0.1,
    the necessary patches are supplied with the ThirdParty repository
    (see the etc/patches directory) and are applied when building paraview.

*** Building ParaView-5.0.1 with gcc-6.1.0
***** Add support for gcc-6.?.?
      The following cmake files
      + ParaView-5.0.1/VTK/CMake/vtkCompilerExtras.cmake
      + ParaView-5.0.1/VTK/CMake/GenerateExportHeader.cmake
      specifically limit the gcc versions supported.
      To add support gcc-6.?.? replace the '[345]' with '[3456]'.

      This patch is also supplied with the ThirdParty repository and
      applied when building paraview.

***** SciberQuestToolKit
      The SciberQuestToolKit plugin fails to compile with gcc-6.1.0 and causes
      the compilation of ParaView to halt.  The easiest solution is to delete
      the ParaView-5.0.1/Plugins/SciberQuestToolKit directory.
*** Building ParaView-4.1.0
    On Ubuntu 14.10 and higher, OpenSuSE 13.2 and probably other recent
    GNU/Linux distributions there is an issue in the GL libraries requiring a
    change to the vtkXOpenGLRenderWindow.cxx file in ParaView: Uncomment line 30

    #define GLX_GLXEXT_LEGACY

# --------------------------------------------------------------------------