Installation/swak4Foam/Downloading

From OpenFOAMWiki

1 Introduction

This page is dedicated to explaining how and which versions of swak4Foam to download and from where, depending on the OpenFOAM version you are using. Once you've successfully downloaded swak4Foam, go back to the instructions page you were following.

Note: 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.

Note to those who are willing to help:

  • Feel free to update this page whenever a new version of OpenFOAM or swak4Foam is made available and you've fully tested.
  • Installation instructions should be provided according to the indications given in the main Installation/swak4Foam page.


2 OpenFOAM

This chapter refers to the official version of OpenFOAM provided by the OpenFOAM Foundation.

2.1 OpenFOAM 2.0.0 to 2.1.x

Valid versions:
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination

Notes:

  • The downloading steps below have been specifically coded for downloading swak4Foam version 0.3.2.
  • Only tested building with OpenFOAM 2.1.x, but it's expected it still works with 2.0.x as well... if not, please a create a new thread in the forum.
  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam@2076 swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder2.0-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam
      (cd swak4Foam && git checkout 1bf86713f5a -b 032)
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/1bf86713f5a9c4ec24d5fcd22edd40a04991b215.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215 swak4Foam

      Or manually:

      1. Download this file: 1bf86713f5a9c4ec24d5fcd22edd40a04991b215.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215 swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/1bf86713f5a9c4ec24d5fcd22edd40a04991b215.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215 swak4Foam

      Or manually:

      1. Download this file: 1bf86713f5a9c4ec24d5fcd22edd40a04991b215.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215 swak4Foam
  3. And we are not done yet. We need to make some repairs on the source code (as reported here), for it to build with OpenFOAM 2.0 and 2.1:
    cd swak4Foam
    wget https://sourceforge.net/p/openfoam-extend/ticketsswak4foam/_discuss/thread/eaf9b049/ccb1/attachment/solverPerformanceToGlobalVariables_lduMatrix_solverPerformance_of20_21.patch
    patch -p1 < solverPerformanceToGlobalVariables_lduMatrix_solverPerformance_of20_21.patch
    cd ..
  4. And with this, it should be ready for the next step, namely building it. If you are not certain of that to do next, then go to the page parent Installation/swak4Foam and start read through that page.

2.2 OpenFOAM 2.2.0 to 3.0.x

Valid versions:
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination

Note: The downloading steps below have been tested after swak4Foam version 0.4.0 was released.

Installation steps:

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it depends from where you are able to download, so try each one, until you're able to download it (namely don't get any error message):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam/ swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder2.0-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    5. Or manually download a snapshot from the SVN interface at Sourceforge.net:
      1. Go to this page: SVN snapshot request for swak4Foam 2.x series
      2. Request a snapshot on that page.
      3. Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command:
        pwd
      4. Rename the folder to swak4Foam.
  3. And with this, it should be ready for the next step, namely building it. If you are not certain of that to do next, then go to the page parent Installation/swak4Foam and start read through that page.

2.3 OpenFOAM 4.0 to 4.x

At the time of this writing, the latest stable version is version 0.4.0, which does not support OpenFOAM 4.0. You need to get the development version, as explained in chapter swak4Foam development version.

3 Extend Project forks of OpenFOAM

This chapter refers to the forks OpenFOAM provided by the Extend Project at FOAM-Extend.org.

3.1 OpenFOAM 1.6-ext

Note: The downloading steps below have been specifically coded for downloading swak4Foam version 0.2.4.

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_1.7/libraries/swak4Foam@1998 swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder1.7-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam.git swak4Foam
      (cd swak4Foam && git checkout 9ee3a04f9e -b 024)
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam/archive/9ee3a04f9e22bb5c0c688223acb392e343589da1.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam

      Or manually:

      1. Download this file: 9ee3a04f9e22bb5c0c688223acb392e343589da1.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam/archive/9ee3a04f9e22bb5c0c688223acb392e343589da1.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam

      Or manually:

      1. Download this file: 9ee3a04f9e22bb5c0c688223acb392e343589da1.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam
  3. And with this, it should be ready for the next step, namely building it. If you are not certain of that to do next, then go to the page parent Installation/swak4Foam and start read through that page.

3.2 FOAM-Extend 3.0 to 3.2

Notes:

  • The downloading steps below have been tested after swak4Foam version 0.3.2 was released.
  • FOAM-Extend 3.1 and 3.2 versions do provide its own swak4Foam built during the first installation, so the instructions below are most likely useful only as a reference or for updating.

Installation steps:

  1. First, go into a good working folder. For example, to go to the folder $HOME/foam/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main SVN repository, using the svn command:
      svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam/ swak4Foam
    2. Or from a mirror Git repository (openfoam-extend-Breeder2.0-libraries-swak4Foam), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam
    3. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    4. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam

      Or manually:

      1. Download this file: master.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam
    5. Or manually download a snapshot from the SVN interface at Sourceforge.net:
      1. Go to this page: SVN snapshot request for swak4Foam 2.x series
      2. Request a snapshot on that page.
      3. Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command:
        pwd
      4. Rename the folder to swak4Foam.
  3. And with this, it should be ready for the next step, namely building it. If you are not certain of that to do next, then go to the page parent Installation/swak4Foam and start read through that page.


4 OpenFOAM+ (plus)

This chapter refers to the official version of OpenFOAM+ provided by ESI-OpenCFD.

4.1 OpenFOAM+ v3.0+

Valid versions:
Error creating thumbnail: Unable to save thumbnail to destination

Please follow the instructions written for OpenFOAM 2.2.0 to 3.0.x, because they are identical.


4.2 OpenFOAM+ v1606+

Valid versions:
Error creating thumbnail: Unable to save thumbnail to destination

At the time of this writing, the latest stable version is version 0.4.0, which does not support OpenFOAM+ v1606+. You need to get the development version, as explained in chapter swak4Foam development version.


5 swak4Foam development version

Valid versions:
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination

Note (22:05, 15 October 2016 (CEST)): These instructions were updated a few months after the stable version 0.4.0 of swak4Foam was released, also because that stable version isn't compatible with OpenFOAM 4.0 to 4.x.

Installation steps:

  1. First, go into a good working folder. For example, to go to the folder $HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION, run the following commands in a terminal:
    mkdir -p $FOAM_RUN
    cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"
  2. Now, it all comes down to where you're able to download from one of the following locations (try each one, until you're able to download it):
    1. From the main Mercurial development repository, using the hg command, download from the repository and checkout the right branch:
      hg clone http://hg.code.sf.net/p/openfoam-extend/swak4Foam swak4Foam
      (cd swak4Foam && hg update develop)
    2. Or manually download a snapshot from the Mercurial interface at Sourceforge.net:
      1. Go to this page: Mercurial repository for swak4Foam - branch "develop"
      2. Request a snapshot on that page; in other words click on the link Download Snapshot.
      3. Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command:
        pwd
      4. Rename the folder to swak4Foam.
    3. Or from a mirror Git repository (openfoam-extend-swak4Foam-dev), using the git command:
      git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev.git swak4Foam

      Then checkout the correct branch:

      cd swak4Foam
      git checkout branches/develop
      cd ..

      WARNING: Mirror repositories can take 24h or more to sync up with the main repository!

    4. Or by downloading a snapshot in a GZipped Tarball format (tar.gz) from the same Git mirror repository, from the branch branches/develop either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/branches/develop.tar.gz" -O swak4Foam.tar.gz
      tar -xf swak4Foam.tar.gz
      mv openfoam-extend-swak4Foam-dev-branches-develop swak4Foam

      Or manually:

      1. Download this file: develop.tar.gz
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-branches-develop" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-swak4Foam-dev-branches-develop swak4Foam

      WARNING: Mirror repositories can take 24h or more to sync up with the main repository!

    5. Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
      wget "https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/branches/develop.zip" -O swak4Foam.zip
      unzip swak4Foam.zip
      mv openfoam-extend-swak4Foam-dev-branches-develop swak4Foam

      Or manually:

      1. Download this file: develop.zip
      2. Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-branches-develop" into the folder indicated by this command:
        pwd
      3. Rename the folder:
        mv openfoam-extend-swak4Foam-dev-branches-develop swak4Foam

      WARNING: Mirror repositories can take 24h or more to sync up with the main repository!

  3. And with this, it should be ready for the next step, namely building it. If you are not certain of that to do next, then go to the page parent Installation/swak4Foam and start read through that page.