Contrib/perturbU

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:

• Using Git
• Using Zip

2.1 Using Git

1. Go to your user folder:

   mkdir -p $FOAM_RUN
   cd $FOAM_RUN/..

2. Clone the repository and go into the cloned repository:

   git clone https://github.com/wyldckat/perturbU.git
   cd perturbU

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

4. Build perturbU* utilities by running:

   wmake all

2.2 Using Zip

1. Go to your user folder:

   mkdir -p $FOAM_RUN
   cd $FOAM_RUN/..

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

3. Unzip the respective file and go into the respective folder, for example:

   unzip OF23x.zip
   cd perturbU-OF23x

4. Build perturbU* utilities by running:

   wmake all

3 Usage

TODO

3.1 Threads on how to use perturbU

TODO