(Added installation instructions) |
(Updated build instructions) |
||
| Line 32: | Line 32: | ||
<li>Checkout the repository respective to the version of OpenFOAM you are using: | <li>Checkout the repository respective to the version of OpenFOAM you are using: | ||
| − | * OpenFOAM 2. | + | * OpenFOAM 2.0 and newer: |
| − | <bash>git checkout | + | <bash>git checkout OF20x</bash> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
* OpenFOAM 1.7 and older: | * OpenFOAM 1.7 and older: | ||
| Line 62: | Line 56: | ||
<li>Get the Zip file for the repository respective to the version of OpenFOAM you are using: | <li>Get the Zip file for the repository respective to the version of OpenFOAM you are using: | ||
| − | * OpenFOAM 2. | + | * OpenFOAM 2.0 and newer: |
| − | <bash>wget https://github.com/wyldckat/perturbU/archive/ | + | <bash>wget https://github.com/wyldckat/perturbU/archive/OF20x.zip -O perturbU.zip</bash> |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
* OpenFOAM 1.7 and older: | * OpenFOAM 1.7 and older: | ||
| − | <bash>wget https://github.com/wyldckat/perturbU/archive/master.zip</bash> | + | <bash>wget https://github.com/wyldckat/perturbU/archive/master.zip -O perturbU.zip</bash> |
</li> | </li> | ||
<li>Unzip the respective file and go into the respective folder, for example: | <li>Unzip the respective file and go into the respective folder, for example: | ||
| − | <bash>unzip | + | <bash>unzip perturbU.zip |
| − | cd perturbU- | + | cd perturbU-OF20x |
</bash> | </bash> | ||
</li> | </li> | ||
Revision as of 18:08, 21 March 2015
Contents
1 Introduction
- Source code repository
- perturbU at GitHub
- Description
- A few utilities for initializing fields for LES simulations.
- Support pages
-
- Issue/bug tracker: perturbU Issue Tracker
- Forum support thread: PerturbU
2 Installation
Valid versions: 
The installation depends on the way you download the source code:
2.1 Using Git
- Go to your user folder:
mkdir -p $FOAM_RUN cd $FOAM_RUN/..
- Clone the repository and go into the cloned repository:
git clone https://github.com/wyldckat/perturbU.git cd perturbU - Checkout the repository respective to the version of OpenFOAM you are using:
- OpenFOAM 2.0 and newer:
git checkout OF20x
- OpenFOAM 1.7 and older:
git checkout master
- Build perturbU* utilities by running:
wmake all
2.2 Using Zip
- Go to your user folder:
mkdir -p $FOAM_RUN cd $FOAM_RUN/..
- Get the Zip file for the repository respective to the version of OpenFOAM you are using:
- OpenFOAM 2.0 and newer:
wget https://github.com/wyldckat/perturbU/archive/OF20x.zip -O perturbU.zip
- OpenFOAM 1.7 and older:
wget https://github.com/wyldckat/perturbU/archive/master.zip -O perturbU.zip
- Unzip the respective file and go into the respective folder, for example:
unzip perturbU.zip cd perturbU-OF20x - Build perturbU* utilities by running:
wmake all
3 Usage
TODO
3.1 Threads on how to use perturbU
TODO
