Latest revision as of 15:21, 27 October 2018

1 Introduction

This page is dedicated to explaining how to install OpenFOAM in openSUSE.

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 openSUSE 12.3

You can follow either one of these instructions:

Follow the official instructions for building from source code: Download v2.3.1 | Source Pack
Install GeekoCFD, which is an openSUSE installation with OpenFOAM pre-installed: albertopassalacqua.com - category openSUSE
Or follow the 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 -
```

Install the necessary packages:

zypper install -t pattern devel_C_C++
zypper install cmake libqt4-devel qt4-x11-tools qt4-assistant-adp-devel gnuplot openmpi-devel \
boost-devel gmp-devel mpfr-devel libQtWebKit-devel

Now exit from the root mode:
```
exit
```
Now, since we're trying to minimize the number of packages to be built, the Open-MPI package that is available with openSUSE is going to be chosen. The downside is that this requires that you logout and log back in, for the system to update the environment settings.
Nonetheless, we can postpone logging out by running:
```
source /etc/profile.d/mpi-selector.sh
```
Note: But keep in mind that until you logout, use this command line on every new terminal window/tab!

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

For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of openSUSE. 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.3.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.3.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 of231='source \$HOME/OpenFOAM/OpenFOAM-2.3.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.3.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of231
```
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 the ThirdParty folder, because we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:

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
wmSET $FOAM_SETTINGS

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 4.1.0 that comes with OpenFOAM:

cd $WM_THIRD_PARTY_DIR
./makeParaView4
 
cd $FOAM_UTILITIES/postProcessing/graphics/PV4Readers 
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.3.1 shell environment. In other words, run the following command whenever you start a new terminal:

of231

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 openSUSE 13.1

The steps meant for openSUSE 12.3 work as intended for 13.1.

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

2.3 openSUSE 13.2

You can follow either one of these instructions:

Follow the official instructions for building from source code: Download v2.3.1 | Source Pack
Install GeekoCFD, which is an openSUSE installation with OpenFOAM pre-installed: albertopassalacqua.com - category openSUSE
Or follow the instructions below...

Discussion thread where you can ask questions about these steps: Installation of ParaView 4.1.0 with OpenFOAM 2.3.0 on OpenSuse 13.2

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

Install the necessary packages:

zypper install -t pattern devel_C_C++
zypper install cmake libqt4-devel qt4-x11-tools qt4-assistant-adp-devel gnuplot openmpi-devel \
boost-devel cgal-devel gmp-devel mpfr-devel libQtWebKit-devel python-devel

Now exit from the root mode:
```
exit
```
Now, since we're trying to minimize the number of packages to be built, the Open-MPI package that is available with openSUSE is going to be chosen. The downside is that this requires that you logout and log back in, for the system to update the environment settings.
Nonetheless, we can postpone logging out by running:
```
source /etc/profile.d/mpi-selector.sh
```
Note: But keep in mind that until you logout, use this command line on every new terminal window/tab!

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

For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of openSUSE. 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.3.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.3.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 of231='source \$HOME/OpenFOAM/OpenFOAM-2.3.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.3.1 shell environment. In other words, whenever you start a new terminal, you should run:
```
of231
```
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 need to do a little symbolic hacking, in order to use the system's CGAL installation:

cd $WM_THIRD_PARTY_DIR
 
mkdir -p $CGAL_ARCH_PATH
ln -s /usr/include $CGAL_ARCH_PATH/include

Now, this next command depends on what uname told you before:

i386:
```
ln -s /usr/lib $CGAL_ARCH_PATH/lib
```
x86_64:
```
ln -s /usr/lib64 $CGAL_ARCH_PATH/lib
```

Now let's build the ThirdParty folder, because we need the shell environment to be updated afterwards, for CGAL to be properly picked up for building OpenFOAM:

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
wmSET $FOAM_SETTINGS

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 4.1.0 that comes with OpenFOAM, including with the ability to use Python and MPI, several steps are needed:

Need to do several fixes:

cd $WM_THIRD_PARTY_DIR
 
sed -i -e 's=MPI_ARCH_PATH/include=MPI_ARCH_PATH/include;$MPI_INCLUDE=' etc/tools/ParaView4Functions
 
sed -i -e 's=//#define GLX_GLXEXT_LEGACY=#define GLX_GLXEXT_LEGACY=' \
  ParaView-4.1.0/VTK/Rendering/OpenGL/vtkXOpenGLRenderWindow.cxx
 
cd $WM_THIRD_PARTY_DIR/ParaView-4.1.0
 
wget http://www.paraview.org/pipermail/paraview/attachments/20140210/464496cc/attachment.bin -O Fix.patch
patch -p1 < Fix.patch
 
cd VTK
wget https://github.com/gladk/VTK/commit/ef22d3d69421581b33bc0cd94b647da73b61ba96.patch -O Fix2.patch
patch -p1 < Fix2.patch
 
cd ../..

For building ParaView with Python and MPI, it depends on whether you have installed the i686 or x86_64 architecture of openSUSE. To check this, run:

uname -m

Now, accordingly:

For i686:

cd $WM_THIRD_PARTY_DIR
 
#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView4 -python -mpi -python-lib /usr/lib/libpython2.7.so.1.0 > log.makePV 2>&1

For x86_64:

cd $WM_THIRD_PARTY_DIR
 
#one final fix
sed -i -e 's=MPI_ARCH_PATH/lib/=MPI_ARCH_PATH/lib64/=g' etc/tools/ParaView4Functions
 
#this will take a while... somewhere between 30 minutes to 2 hours or more
./makeParaView4 -python -mpi -python-lib /usr/lib64/libpython2.7.so.1.0 > log.makePV 2>&1

Once the makeParaView4 script is finished running, make sure to check the contents of the file log.makePV and check if there are any errors.

Finally, update the shell environment and build the official reader plug-in:

cd $FOAM_UTILITIES/postProcessing/graphics/PV4Readers 
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.3.1 shell environment. In other words, run the following command whenever you start a new terminal:

of231

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: Installation of ParaView 4.1.0 with OpenFOAM 2.3.0 on OpenSuse 13.2

2.4 openSUSE Leap 42.1

The instructions tested for openSUSE 13.2 should also work in openSUSE Leap 42.1.

Discussion thread where you can ask questions about these steps: OpenFOAM-2.3.1 on opensuse Leap-42.1

@@ Line 19: / Line 19: @@
 You can follow either one of these instructions:
-* Follow the official instructions for building from source code: [http://www.openfoam.org/archive/2.3.1/download/source.php Source Pack Installation]
+* Follow the official instructions for building from source code: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
 * Install GeekoCFD, which is an openSUSE installation with OpenFOAM pre-installed: [http://albertopassalacqua.com/?cat=3 albertopassalacqua.com - category openSUSE]
 * Or follow the instructions below...
-'''Discussion thread where you can ask questions about these steps''': ''none so far.''
+'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
 Steps:
@@ Line 80: / Line 80: @@
 # This next command will take a while... somewhere between 5 minutes to 30 minutes.
-./Allwmake > make.log 2>&1
+./Allwmake > log.make 2>&1
 #update the shell environment
@@ Line 93: / Line 93: @@
 # This next command will take a while... somewhere between 30 minutes to 3-6 hours.
-./Allwmake > make.log 2>&1
+./Allwmake > log.make 2>&1
 #Run it a second time for getting a summary of the installation
-./Allwmake > make.log 2>&1
+./Allwmake > log.make 2>&1
 </bash></li>
@@ Line 110: / Line 110: @@
 ./Allwmake
 </bash></li>
-<li>Now you can go read the User Guide: [http://www.openfoam.org/docs/user/ official OpenFOAM User Guide]</li>
+<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
 </ol>
@@ Line 117: / Line 117: @@
-'''Discussion thread where you can ask questions about these steps''': ''none so far.''
+'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
 == openSUSE 13.1 ==
@@ Line 123: / Line 123: @@
 The steps meant for [[#openSUSE 12.3|openSUSE 12.3]] work as intended for 13.1.
-'''Discussion thread where you can ask questions about these steps for openSUSE 13.1''': ''none so far.''
+'''Discussion thread where you can ask questions about these steps''': {{Installation/NoThreadAskForum}}
@@ Line 129: / Line 129: @@
 You can follow either one of these instructions:
-* Follow the official instructions for building from source code: [http://www.openfoam.org/archive/2.3.1/download/source.php Source Pack Installation]
+* Follow the official instructions for building from source code: [http://openfoam.org/download/2-3-1-source/ Download v2.3.1 | Source Pack]
 * Install GeekoCFD, which is an openSUSE installation with OpenFOAM pre-installed: [http://albertopassalacqua.com/?cat=3 albertopassalacqua.com - category openSUSE]
 * Or follow the instructions below...
@@ Line 141: / Line 141: @@
 <bash>zypper install -t pattern devel_C_C++
 zypper install cmake libqt4-devel qt4-x11-tools qt4-assistant-adp-devel gnuplot openmpi-devel \
-boost-devel cgal-devel gmp-devel mpfr-devel metis-devel libQtWebKit-devel python-devel
+boost-devel cgal-devel gmp-devel mpfr-devel libQtWebKit-devel python-devel
 </bash>
 </li>
@@ Line 162: / Line 162: @@
 tar -xzf ThirdParty-2.3.1.tgz
 </bash></li>
-<li>Since we'll using the system's METIS installation, we need to configure the respective file accordingly:
-<bash>mkdir -p ~/.OpenFOAM/2.3.1/config
-echo export METIS_VERSION=metis-5.1.0 > ~/.OpenFOAM/2.3.1/config/metis.sh
-echo export METIS_ARCH_PATH=/usr >> ~/.OpenFOAM/2.3.1/config/metis.sh</bash>
-</li>
 <li>For building OpenFOAM itself, it depends on whether you have installed the i386 or x86_64 architecture of openSUSE. To check this, run:
@@ Line 208: / Line 201: @@
 # This next command will take a while... somewhere between 5 minutes to 30 minutes.
-./Allwmake > make.log 2>&1
+./Allwmake > log.make 2>&1
 #update the shell environment
@@ Line 221: / Line 214: @@
 # This next command will take a while... somewhere between 30 minutes to 3-6 hours.
-./Allwmake > make.log 2>&1
+./Allwmake > log.make 2>&1
 #Run it a second time for getting a summary of the installation
-./Allwmake > make.log 2>&1
+./Allwmake > log.make 2>&1
 </bash></li>
@@ Line 286: / Line 279: @@
 </li>
-<li>Now you can go read the User Guide: [http://www.openfoam.org/docs/user/ official OpenFOAM User Guide]</li>
+<li>{{Installation/ReadUserGuideEtAl_OpenFOAMFoundation}}</li>
 </ol>
@@ Line 294: / Line 287: @@
 '''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/144925-installation-paraview-4-1-0-openfoam-2-3-0-opensuse-13-2-a.html Installation of ParaView 4.1.0 with OpenFOAM 2.3.0 on OpenSuse 13.2]
+== openSUSE Leap 42.1 ==
+The instructions tested for [[#openSUSE 13.2|openSUSE 13.2]] should also work in openSUSE Leap 42.1.
+'''Discussion thread where you can ask questions about these steps''': [http://www.cfd-online.com/Forums/openfoam-installation/163170-openfoam-2-3-1-opensuse-leap-42-1-a.html OpenFOAM-2.3.1 on opensuse Leap-42.1]
 [[Category:Installing OpenFOAM on Linux]] [[Category:Installing OpenFOAM on openSUSE]]

Difference between revisions of "Installation/Linux/OpenFOAM-2.3.1/openSUSE"

Latest revision as of 15:21, 27 October 2018

1 Introduction

Contents

2 Copy-Paste steps

2.1 openSUSE 12.3

2.2 openSUSE 13.1

2.3 openSUSE 13.2

2.4 openSUSE Leap 42.1