89 lines
4.1 KiB
Text
89 lines
4.1 KiB
Text
#------------------------------------------------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | foam-extend: Open Source CFD
|
|
# \\ / O peration | Version: 3.2
|
|
# \\ / A nd | Web: http://www.foam-extend.org
|
|
# \\/ M anipulation | For copyright notice see file Copyright
|
|
#------------------------------------------------------------------------------
|
|
# License
|
|
# This file is part of foam-extend.
|
|
#
|
|
# foam-extend is free software: you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by the
|
|
# Free Software Foundation, either version 3 of the License, or (at your
|
|
# option) any later version.
|
|
#
|
|
# foam-extend is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with foam-extend. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# File
|
|
# READMEBinaryPackage.txt
|
|
#
|
|
# Description
|
|
# Installation and usage instructions for stand-alone Windows builds.
|
|
#
|
|
# Author:
|
|
# Cesare Guardino, Alstom Power Ltd., (2015)
|
|
#
|
|
#------------------------------------------------------------------------------
|
|
|
|
|
|
**********************************************************************************************
|
|
**********************************************************************************************
|
|
***** IMPORTANT: THIS IS VERSION IS NOT FULLY TESTED OR VALIDATED. PLEASE USE WITH CARE. *****
|
|
**********************************************************************************************
|
|
**********************************************************************************************
|
|
|
|
|
|
INSTRUCTIONS ON HOW TO INSTALL AND RUN THE WINDOWS VERSION OF FOAM-EXTEND
|
|
-------------------------------------------------------------------------
|
|
1) Unzip the package file to any suitable directory (with no whitespaces) on your computer.
|
|
|
|
2) Install OpenMPI if you do not already have it. You can download this from:
|
|
http://www.open-mpi.org/software/ompi/v1.6/downloads/OpenMPI_v1.6.1-1_win64.exe
|
|
It is strongly recommended to install this in a directory with no whitespaces.
|
|
Once installed, create a new environment variable called MPI_ROOTDIR to point to the
|
|
installation directory where you install OpenMPI.
|
|
|
|
3) If you wish to perform post-processing using ParaView and you do not already have it,
|
|
you can download ParaView from:
|
|
http://www.paraview.org/download
|
|
It is strongly recommended to install this in a directory with no whitespaces.
|
|
Once installed, create a new environment variable called PARAVIEW_HOME to point to the
|
|
installation directory where you install ParaView.
|
|
|
|
4) Start a new CMD (DOS) prompt, and run the following command:
|
|
call <PATH_TO_FOAM>\setWindowsEnvironment.bat
|
|
where <PATH_TO_FOAM> is the full path of the directory where you unzipped the package.
|
|
The foam environment is now configured correctly for use within this CMD prompt only.
|
|
|
|
Alternatively, create a desktop shortcut to <PATH_TO_FOAM>\foamWindowsShell.bat
|
|
When you double-click this shortcut, a new CMD prompt is open with the foam environment automatically set.
|
|
|
|
5) From the CMD prompts opened in the previous step, you can now run the usual foam applications, for example:
|
|
cd /d <PATH_TO_CASE>
|
|
blockMesh
|
|
sonicFoam
|
|
|
|
6) To run in parallel using using OpenMPI, run (for example):
|
|
cd /d <PATH_TO_CASE>
|
|
decomposePar
|
|
mpirun -np 4 sonicFoam.exe -parallel
|
|
|
|
7) To post-process the results using ParaView, just run "parafoam" in the case directory:
|
|
cd /d <PATH_TO_CASE>
|
|
parafoam
|
|
|
|
This will create a temporary .foam file in the case directory and automatically launch ParaView.
|
|
|
|
|
|
NOTES
|
|
-----
|
|
1) This version does not fully support runtime selection of extended features. If necessary, you can
|
|
explicitly load the required DLL using the "libs" function in system/controlDict, for example:
|
|
libs ("liblduSolvers.dll");
|