View source for Installation/swak4Foam/Downloading

= Introduction =
This page is dedicated to explaining how and which versions of [[Contrib/swak4Foam|swak4Foam]] to download and from where, depending on the OpenFOAM version you are using. Once you've successfully downloaded {{tt|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 [[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.

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

__FORCETOC__
__TOC__

= OpenFOAM =
This chapter refers to the official version of OpenFOAM provided by the [http://www.openfoam.org OpenFOAM Foundation].

== OpenFOAM 2.0.0 to 2.1.x ==
{{VersionInfo}}{{Version2.0}}{{Version2.1}}

'''Notes:'''
* The downloading steps below have been specifically ''coded'' for downloading swak4Foam [[Contrib/swak4Foam#2015-05-31_-_Version:_0.3.2|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 [http://www.cfd-online.com/Forums/openfoam-installation/ a create a new thread in the forum].

<ol>
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
<bash>mkdir -p $FOAM_RUN
cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"</bash>
</li>

<li>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):

<ol>
<li>From the main SVN repository, using the {{tt|svn}} command:
<bash>svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam@2076 swak4Foam</bash>
</li>

<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam openfoam-extend-Breeder2.0-libraries-swak4Foam]), using the {{tt|git}} command:
<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam
(cd swak4Foam && git checkout 1bf86713f5a -b 032)</bash>
</li>

<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/1bf86713f5a9c4ec24d5fcd22edd40a04991b215.tar.gz 1bf86713f5a9c4ec24d5fcd22edd40a04991b215.tar.gz]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215 swak4Foam</bash>
</li>

<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/1bf86713f5a9c4ec24d5fcd22edd40a04991b215.zip 1bf86713f5a9c4ec24d5fcd22edd40a04991b215.zip]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder2.0-libraries-swak4Foam-1bf86713f5a9c4ec24d5fcd22edd40a04991b215 swak4Foam</bash>
</li>
</ol>

</li>

<li>And we are not done yet. We need to make some repairs on the source code (as [https://sourceforge.net/p/openfoam-extend/ticketsswak4foam/229/ reported here]), for it to build with OpenFOAM 2.0 and 2.1:
<bash>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 ..
</bash>
</li>

<li>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.</li>
</ol>

== OpenFOAM 2.2.0 to 3.0.x ==
{{VersionInfo}}{{Version2.2}}{{Version2.3}}{{Version2.4}}{{Version3.0}}

'''Note:''' The downloading steps below have been tested after swak4Foam [[Contrib/swak4Foam#2016-07-15 - Version: 0.4.0|version 0.4.0]] was released.

Installation steps:
<ol>
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
<bash>mkdir -p $FOAM_RUN
cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"</bash>
</li>

<li>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):

<ol>
<li>From the main SVN repository, using the {{tt|svn}} command:
<bash>svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam/ swak4Foam</bash>
</li>

<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam openfoam-extend-Breeder2.0-libraries-swak4Foam]), using the {{tt|git}} command:
<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam</bash>
</li>

<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.tar.gz master.tar.gz]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam</bash>
</li>

<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.zip master.zip]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam</bash>
</li>

<li>Or manually download a snapshot from the SVN interface at Sourceforge.net:
# Go to this page: [http://sourceforge.net/p/openfoam-extend/svn/HEAD/tarball?path=/trunk/Breeder_2.0/libraries/swak4Foam SVN snapshot request for swak4Foam 2.x series]
# Request a snapshot on that page.
# Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder to {{tt|swak4Foam}}.
</li>

</ol>

</li>

<li>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.</li>
</ol>

== OpenFOAM 4.0 to 4.x ==
At the time of this writing, the latest stable version is [[Contrib/swak4Foam#2016-07-15 - Version: 0.4.0|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|swak4Foam development version]].

= Extend Project forks of OpenFOAM =
This chapter refers to the forks OpenFOAM provided by the [http://www.extend-project.de/ Extend Project] at [http://foam-extend.org FOAM-Extend.org].

== OpenFOAM 1.6-ext ==
'''Note:''' The downloading steps below have been specifically ''coded'' for downloading swak4Foam [[Contrib/swak4Foam#2013-05-24_-_Version:_0.2.4|version 0.2.4]].

<ol>
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
<bash>mkdir -p $FOAM_RUN
cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"</bash>
</li>

<li>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):

<ol>
<li>From the main SVN repository, using the {{tt|svn}} command:
<bash>svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_1.7/libraries/swak4Foam@1998 swak4Foam</bash>
</li>

<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam openfoam-extend-Breeder1.7-libraries-swak4Foam]), using the {{tt|git}} command:
<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam.git swak4Foam
(cd swak4Foam && git checkout 9ee3a04f9e -b 024)</bash>
</li>

<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam/archive/9ee3a04f9e22bb5c0c688223acb392e343589da1.tar.gz 9ee3a04f9e22bb5c0c688223acb392e343589da1.tar.gz]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam</bash>
</li>

<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder1.7-libraries-swak4Foam/archive/9ee3a04f9e22bb5c0c688223acb392e343589da1.zip 9ee3a04f9e22bb5c0c688223acb392e343589da1.zip]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder1.7-libraries-swak4Foam-9ee3a04f9e22bb5c0c688223acb392e343589da1 swak4Foam</bash>
</li>
</ol>

</li>

<li>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.</li>
</ol>

== FOAM-Extend 3.0 to 3.2 ==
'''Notes:'''
* The downloading steps below have been tested after swak4Foam [[Contrib/swak4Foam#2015-05-31 - Version: 0.3.2|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:
<ol>
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/foam/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
<bash>mkdir -p $FOAM_RUN
cd "$HOME/foam/$USER-$WM_PROJECT_VERSION"</bash>
</li>

<li>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):

<ol>
<li>From the main SVN repository, using the {{tt|svn}} command:
<bash>svn checkout svn://svn.code.sf.net/p/openfoam-extend/svn/trunk/Breeder_2.0/libraries/swak4Foam/ swak4Foam</bash>
</li>

<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam openfoam-extend-Breeder2.0-libraries-swak4Foam]), using the {{tt|git}} command:
<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam.git swak4Foam</bash>
</li>

<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.tar.gz master.tar.gz]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam</bash>
</li>

<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-Breeder2.0-libraries-swak4Foam/archive/master.zip master.zip]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-Breeder2.0-libraries-swak4Foam-master" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-Breeder2.0-libraries-swak4Foam-master swak4Foam</bash>
</li>

<li>Or manually download a snapshot from the SVN interface at Sourceforge.net:
# Go to this page: [http://sourceforge.net/p/openfoam-extend/svn/HEAD/tarball?path=/trunk/Breeder_2.0/libraries/swak4Foam SVN snapshot request for swak4Foam 2.x series]
# Request a snapshot on that page.
# Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder to {{tt|swak4Foam}}.
</li>

</ol>

</li>

<li>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.</li>
</ol>


= OpenFOAM+ (plus) =
This chapter refers to the official version of OpenFOAM+ provided by [http://www.openfoam.com ESI-OpenCFD].

== OpenFOAM+ v3.0+ ==
{{VersionInfo}}{{Version3.0+}}

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


== OpenFOAM+ v1606+ ==
{{VersionInfo}}{{Version1606+}}

At the time of this writing, the latest stable version is [[Contrib/swak4Foam#2016-07-15 - Version: 0.4.0|version 0.4.0]], which does not support OpenFOAM+ v1606+. You need to get the development version, as explained in chapter [[#swak4Foam development version|swak4Foam development version]].


= swak4Foam development version =
{{VersionInfo}}{{Version2.2}}{{Version2.3}}{{Version2.4}}{{Version3.0}}{{Version4}}{{Version3.0-ext}}{{Version3.1-ext}}{{Version3.2-ext}}{{Version4.0-ext}}{{Version3.0+}}{{version1606+}}

'''Note (22:05, 15 October 2016 (CEST)):''' These instructions were updated a few months after the stable [[Contrib/swak4Foam#2016-07-15 - Version: 0.4.0|version 0.4.0]] of {{tt|swak4Foam}} was released, also because that stable version isn't compatible with OpenFOAM 4.0 to 4.x.

Installation steps:
<ol {{NoIndentStyle}}>
<li>First, go into a good working folder. For example, to go to the folder {{tt|$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION}}, run the following commands in a terminal:
<bash>mkdir -p $FOAM_RUN
cd "$HOME/OpenFOAM/$USER-$WM_PROJECT_VERSION"</bash>
</li>

<li>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):

<ol>
<li>From the main Mercurial development repository, using the {{tt|hg}} command, download from the repository and checkout the right branch:
<bash>hg clone http://hg.code.sf.net/p/openfoam-extend/swak4Foam swak4Foam
(cd swak4Foam && hg update develop)</bash>
</li>

<li>Or manually download a snapshot from the Mercurial interface at Sourceforge.net:
# Go to this page: [https://sourceforge.net/p/openfoam-extend/swak4Foam/ci/develop/tree/ Mercurial repository for swak4Foam - branch "develop"]
# Request a snapshot on that page; in other words click on the link ''Download Snapshot''.
# Unpack the downloaded file and move the unpacked folder, into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder to {{tt|swak4Foam}}.
</li>

<li>Or from a mirror Git repository ([https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev openfoam-extend-swak4Foam-dev]), using the {{tt|git}} command:
<bash>git clone https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev.git swak4Foam</bash>
Then checkout the correct branch:
<bash>cd swak4Foam
git checkout branches/develop
cd ..</bash>
'''WARNING''': Mirror repositories can take 24h or more to sync up with the main repository!
</li>

<li>Or by downloading a snapshot in a ''GZipped Tarball'' format ({{tt|tar.gz}}) from the same Git mirror repository, from the branch {{tt|branches/develop}} either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/branches/develop.tar.gz develop.tar.gz]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-branches-develop" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-swak4Foam-dev-branches-develop swak4Foam</bash>

'''WARNING''': Mirror repositories can take 24h or more to sync up with the main repository!
</li>

<li>Or by downloading a snapshot in ZIP format from the same Git mirror repository, either directly in the command line:
<bash>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
</bash>
Or manually:
# Download this file: [https://github.com/Unofficial-Extend-Project-Mirror/openfoam-extend-swak4Foam-dev/archive/branches/develop.zip develop.zip]
# Unpack the downloaded file and move the unpacked folder "openfoam-extend-swak4Foam-dev-branches-develop" into the folder indicated by this command: <bash>pwd</bash>
# Rename the folder: <bash>mv openfoam-extend-swak4Foam-dev-branches-develop swak4Foam</bash>

'''WARNING''': Mirror repositories can take 24h or more to sync up with the main repository!
</li>

</ol>

</li>

<li>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.</li>
</ol>


[[Category:Installing swak4Foam]]