(Kicked off this page) |
(Added installation instructions) |
||
| Line 9: | Line 9: | ||
:* Forum support thread: [http://www.cfd-online.com/Forums/openfoam-solving/59602-perturbu.html PerturbU] | :* Forum support thread: [http://www.cfd-online.com/Forums/openfoam-solving/59602-perturbu.html PerturbU] | ||
| − | = Threads on how to use <tt>perturbU</tt> = | + | = Installation = |
| + | |||
| + | {{versionInfo}} {{Version1.7}} {{Version2.0}} {{Version2.1}} {{Version2.2}} {{Version2.3}} | ||
| + | |||
| + | The installation depends on the way you download the source code: | ||
| + | * [[#Using Git|Using Git]] | ||
| + | * [[#Using Zip|Using Zip]] | ||
| + | |||
| + | == Using Git == | ||
| + | |||
| + | <ol> | ||
| + | <li>Go to your user folder: | ||
| + | <bash>mkdir -p $FOAM_RUN | ||
| + | cd $FOAM_RUN/..</bash> | ||
| + | </li> | ||
| + | |||
| + | <li>Clone the repository and go into the cloned repository: | ||
| + | <bash>git clone https://github.com/wyldckat/perturbU.git | ||
| + | cd perturbU</bash> | ||
| + | </li> | ||
| + | |||
| + | <li>Checkout the repository respective to the version of OpenFOAM you are using: | ||
| + | |||
| + | * OpenFOAM 2.3: | ||
| + | <bash>git checkout OF23x</bash> | ||
| + | |||
| + | * OpenFOAM 2.2: | ||
| + | <bash>git checkout OF22x</bash> | ||
| + | |||
| + | * OpenFOAM 2.1: | ||
| + | <bash>git checkout OF21x</bash> | ||
| + | |||
| + | * OpenFOAM 1.7 and older: | ||
| + | <bash>git checkout master</bash> | ||
| + | |||
| + | </li> | ||
| + | |||
| + | <li>Build {{tt|perturbU*}} utilities by running: | ||
| + | <bash>wmake all</bash> | ||
| + | </li> | ||
| + | </ol> | ||
| + | |||
| + | |||
| + | == Using Zip == | ||
| + | |||
| + | <ol> | ||
| + | <li>Go to your user folder: | ||
| + | <bash>mkdir -p $FOAM_RUN | ||
| + | cd $FOAM_RUN/..</bash> | ||
| + | </li> | ||
| + | |||
| + | <li>Get the Zip file for the repository respective to the version of OpenFOAM you are using: | ||
| + | |||
| + | * OpenFOAM 2.3: | ||
| + | <bash>wget https://github.com/wyldckat/perturbU/archive/OF23x.zip</bash> | ||
| + | |||
| + | * OpenFOAM 2.2: | ||
| + | <bash>wget https://github.com/wyldckat/perturbU/archive/OF22x.zip</bash> | ||
| + | |||
| + | * OpenFOAM 2.1: | ||
| + | <bash>wget https://github.com/wyldckat/perturbU/archive/OF21x.zip</bash> | ||
| + | |||
| + | * OpenFOAM 1.7 and older: | ||
| + | <bash>wget https://github.com/wyldckat/perturbU/archive/master.zip</bash> | ||
| + | |||
| + | </li> | ||
| + | |||
| + | <li>Unzip the respective file and go into the respective folder, for example: | ||
| + | <bash>unzip OF23x.zip | ||
| + | cd perturbU-OF23x | ||
| + | </bash> | ||
| + | </li> | ||
| + | |||
| + | <li>Build {{tt|perturbU*}} utilities by running: | ||
| + | <bash>wmake all</bash> | ||
| + | </li> | ||
| + | </ol> | ||
| + | |||
| + | |||
| + | = Usage = | ||
| + | '''TODO''' | ||
| + | |||
| + | |||
| + | == Threads on how to use <tt>perturbU</tt> == | ||
'''TODO''' | '''TODO''' | ||
Revision as of 17:56, 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.3:
git checkout OF23x
- OpenFOAM 2.2:
git checkout OF22x
- OpenFOAM 2.1:
git checkout OF21x
- 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.3:
wget https://github.com/wyldckat/perturbU/archive/OF23x.zip
- OpenFOAM 2.2:
wget https://github.com/wyldckat/perturbU/archive/OF22x.zip
- OpenFOAM 2.1:
wget https://github.com/wyldckat/perturbU/archive/OF21x.zip
- OpenFOAM 1.7 and older:
wget https://github.com/wyldckat/perturbU/archive/master.zip
- Unzip the respective file and go into the respective folder, for example:
unzip OF23x.zip cd perturbU-OF23x - Build perturbU* utilities by running:
wmake all
3 Usage
TODO
3.1 Threads on how to use perturbU
TODO
