**********************************************************************
*  Prepared By:                                                      *
*  Ozden AKINCI                                                      *
*  E-mail: akinci@be.itu.edu.tr                                      *
*  Date: 11.11.2005                                                  *
*                                                                    *
*  ITU Informatics Institute                                         *
*  Computational Science & Engineering Dept.                         *
*  Istanbul / TURKIYE                                                *
*                                                                    *
**********************************************************************

**********************************************************************
**********************************************************************
                                                                     *
After calculation of a CASE in the specified tar file,               *
it is possible to create animations or graphics by using             *
paraFoam tool. It must be used at the user interface.                *
                                                                     *
**********************************************************************

**********************************************************************
A. Before use the tool the following steps must be done:             *
**********************************************************************
A.1- Source bashrc file of OpenFoam:                                 *
. /opt/OpenFOAM/OpenFOAM-1.2/.OpenFOAM-1.2/bashrc                    *
                                                                     *
A.2- Set the DISPLAY environment to get GUI:                         *
export DISPLAY=your_local_machine:0.0                                *
                                                                     *
A.3- Your localmachine must accept the GUI from userinterface (UI):  *
xhost + your_UI_machine                                              *
                                                                     *
**********************************************************************

**********************************************************************
B. Using paraFoam tool:                                              *
**********************************************************************
B.1- Untarring the output file (e.g. test01_out.tar):                *
tar xvf test01_out.tar                                               *
                                                                     *
B.2- Going to the ROOT directory (e.g. icoFoam) inside the directory * 
(e.g. test01):                                                       *
cd test01/icoFoam                                                    *
                                                                     *
B.3- There can be more than one CASE, but the calculation has just   *
been done for the CASE (e.g. cavity) defined inside the script (e.g. *
openFOAMserial.sh). Getting the visual results for calculated CASE   *
, typing the following command:                                      *
paraFoam . cavity                                                    *
or                                                                   *
paraFoam FULL_PATH_TO_ROOT cavity                                    *
                                                                     *
B.4- After a few seconds there will be GUI in your local machine     *
**********************************************************************


**********************************************************************
ERROR:                                                               *
     After running                                                   *
                                                                     *
     paraFoam ./test01/icoFoam/ cavity                               *
                                                                     *
     command paraFoam has opened. But after clicking the accept      *
     button on the GUI, the program ended wiht following error:      *
                                                                     *
/opt/OpenFOAM/OpenFOAM-1.2/bin/paraFoam: line 57: 12821 Segmentation *
fault      paraview paraFoam.pvs                                     *
                                                                     *
SOLUTION:                                                            *
     While using paraFoam tool, it is necessary to use full path for *
     ROOT directory such as                                          *
                                                                     *
     paraFoam FULL_PATH_TO_ROOT cavity                               *
                                                                     * 
     or to go to the ROOT directory                                  *
                                                                     *
     cd test01/icoFoam                                               *
                                                                     *
     and typing                                                      *
                                                                     *
     paraFoam . cavity                                               *
**********************************************************************
