1 Introduction

This page is dedicated to explaining how to install OpenFOAM 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:

Lines that start with # don't have to be copy-pasted. They are just comments to let you know what's going on.
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 8.04

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Note: These instructions for Ubuntu 8.04 are based on the instructions available here: Building OpenFOAM 2.0.1 on old Linux OSes - test case Ubuntu 8.04

Steps:

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 -
```
These instructions depend on whether you have installed the i386 or x86_64 architecture of Ubuntu. To check this, run:
```
uname -m
```
It should show i386 or x86_64, so keep this in mind while following these instructions.
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

apt-get install binutils-dev bison build-essential libreadline5-dev wget gnuplot zlib1g-dev libpng12-dev \
libxt-dev libxi-dev libxrender-dev libxrandr-dev libxcursor-dev libxinerama-dev libfreetype6-dev \
libfontconfig1-dev libglib2.0-dev freeglut3-dev texinfo libopenmpi-dev openmpi-bin

If uname indicates that you're using x86_64, also install multilib:

apt-get install gcc-multilib

Now exit from the root mode:
```
exit
```

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.1.1.tgz?use_mirror=mesh" -O OpenFOAM-2.1.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.1.1.tgz?use_mirror=mesh" -O ThirdParty-2.1.1.tgz
 
tar -xzf OpenFOAM-2.1.1.tgz 
tar -xzf ThirdParty-2.1.1.tgz

For building OpenFOAM itself, it depends on what uname gave you at the beginning:

For i386:

#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 foamCompiler=ThirdParty \
WM_COMPILER=Gcc45 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32

For x86_64:

#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 foamCompiler=ThirdParty \
WM_COMPILER=Gcc45 WM_MPLIB=SYSTEMOPENMPI

Note: You probably will see a message similar to this one and it's meant to do so until we've built the custom Gcc version:

Warning in /home/user/OpenFOAM/OpenFOAM-2.1.1/etc/config/settings.sh:
    Cannot find /home/user/OpenFOAM/ThirdParty-2.1.1/platforms/linux64/gcc-4.5.2 installation.
    Please install this compiler version or if you wish to use the system compiler,
    change the 'foamCompiler' setting to 'system'

Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of211='source \$HOME/OpenFOAM/OpenFOAM-2.1.1/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.1.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of211
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

Now we'll have to get all of the scripts we'll need to build everything (gcc, binutils, Qt, make, flex, cmake):

cd $WM_THIRD_PARTY_DIR
wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getGcc"
wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getQt"
wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getCmake"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/makeBinutils"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/getBinutils"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/makeMake"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/getMake"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/makeFlex"
wget "https://raw.github.com/wyldckat/ThirdParty-2.0.x/binutils/getFlex"
chmod +x get* make*

Now let's get and build Gcc 4.5.2 and company:

./getGcc gcc-4.5.2
./makeGcc gcc-4.5.2 > log.mkgcc 2>&1

Now let's get and build a custom GNU Make:
```
./getMake
./makeMake gcc-4.5.2 > log.mkmake 2>&1
wmSET $FOAM_SETTINGS
```
If it still gives you the same error message from #3, then something went wrong...

Now let's get and build a custom GNU Binutils:

./getBinutils
./makeBinutils gcc-4.5.2 > log.mkbinutils 2>&1

Now let's get and build a custom Flex version:

./getFlex
./makeFlex gcc-4.5.2 > log.mkflex 2>&1

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

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.
Ubuntu 8.04 comes with CMake 2.4.7, but ParaView 3.12.0 requires CMake from the 2.8.x series. Therefore, we'll need to do a custom build:
```
cd $WM_THIRD_PARTY_DIR
./getCmake
./makeCmake
wmSET $FOAM_SETTINGS
```
Now Qt 4.6.4:
```
./getQt
./makeQt 4.6.4 > log.mkqt 2>&1
```

Now, in order to build ParaView 3.12.0 that comes with OpenFOAM:

cd $WM_THIRD_PARTY_DIR
./makeParaView -qmake ${WM_THIRD_PARTY_DIR}/platforms/$WM_ARCH$WM_COMPILER/qt-4.6.4/bin/qmake \
PARAVIEW_INSTALL_THIRD_PARTY_LIBRARIES:BOOL=ON > log.mkPV 2>&1
 
cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
wmSET $FOAM_SETTINGS
export PATH=$WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER/qt-4.6.4/bin:$PATH
./Allwclean 
./Allwmake

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.1.1 shell environment. In other words, run the following command whenever you start a new terminal:

of211

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: No thread available. Please a create a new thread in the forum.

2.2 Ubuntu 10.04

Here you have at least two choices:

You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 2.1.1. This is the quickest solution for beginners and instructions are provided here: Download v2.1.1 | Ubuntu
- Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?
- Alternatively, you can use the script that quickly does those steps: OpenFOAM installation script for Ubuntu, Fedora and OpenSUSE (note: it's an unofficial script!)
You can install from source, by either:
- Following the official instructions from here: Download v2.1.1 | Source Pack
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Steps:

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 -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

apt-get install build-essential flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev libopenmpi-dev openmpi-bin

Now exit from the root mode:
```
exit
```

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.1.1.tgz?use_mirror=mesh" -O OpenFOAM-2.1.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.1.1.tgz?use_mirror=mesh" -O ThirdParty-2.1.1.tgz
 
tar -xzf OpenFOAM-2.1.1.tgz 
tar -xzf ThirdParty-2.1.1.tgz

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.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32

For x86_64:

#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI

Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of211='source \$HOME/OpenFOAM/OpenFOAM-2.1.1/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.1.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of211
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

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 OpenFOAM-2.1.1
 
# 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

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.

Ubuntu 10.04 comes with CMake 2.8.0, but that version has a bug that makes it impossible to build ParaView 3.12.0. Therefore, we'll need to do a custom build:

cd $WM_THIRD_PARTY_DIR
wget "https://raw.github.com/wyldckat/scripts4OpenFOAM3rdParty/master/getCmake"
chmod +x getCmake
./getCmake
./makeCmake
wmSET $FOAM_SETTINGS

Now, in order to build ParaView 3.12.0 that comes with OpenFOAM:

cd $WM_THIRD_PARTY_DIR
./makeParaView
 
cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
wmSET $FOAM_SETTINGS
./Allwclean 
./Allwmake

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.1.1 shell environment. In other words, run the following command whenever you start a new terminal:

of211

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: No thread available. Please a create a new thread in the forum.

2.3 Ubuntu 12.04

Here you have at least two choices:

You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 2.1.1. This is the quickest solution for beginners and instructions are provided here: Download v2.1.1 | Ubuntu
- Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?
- Alternatively, you can use the script that quickly does those steps: OpenFOAM installation script for Ubuntu, Fedora and OpenSUSE (note: it's an unofficial script!)
You can install from source, by either:
- Following the official instructions from here: Download v2.1.1 | Source Pack
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Steps:

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 -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev libopenmpi-dev openmpi-bin

Now exit from the root mode:
```
exit
```

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.1.1.tgz?use_mirror=mesh" -O OpenFOAM-2.1.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.1.1.tgz?use_mirror=mesh" -O ThirdParty-2.1.1.tgz
 
tar -xzf OpenFOAM-2.1.1.tgz 
tar -xzf ThirdParty-2.1.1.tgz

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.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32

For x86_64:

#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI

Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of211='source \$HOME/OpenFOAM/OpenFOAM-2.1.1/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.1.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of211
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

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 OpenFOAM-2.1.1
 
# 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

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.

Now, in order to build ParaView 3.12.0 that comes with OpenFOAM:

cd $WM_THIRD_PARTY_DIR
./makeParaView
 
cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
wmSET $FOAM_SETTINGS
./Allwclean 
./Allwmake

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.1.1 shell environment. In other words, run the following command whenever you start a new terminal:

of211

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: No thread available. Please a create a new thread in the forum.

2.4 Ubuntu 12.10

Here you have at least two choices:

You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 2.1.1. This is the quickest solution for beginners and instructions are provided here: Download v2.1.1 | Ubuntu
- WARNING: Ubuntu Quantal is (probably) not yet officially supported using these Deb packages. You'll have to use a hack, where this line:
```
VERS=$(lsb_release -cs)
```
  should be replaced with this one:
```
VERS=precise
```
- Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?
- Alternatively, you can use the script that quickly does those steps: OpenFOAM installation script for Ubuntu, Fedora and OpenSUSE (note: it's an unofficial script!)
You can install from source, by either:
- Following the official instructions from here: Download v2.1.1 | Source Pack
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: Installing OpenFOAM 2.1.1 and ParaView 3.12.0 on Ubuntu 12.10

Steps:

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 -
```
Update the apt-get cache by running:
```
apt-get update
```

Install the necessary packages:

apt-get install build-essential cmake flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev libopenmpi-dev openmpi-bin

Now exit from the root mode:
```
exit
```

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.1.1.tgz?use_mirror=mesh" -O OpenFOAM-2.1.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.1.1.tgz?use_mirror=mesh" -O ThirdParty-2.1.1.tgz
 
tar -xzf OpenFOAM-2.1.1.tgz 
tar -xzf ThirdParty-2.1.1.tgz

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.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32

For x86_64:

#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI

Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of211='source \$HOME/OpenFOAM/OpenFOAM-2.1.1/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.1.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of211
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

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 OpenFOAM-2.1.1
 
# 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

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.

Now, in order to build ParaView 3.12.0 that comes with OpenFOAM:

cd $WM_THIRD_PARTY_DIR
sed -i -e 's/ClearAndSelect = Clear | Select/ClearAndSelect = static_cast<int>(Clear) | static_cast<int>(Select)/' \
ParaView-3.12.0/Qt/Core/pqServerManagerSelectionModel.h
./makeParaView
 
cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
wmSET $FOAM_SETTINGS
./Allwclean 
./Allwmake

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.1.1 shell environment. In other words, run the following command whenever you start a new terminal:

of211

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: Installing OpenFOAM 2.1.1 and ParaView 3.12.0 on Ubuntu 12.10

2.5 Ubuntu 16.04

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: Download v2.1.1 | Source Pack
- Or by following the detailed step-by-step instructions that were written for Ubuntu 16.10, which also work for this version of Ubuntu.

2.6 Ubuntu 16.10

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: Download v2.1.1 | Source Pack
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: Error in installing OF211 on ubuntu 16.10

Steps:

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 -
```
Update the apt-get cache by running:
```
apt-get update
```

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.7 g++-4.7

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

Now exit from the root mode:
```
exit
```

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.1.1.tgz?use_mirror=mesh" -O OpenFOAM-2.1.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.1.1.tgz?use_mirror=mesh" -O ThirdParty-2.1.1.tgz
 
tar -xzf OpenFOAM-2.1.1.tgz 
tar -xzf ThirdParty-2.1.1.tgz

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.1.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.1.1/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.

We will be using GCC 4.7, because 6.x is not compatible with OpenFOAM 2.1.1 (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.7/' OpenFOAM-2.1.1/wmake/rules/linux*Gcc47/c
sed -i -e 's/g++/g++-4.7/' OpenFOAM-2.1.1/wmake/rules/linux*Gcc47/c++
echo "export WM_CC='gcc-4.7'" >> OpenFOAM-2.1.1/etc/bashrc
echo "export WM_CXX='g++-4.7'" >> OpenFOAM-2.1.1/etc/bashrc

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.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_ARCH_OPTION=32 WM_COMPILER=Gcc47

For x86_64:

#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_COMPILER=Gcc47

Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of211='source \$HOME/OpenFOAM/OpenFOAM-2.1.1/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.1.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of211
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

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='

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

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.

Now, in order to build ParaView 3.12.0 that comes with OpenFOAM, several steps are needed:

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
```

Then we need to get a compatible CMake and compile it, as well as refresh the OpenFOAM shell environment so that its picked up:

cd $WM_THIRD_PARTY_DIR
 
wget https://cmake.org/files/v2.8/cmake-2.8.12.1.tar.gz -P download 
tar -xf download/cmake-2.8.12.1.tar.gz
 
./makeCmake cmake-2.8.12.1 > log.cmake 2>&1
 
sed -i -e 's=cmake-2\.8\.4=cmake-2.8.12.1 cmake-2.8.4=' $WM_PROJECT_DIR/etc/config/paraview.sh
wmSET $FOAM_SETTINGS
 
cmake --version

The last line should state that CMake version 2.8.12.1 was used.

Next we need to do several fixes:

sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
  ParaView-3.12.0/VTK/Rendering/vtkXOpenGLRenderWindow.cxx
 
sed -i -e 's/ClearAndSelect = Clear | Select/ClearAndSelect = static_cast<int>(Clear) | static_cast<int>(Select)/' \
  ParaView-3.12.0/Qt/Core/pqServerManagerSelectionModel.h
 
sed -i -e 's/\(export CXX.*$\)/\1\n[ -n "$WM_CC" ] \&\& export CC="$WM_CC"/' makeParaView

For building ParaView, which will take a while... somewhere between 30 minutes to 2 hours or more, run:
```
./makeParaView > log.makePV 2>&1
```
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.
Update the shell environment:
```
wmSET $FOAM_SETTINGS
```

Now, in order to build the OpenFOAM readers for ParaView 3.12.0, run:

cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
./Allwclean 
./Allwmake

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.

2.7 Ubuntu 18.04

Here you have the following choices:

You can install from source, by either:
- Following the official instructions from here: Download v2.1.1 | Source Pack
- Or by following the detailed step-by-step instructions below...

Discussion thread where you can ask questions about these steps: No thread available. Please a create a new thread in the forum.

Steps:

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 -
```
Update the apt-get cache by running:
```
apt-get update
```

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.8 g++-4.8

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

Now exit from the root mode:
```
exit
```

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.1.1.tgz?use_mirror=mesh" -O OpenFOAM-2.1.1.tgz
wget "http://downloads.sourceforge.net/foam/ThirdParty-2.1.1.tgz?use_mirror=mesh" -O ThirdParty-2.1.1.tgz
 
tar -xzf OpenFOAM-2.1.1.tgz 
tar -xzf ThirdParty-2.1.1.tgz

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.1.1/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-2.1.1/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.

We will be using GCC 4.7, because 6.x is not compatible with OpenFOAM 2.1.1 (see Installation/Compatibility Matrix). Therefore, we need to do a couple more changes, to ensure it works as intended:

cp -r OpenFOAM-2.1.1/wmake/rules/linux64Gcc47 OpenFOAM-2.1.1/wmake/rules/linux64Gcc48
sed -i -e 's/gcc/gcc-4.8/' OpenFOAM-2.1.1/wmake/rules/linux64Gcc48/c
sed -i -e 's/g++/g++-4.8/' OpenFOAM-2.1.1/wmake/rules/linux64Gcc48/c++
echo "export WM_CC='gcc-4.8'" >> OpenFOAM-2.1.1/etc/bashrc
echo "export WM_CXX='g++-4.8'" >> OpenFOAM-2.1.1/etc/bashrc

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
```
This setup has only been tested for 64 bit, therefore:
- For x86_64:
```
#here you can change 4 to the number of cores you've got
source $HOME/OpenFOAM/OpenFOAM-2.1.1/etc/bashrc WM_NCOMPPROCS=4 WM_MPLIB=SYSTEMOPENMPI WM_COMPILER=Gcc48
```
Save an alias in the personal .bashrc file, simply by running the following command:
```
echo "alias of211='source \$HOME/OpenFOAM/OpenFOAM-2.1.1/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.1.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of211
```
For more information on this topic, read section Using aliases to help manage multiple OpenFOAM versions in the page Installation/Working with the Shell.

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='

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

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.

Now, in order to build ParaView 3.12.0 that comes with OpenFOAM, several steps are needed:

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
```

Then we need to get a compatible CMake and compile it, as well as refresh the OpenFOAM shell environment so that its picked up:

cd $WM_THIRD_PARTY_DIR
 
wget https://cmake.org/files/v2.8/cmake-2.8.12.1.tar.gz -P download 
tar -xf download/cmake-2.8.12.1.tar.gz
 
./makeCmake cmake-2.8.12.1 > log.cmake 2>&1
 
sed -i -e 's=cmake-2\.8\.4=cmake-2.8.12.1 cmake-2.8.4=' $WM_PROJECT_DIR/etc/config/paraview.sh
wmSET $FOAM_SETTINGS
 
cmake --version

The last line should state that CMake version 2.8.12.1 was used.

Next we need to do several fixes:

sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
  ParaView-3.12.0/VTK/Rendering/vtkXOpenGLRenderWindow.cxx
 
sed -i -e 's/ClearAndSelect = Clear | Select/ClearAndSelect = static_cast<int>(Clear) | static_cast<int>(Select)/' \
  ParaView-3.12.0/Qt/Core/pqServerManagerSelectionModel.h
 
sed -i -e 's/\(export CXX.*$\)/\1\n[ -n "$WM_CC" ] \&\& export CC="$WM_CC"/' makeParaView

For building ParaView, which will take a while... somewhere between 30 minutes to 2 hours or more, run:
```
./makeParaView > log.makePV 2>&1
```
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.
Update the shell environment:
```
wmSET $FOAM_SETTINGS
```

Now, in order to build the OpenFOAM readers for ParaView 3.12.0, run:

cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers 
./Allwclean 
./Allwmake

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.1.1 shell environment. In other words, run the following command whenever you start a new terminal:

of211

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: No thread available. Please a create a new thread in the forum.

Installation/Linux/OpenFOAM-2.1.1/Ubuntu

1 Introduction

Contents

2 Copy-Paste steps

2.1 Ubuntu 8.04

2.2 Ubuntu 10.04

2.3 Ubuntu 12.04

2.4 Ubuntu 12.10

2.5 Ubuntu 16.04

2.6 Ubuntu 16.10

2.7 Ubuntu 18.04