Installation/Linux/OpenFOAM-2.0.0/Ubuntu

From OpenFOAMWiki
< Installation‎ | Linux‎ | OpenFOAM-2.0.0
Revision as of 16:22, 27 October 2018 by Wyldckat (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

1 Introduction

This page is dedicated to explaining how to install OpenFOAM OF Version 200.png in Ubuntu.

If you do not yet feel comfortable using Linux, then perhaps you better first read the page Working with the Shell and train a bit with the shell/terminal environments, so you can have a better perception of the steps shown below.


2 Copy-Paste steps

A few notes before you start copy-pasting:

  1. Lines that start with # don't have to be copy-pasted. They are just comments to let you know what's going on.
  2. One wrong character is enough for breaking this guide, so make sure you can read the characters properly or that the installed language system does not break the copied characters!


2.1 Ubuntu 14.04

Here you have the following choices:

  • You can install from source, by either:


Discussion thread where you can ask questions about these steps: Error installing OpenFOAM 2.0.0 on Ubuntu 15.10

Steps:

  1. Switch to root mode (administrator), to install the necessary packages:
    sudo -s
    • If the 'sudo' command tells you're not in the sudoers list, then run:
      su -
  2. Update the apt-get cache by running:
    apt-get update
  3. Install the necessary packages:
    apt-get install build-essential binutils-dev flex bison zlib1g-dev qt4-dev-tools libqt4-dev libqtwebkit-dev gnuplot \
    libreadline-dev libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
    libmpfr-dev python python-dev libcgal-dev gcc-4.4 g++-4.4 cmake

    Note: It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:

    apt-get install libglu1-mesa-dev libqt4-opengl-dev
  4. Now exit from the root mode:
    exit
  5. Download and unpack (here you can copy-paste all in single go):
    #OpenFOAM downloading and installation
    cd ~
    mkdir OpenFOAM
    cd OpenFOAM
    wget "http://downloads.sourceforge.net/foam/OpenFOAM-2.0.0.gtgz?use_mirror=mesh" -O OpenFOAM-2.0.0.gtgz
    wget "http://downloads.sourceforge.net/foam/ThirdParty-2.0.0.gtgz?use_mirror=mesh" -O ThirdParty-2.0.0.gtgz
     
    tar -xzf OpenFOAM-2.0.0.gtgz 
    tar -xzf ThirdParty-2.0.0.gtgz
  6. Optional: Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
    ln -s /usr/bin/mpicc.openmpi OpenFOAM-2.0.0/bin/mpicc
    ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.0.0/bin/mpirun

    This way we avoid having problems in case there is more than one MPI toolbox installed in your Ubuntu system, for example if MPICH2 is installed and is the default MPI toolbox.

  7. We will be using GCC 4.4, because 6.x is not compatible with OpenFOAM 2.0.0 (see Installation/Compatibility Matrix). Therefore, we need to do a couple more changes, to ensure it works as intended:
    sed -i -e 's/gcc/gcc-4.4/' OpenFOAM-2.0.0/wmake/rules/linux*Gcc44/c
    sed -i -e 's/g++/g++-4.4/' OpenFOAM-2.0.0/wmake/rules/linux*Gcc44/c++
    echo "export WM_CC='gcc-4.4'" >> OpenFOAM-2.0.0/etc/bashrc
    echo "export WM_CXX='g++-4.4'" >> OpenFOAM-2.0.0/etc/bashrc
  8. For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of Ubuntu. To check this, run:
    uname -m

    Now, accordingly:

    • For i386:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.0.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32 WM_COMPILER=Gcc44
    • For x86_64:
      #here you can change 4 to the number of cores you've got
      source $HOME/OpenFOAM/OpenFOAM-2.0.0/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_COMPILER=Gcc44
  9. Save an alias in the personal .bashrc file, simply by running the following command:
    echo "alias of200='source \$HOME/OpenFOAM/OpenFOAM-2.0.0/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
    Note: This last line means that whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM 2.0.0 shell environment. In other words, whenever you start a new terminal, you should run:
    of200
    
    For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.
  10. Now, before we can build OpenFOAM, we need to do a few fixes:
    #Go into OpenFOAM's main source folder
    cd $WM_PROJECT_DIR
     
    #Change how the flex version is checked
    find src applications -name "*.L" -type f | xargs sed -i -e 's=\(YY\_FLEX\_SUBMINOR\_VERSION\)=YY_FLEX_MINOR_VERSION < 6 \&\& \1='
  11. Now let's build OpenFOAM:
    (Warning: this may take somewhere from 30 minutes to 6 hours, depending on your machine.)
    #Go into OpenFOAM's main source folder
    cd $WM_PROJECT_DIR
     
    # This next command will take a while... somewhere between 30 minutes to 3-6 hours.
    ./Allwmake > log.make 2>&1
     
    #Run it a second time for getting a summary of the installation
    ./Allwmake > log.make 2>&1
  12. To check if everything went well:
    1. Check if icoFoam is working, by running this command:
      icoFoam -help

      which should tell you something like this:

      Usage: icoFoam [OPTIONS]
      options:
        -case <dir>       specify alternate case directory, default is the cwd
        -noFunctionObjects
                          do not execute functionObjects
        -parallel         run in parallel
        -roots <(dir1 .. dirN)>
                          slave root directories for distributed running
        -srcDoc           display source code in browser
        -doc              display application documentation in browser
        -help             print the usage

      Note: And keep in mind that you need to be careful with the letter case of the command. It's icoFoam, not icoFOAM.

    2. If the previous command failed to work properly, then edit the file log.make and check if there are any error messages. A few examples on how you can edit this file:
      • By using kwrite:
        kwrite log.make
      • By using gedit:
        gedit log.make
      • By using nano:
        nano log.make

        You can then exit by using the key combination Ctrl+X and following any instructions it gives you.

      Note: It's the first error message that matters.

    3. If you don't understand the output, then please compress the log-file log.make and attach the compressed file to a post in the designated thread.
      If you do not know how to create a compressed file, then try one of the following examples:
      • You can compress the file with gzip by running this command:
        gzip < log.make > log.make.gz

        Then attach the resulting package file named log.make.gz to a post in the designated thread.

      • Or you can compress one or more log-files into a tarball package file, by running this command:
        tar -czf logs.tar.gz log.*

        Then attach the resulting package file named logs.tar.gz to a post in the designated thread.

    4. Instructions on how to further diagnose the issue yourself, have a look at the section Common errors when building OpenFOAM from source code in the page FAQ/Installation and Running.
  13. Now, in order to build ParaView 3.10.1 that comes with OpenFOAM, several steps are needed:
    1. First go into the 3rd party folder and make very certain that the correct Qt version is being used, by running this command:
      cd $WM_THIRD_PARTY_DIR
       
      export QT_SELECT=qt4
    2. Next we need to do several fixes:
      sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
        ParaView-3.10.1/VTK/Rendering/vtkXOpenGLRenderWindow.cxx
       
      sed -i -e 's/ClearAndSelect = Clear | Select/ClearAndSelect = static_cast<int>(Clear) | static_cast<int>(Select)/' \
        ParaView-3.10.1/Qt/Core/pqServerManagerSelectionModel.h
       
      sed -i -e 's/\(export CXX.*$\)/\1\n[ -n "$WM_CC" ] \&\& export CC="$WM_CC"/' makeParaView
       
      sed -i -e 's=\(CMAKE_SYSTEM MATCHES "Linux\).*=\1-([3-9]\\\\.[0-9]|2\\\\.[4-9]\\\\.)")=' \
        ParaView-3.10.1/VTK/Utilities/vtkhdf5/ConfigureChecks.cmake
    3. For building ParaView, which will take a while... somewhere between 30 minutes to 2 hours or more, run:
      ./makeParaView > log.makePV 2>&1
    4. Once the makeParaView script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors.
    5. Update the shell environment:
      wmSET $FOAM_SETTINGS
    6. Now, in order to build the OpenFOAM readers for ParaView 3.10.1, run:
      cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
      ./Allwclean 
      ./Allwmake
  14. Now you can go read the User Guide, where you may have more than one choice:
    1. Which you can find a local copy of the User Guide by running the following command:
      ls -A1 $WM_PROJECT_DIR/doc/Guides*/*UserGuide*.pdf
      • You should see two available formats: A4 and US-Letter.
      • But if it instead tells you that there is No such file or directory, then the OpenFOAM environment is possibly not properly activated.
    2. You can also find the more recent OpenFOAM Foundation User Guides online at the following page: official OpenFOAM User Guide - but be careful if you use the version that is too much ahead of the version you are currently using, given that some features have changed overtime.


Reminder: Whenever you start a new terminal window or tab, you should run the alias command associated to the OpenFOAM 2.0.0 shell environment. In other words, run the following command whenever you start a new terminal:
of200
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.


Discussion thread where you can ask questions about these steps: Error installing OpenFOAM 2.0.0 on Ubuntu 15.10