View source for Installation/Linux/OpenFOAM-4.0/Ubuntu

= Introduction =
This page is dedicated to explaining how to install {{OpenFOAM}} {{version4.0}} in [http://www.ubuntu.com Ubuntu].

If you do not yet feel comfortable using Linux, then perhaps you better first read the page [[Installation/Working with the Shell|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.

__FORCETOC__
__TOC__

= ''Copy-Paste'' steps =

A few notes before you start copy-pasting:

# Lines that start with <tt>#</tt> 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!

== Ubuntu 12.04 ==

Here you have the following choices:
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/4-0-source/ Download v4.0 | Source Pack]
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential flex bison zlib1g-dev qt4-dev-tools libqt4-dev gnuplot libreadline-dev \
libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libgmp-dev libmpfr-dev python python-dev
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<li>Download and unpack (here you can copy-paste all in single go):
<bash>#OpenFOAM downloading and installation
cd ~
mkdir OpenFOAM
cd OpenFOAM
wget "http://download.openfoam.org/source/4-0" -O OpenFOAM-4.0.tgz
wget "http://download.openfoam.org/third-party/4-0" -O ThirdParty-4.0.tgz

tar -xzf OpenFOAM-4.0.tgz
tar -xzf ThirdParty-4.0.tgz

mv OpenFOAM-4.x-version-4.0 OpenFOAM-4.0
mv ThirdParty-4.x-version-4.0 ThirdParty-4.0
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-4.0}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-4.0
mkdir download
</bash>
</li>

<li>Now, we need to download the essential source code packages for these instructions you are following (the links are from the file {{tt|README.org}}):
<bash>wget -P download http://www.cmake.org/files/v3.2/cmake-3.2.1.tar.gz
wget -P download https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.8/CGAL-4.8.tar.xz
wget -P download http://sourceforge.net/projects/boost/files/boost/1.55.0/boost_1_55_0.tar.bz2</bash>
</li>

<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/cmake-3.2.1.tar.gz
tar -xJf download/CGAL-4.8.tar.xz
tar -xjf download/boost_1_55_0.tar.bz2</bash>
</li>

<li>Last but not least, the final command on this sub-list is to go back to the main {{tt|OpenFOAM}} folder:
<bash>cd ..
</bash>
</li>
</ol>
</li>

<li>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-4.0/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-4.0/bin/mpirun</bash>
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.
</li>

<li>A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions, along with a fix for linking to {{tt|Boost.Thread}} when CGAL is involved:
<bash>sed -i -e 's/\(boost_version=\)boost-system/\1boost_1_55_0/' OpenFOAM-4.0/etc/config.sh/CGAL
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.8/' OpenFOAM-4.0/etc/config.sh/CGAL
sed -i -e 's=\-lmpfr=-lmpfr -lboost_thread=' OpenFOAM-4.0/wmake/rules/General/CGAL
</bash>
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends on whether you need 64-bit integer support or not:
<ul {{NoIndentStyle}}>
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc FOAMY_HEX_MESH=yes
</bash>
</li>
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of40='source \$HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-4.0|of40}}
</li>

<li>In order to build ParaView, we need to build CMake 3.2.1, which is the default version used by the  scripts in OpenFOAM 4.0, therefore the following steps will download, unpack and build our custom CMake:
<bash>cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCM 2>&1
wmRefresh</bash>
</li>

<li>Now let's build the {{tt|ThirdParty}} folder, because we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:
<bash>cd $WM_THIRD_PARTY_DIR

# This next command will take a while... somewhere between 5 minutes to 30 minutes.
./Allwmake > log.make 2>&1

#update the shell environment
wmRefresh
</bash>
</li>

<li>Now, in order to build ParaView 5.0.1, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>For building ParaView with Python and MPI, run:
<bash>cd $WM_THIRD_PARTY_DIR

#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
</li>
<li>Finally, update the shell environment:
<bash>wmRefresh</bash>
</li>
</ol>
</li>

<li>Now let's build OpenFOAM:
<ol>
<li>Go into OpenFOAM's main source folder:
<bash>cd $WM_PROJECT_DIR</bash>
</li>
<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
{{Installation/Linux/NumberOfCores}}
</li>
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''Note:''' Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.
</li>
</ol>
</li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-4.0|of40}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

== Ubuntu 14.04 ==

Here you have the following choices:
* You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 3.0.1. This is the quickest solution for beginners and instructions are provided here: [http://openfoam.org/download/4-0-ubuntu/ Download v4.0 | Ubuntu]
** Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: [[FAQ/Installation and Running#Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?|Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?]]
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/4-0-source/ Download v4.0 | Source Pack]
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential binutils-dev cmake 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
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<li>Download and unpack (here you can copy-paste all in single go):
<bash>#OpenFOAM downloading and installation
cd ~
mkdir OpenFOAM
cd OpenFOAM
wget "http://download.openfoam.org/source/4-0" -O OpenFOAM-4.0.tgz
wget "http://download.openfoam.org/third-party/4-0" -O ThirdParty-4.0.tgz

tar -xzf OpenFOAM-4.0.tgz
tar -xzf ThirdParty-4.0.tgz

mv OpenFOAM-4.x-version-4.0 OpenFOAM-4.0
mv ThirdParty-4.x-version-4.0 ThirdParty-4.0
</bash>
But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-4.0}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-4.0
mkdir download
</bash>
</li>

<li>Now, we need to download the essential source code packages for these instructions you are following (the links are from the file {{tt|README.org}}):
<bash>wget -P download http://www.cmake.org/files/v3.2/cmake-3.2.1.tar.gz
wget -P download https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.8/CGAL-4.8.tar.xz
wget -P download http://sourceforge.net/projects/boost/files/boost/1.55.0/boost_1_55_0.tar.bz2</bash>
</li>

<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/cmake-3.2.1.tar.gz
tar -xJf download/CGAL-4.8.tar.xz
tar -xjf download/boost_1_55_0.tar.bz2</bash>
</li>

<li>Last but not least, the final command on this sub-list is to go back to the main {{tt|OpenFOAM}} folder:
<bash>cd ..
</bash>
</li>
</ol>
</li>

<li>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-4.0/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-4.0/bin/mpirun</bash>
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.
</li>

<li>A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions, along with a fix for linking to {{tt|Boost.Thread}} when CGAL is involved:
<bash>sed -i -e 's/\(boost_version=\)boost-system/\1boost_1_55_0/' OpenFOAM-4.0/etc/config.sh/CGAL
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.8/' OpenFOAM-4.0/etc/config.sh/CGAL
sed -i -e 's=\-lmpfr=-lmpfr -lboost_thread=' OpenFOAM-4.0/wmake/rules/General/CGAL
</bash>
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends on whether you need 64-bit integer support or not:
<ul {{NoIndentStyle}}>
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc FOAMY_HEX_MESH=yes
</bash>
</li>
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of40='source \$HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-4.0|of40}}
</li>

<li>In order to build ParaView, we need to build CMake 3.2.1, which is the default version used by the  scripts in OpenFOAM 4.0, therefore the following steps will build our custom CMake (already downloaded it in a previous step):
<bash>cd $WM_THIRD_PARTY_DIR
./makeCmake > log.makeCM 2>&1
wmRefresh</bash>
</li>

<li>Now, in order to build ParaView 5.0.1, including with the ability to use Python and MPI, a few steps are needed:
<ol>
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
<bash>cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
 </bash>
</li>
<li>For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/i386-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>

<li>For x86_64:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
</ul>
</li>
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
</li>
<li>Finally, update the shell environment:
<bash>wmRefresh</bash>
</li>
</ol>
</li>

<li>Now let's build OpenFOAM:
<ol>
<li>Go into OpenFOAM's main source folder and be certain that the correct Qt version is being used:
<bash>cd $WM_PROJECT_DIR
export QT_SELECT=qt4</bash>
</li>

<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
{{Installation/Linux/NumberOfCores}}
</li>
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''Note:''' Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.
</li>
</ol>
</li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-4.0|of40}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

== Ubuntu 15.04 ==
The instructions written for [[#Ubuntu 14.04|Ubuntu 14.04]] also work in 15.04.

== Ubuntu 15.10 ==
The instructions written for [[#Ubuntu 14.04|Ubuntu 14.04]] also work in 15.10, although you can skip step #8, namely the step for installing a more recent CMake version.

== Ubuntu 16.04 ==

Here you have the following choices:
* You can install the Deb packages, which provide a quick and easy way for having a working installation of OpenFOAM 3.0.1. This is the quickest solution for beginners and instructions are provided here: [http://openfoam.org/download/4-0-ubuntu/ Download v4.0 | Ubuntu]
** Note: If are getting an error when trying to install the packages for Ubuntu, then check this FAQ: [[FAQ/Installation and Running#Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?|Why am I not able to install the official OpenFOAM Deb packages on Ubuntu ?]]
* You can install from source, by either:
** Following the official instructions from here: [http://openfoam.org/download/4-0-source/ Download v4.0 | Source Pack]
** Or by following the detailed step-by-step instructions below...


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential binutils-dev cmake 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
</bash>
'''Note''': It has been reported that the following should also be executed in some cases, so that ParaView and CGAL will build properly:
<bash>apt-get install libglu1-mesa-dev libqt4-opengl-dev</bash>
</li>

{{Installation/Linux/ExitRoot}}

<li>Download and unpack (here you can copy-paste all in single go):
<bash>#OpenFOAM downloading and installation
cd ~
mkdir OpenFOAM
cd OpenFOAM
wget "http://download.openfoam.org/source/4-0" -O OpenFOAM-4.0.tgz
wget "http://download.openfoam.org/third-party/4-0" -O ThirdParty-4.0.tgz

tar -xzf OpenFOAM-4.0.tgz
tar -xzf ThirdParty-4.0.tgz

mv OpenFOAM-4.x-version-4.0 OpenFOAM-4.0
mv ThirdParty-4.x-version-4.0 ThirdParty-4.0
</bash></li>

<li>'''Optional''': Let's make a few symbolic links that should ensure that the correct global MPI installation is used by this OpenFOAM installation:
<bash>ln -s /usr/bin/mpicc.openmpi OpenFOAM-4.0/bin/mpicc
ln -s /usr/bin/mpirun.openmpi OpenFOAM-4.0/bin/mpirun</bash>
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.
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes
</bash></li>

<li>For x86_64, it depends on whether you need 64-bit integer support or not:
<ul {{NoIndentStyle}}>
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc FOAMY_HEX_MESH=yes
</bash>
</li>
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of40='source \$HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-4.0|of40}}
</li>

<li>Now, in order to build ParaView 5.0.1, including with the ability to use Python and MPI, several steps are needed:
<ol>
<li>Make sure you're running in the {{tt|ThirdParty}} folder and that the correct Qt version is used:
<bash>cd $WM_THIRD_PARTY_DIR
export QT_SELECT=qt4
 </bash>
</li>
<li>For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/i386-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>

<li>For x86_64:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
</ul>
</li>
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
</li>
<li>Finally, update the shell environment:
<bash>wmRefresh</bash>
</li>
</ol>
</li>

<li>Now let's build OpenFOAM:
<ol>
<li>Go into OpenFOAM's main source folder and be certain that the correct Qt version is being used:
<bash>cd $WM_PROJECT_DIR
export QT_SELECT=qt4</bash>
</li>

<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
{{Installation/Linux/NumberOfCores}}
</li>
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''Note:''' Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.
</li>
</ol>
</li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-4.0|of40}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}


== Ubuntu 16.10 ==
The instructions written for [[#Ubuntu 16.04|Ubuntu 16.04]] also work in 16.10.


== Ubuntu 20.04 ==

'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}

Steps:
<ol>
{{Installation/Linux/SwitchToRoot}}
{{Installation/Linux/AptGetUpdate}}
<li>Install the necessary packages:
<bash>apt-get install git-core build-essential binutils-dev cmake flex bison zlib1g-dev gnuplot \
libreadline-dev libncurses-dev libxt-dev libopenmpi-dev openmpi-bin libboost-system-dev libboost-thread-dev libgmp-dev \
libmpfr-dev python2 python2-dev libcgal-dev \
gcc-7 g++-7
</bash>
'''Note:''' Open-MPI was installed, just as a way to be aware of possible conflicts between the custom and system versions.
</li>

{{Installation/Linux/ExitRoot}}

<li>Download and unpack (here you can copy-paste all in single go):
<bash>#OpenFOAM downloading and installation
cd ~
mkdir OpenFOAM
cd OpenFOAM
wget "http://download.openfoam.org/source/4-0" -O OpenFOAM-4.0.tgz
wget "http://download.openfoam.org/third-party/4-0" -O ThirdParty-4.0.tgz

tar -xzf OpenFOAM-4.0.tgz
tar -xzf ThirdParty-4.0.tgz

mv OpenFOAM-4.x-version-4.0 OpenFOAM-4.0
mv ThirdParty-4.x-version-4.0 ThirdParty-4.0
</bash>

But we will now have to download a few more of the necessary packages for the {{tt|ThirdParty-4.0}} folder:
<ol>
<li>First, we need to prepare for the downloads:
<bash>cd ThirdParty-4.0
mkdir download
</bash>
</li>

<li>Now, we need to download the essential source code packages for these instructions you are following (the links are from the file {{tt|README.org}}):
<bash>wget -P download http://www.cmake.org/files/v3.2/cmake-3.2.1.tar.gz
wget -P download https://github.com/CGAL/cgal/releases/download/releases%2FCGAL-4.8/CGAL-4.8.tar.xz
wget -P download https://sourceforge.net/projects/boost/files/boost/1.55.0/boost_1_55_0.tar.bz2
wget -P download https://download.open-mpi.org/release/open-mpi/v1.10/openmpi-1.10.2.tar.bz2
</bash>
</li>

<li>Next, we need to unpack the packages we've downloaded:
<bash>tar -xzf download/cmake-3.2.1.tar.gz
tar -xJf download/CGAL-4.8.tar.xz
tar -xjf download/boost_1_55_0.tar.bz2
tar -xjf download/openmpi-1.10.2.tar.bz2
</bash>
</li>

<li>Last but not least, the final command on this sub-list is to go back to the main {{tt|OpenFOAM}} folder:
<bash>cd ..
</bash>
</li>
</ol>

</li>

<li>A few details need to be fixed, before proceeding, which will change the default Boost and CGAL versions:
<bash>sed -i -e 's/\(boost_version=\)boost-system/\1boost_1_55_0/' OpenFOAM-4.0/etc/config.sh/CGAL
sed -i -e 's/\(cgal_version=\)cgal-system/\1CGAL-4.8/' OpenFOAM-4.0/etc/config.sh/CGAL
</bash>
</li>

<li>And we need to use GCC 7, because OpenFOAM 4.0 is not entirely compatible with GCC 9:
<bash>cp -r OpenFOAM-4.0/wmake/rules/linux64Gcc OpenFOAM-4.0/wmake/rules/linux64Gcc7
sed -i -e 's/gcc/\$(WM_CC)/' OpenFOAM-4.0/wmake/rules/linux64Gcc7/c
sed -i -e 's/g++/\$(WM_CXX)/' OpenFOAM-4.0/wmake/rules/linux64Gcc7/c++
echo "export WM_CC='gcc-7'" >> OpenFOAM-4.0/etc/bashrc
echo "export WM_CXX='g++-7'" >> OpenFOAM-4.0/etc/bashrc

sed -i -e 's/\(configOpt="--with-sge"\)/\1\n        configOpt="$configOpt --enable-mca-no-build=common-verbs_usnic"/'  ThirdParty-4.0/Allwmake
</bash>
</li>

<li>For building OpenFOAM itself, it depends on whether you have installed the i686 or x86_64 architecture of Ubuntu. To check this, run:
<bash>uname -m</bash>
Now, accordingly:
<ul {{NoIndentStyle}}>
<li>For i686:
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_ARCH_OPTION=32 FOAMY_HEX_MESH=yes WM_MPLIB=OPENMPI WM_COMPILER=Gcc7
</bash></li>

<li>For x86_64, it depends on whether you need 64-bit integer support or not:
<ul {{NoIndentStyle}}>
<li>For building with the normal 32-bit integer support (maximum 2.147×10<sup>9</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc FOAMY_HEX_MESH=yes WM_MPLIB=OPENMPI WM_COMPILER=Gcc7
</bash>
</li>
<li>For building with the normal 64-bit integer support (maximum 9.22×10<sup>18</sup> cells, faces or points):
<bash>source $HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc WM_LABEL_SIZE=64 FOAMY_HEX_MESH=yes WM_MPLIB=OPENMPI WM_COMPILER=Gcc7
</bash>
</li>
</ul>
</li>
</ul>
</li>

<li>Save an ''alias'' in the personal {{tt|.bashrc}} file, simply by running the following command:
<bash>echo "alias of40='source \$HOME/OpenFOAM/OpenFOAM-4.0/etc/bashrc $FOAM_SETTINGS'" >> $HOME/.bashrc
</bash>
{{Installation/Linux/AliasNote|OpenFOAM-4.0|of40}}
</li>

<li>Now, in order to build ParaView 5.0.1, including with the ability to use Python and MPI... there wasn't enough time to investigate this further. Qt4 is not provided with Ubuntu 20.04, so either a more recent version of ParaView would be needed, by using the instructions from [[Installation/Linux/OpenFOAM-7/Ubuntu/20.04]], or Qt4 built from source code.
</li>

<li>For x86_64:
<bash>#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView -python -mpi -python-lib /usr/lib/x86_64-linux-gnu/libpython2.7.so.1.0 > log.makePV 2>&1</bash>
</li>
</ul>
</li>
<li>{{Installation/ParaView/BuildProblemsCheckFAQ|makeParaView|log.makePV}}
</li>
<li>Finally, update the shell environment:
<bash>wmRefresh</bash>
</li>
</ol>
</li>

<li>Now let's build OpenFOAM:
<ol>
<li>Go into OpenFOAM's main source folder and be certain that the correct Qt version is being used:
<bash>cd $WM_PROJECT_DIR
export QT_SELECT=qt4</bash>
</li>

<li>This next command will take a while... somewhere between 30 minutes to 3-6 hours:
<bash>wget https://github.com/OpenFOAM/OpenFOAM-dev/commit/3fba921563fdb4436f73ace89fe9762474907953.patch
patch -p1 < 3fba921563fdb4436f73ace89fe9762474907953.patch

./Allwmake -j 4 > log.make 2>&1</bash>
{{Installation/Linux/NumberOfCores}}
</li>
<li>Run it a second time for getting a summary of the installation:
<bash>./Allwmake -j 4 > log.make 2>&1</bash>
'''Note:''' Technically, the build will stop as soon as the first error is found. Running a second time only makes it easier to sort through between what's already been built and where the crash occurred.
</li>
</ol>
</li>

<li>{{Installation/Linux/CheckIfAllWentWell}}</li>

<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>

<li>When you need to update your local ''clone'', for getting the latest source code updates, you can follow the instructions provided in the page [[Installation/Working with git repositories]].</li>
</ol>


{{Installation/Linux/AliasReminder|OpenFOAM-4.0|of40}}


'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}


[[Category:Installing OpenFOAM on Linux]] [[Category:Installing OpenFOAM on Ubuntu]]