zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Corrected handling of '-'s.

Browse Source
This commit is contained in:
henry
2008-08-26 18:19:38 +01:00
parent 34ef7ea6da
commit 99917f38b5
4 changed files with 291 additions and 760 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README
View File

@ -2,9 +2,9 @@
# #
#+TITLE: *OpenFOAM README for version 1.5* #+TITLE: *OpenFOAM README for version 1.5*
#+AUTHOR: OpenCFD Ltd. #+AUTHOR: OpenCFD Ltd.
#+DATE: 14 July 2008 #+DATE: 26 August 2008
#+LINK: http://www.opencfd.co.uk #+LINK: http://www.opencfd.co.uk
#+OPTIONS: author:nil #+OPTIONS: author:nil ^:{}
* Copyright * Copyright
OpenFOAM is free software; you can redistribute it and/or modify it under the OpenFOAM is free software; you can redistribute it and/or modify it under the

482
README.html
View File

@ -1,42 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" OpenFOAM README for version 1.5
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 1 Copyright
lang="en" xml:lang="en">
<head> OpenFOAM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License
<title><b>OpenFOAM README for version 1.5</b></title> as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/> See the file COPYING in this directory, for a description of the GNU General Public License terms under which you can
<meta name="generator" content="Org-mode"/> copy the files.
<meta name="generated" content="14 July 2008"/>
<meta name="author" content="OpenCFD Ltd."/> 2 System requirements
<style type="text/css">
html { OpenFOAM is developed and tested on Linux, but should work with other Unix style systems. To check your system setup,
font-family: Times, serif; execute the foamSystemCheck script in the bin/ directory of the OpenFOAM installation. If no problems are reported,
font-size: 12pt; proceed to "3. Installation"; otherwise contact your system administrator.
}
.title { text-align: center; } If the user wishes to run OpenFOAM in 32/64-bit mode they should consult the section "Running OpenFOAM in 32-bit mode".
.todo { color: red; }
.done { color: green; } 2.1 Qt (from http://trolltech.com/products/qt)
.timestamp { color: grey }
.timestamp-kwd { color: CadetBlue } The ParaView 3.3 visualisation package requires that Qt version 4.3.x MUST be installed on the system. Earlier or more
.tag { background-color:lightblue; font-weight:normal } recent versions (4.2.x or 4.4.x) will NOT work. To check whether Qt4 is installed, and the version, type:
.target { }
pre { * qmake <div id="table-of-contents">
border: 1pt solid #AEBDCC;
background-color: #F3F5F7;
padding: 5pt;
font-family: courier, monospace;
font-size: 90%;
}
table { border-collapse: collapse; }
td, th {
vertical-align: top;
<!--border: 1pt solid #ADB9CC;-->
}
dt { font-weight: bold; }
</style>
</head><body>
<h1 class="title"><b>OpenFOAM README for version 1.5</b></h1>
<div id="table-of-contents">
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
@ -62,384 +46,152 @@ lang="en" xml:lang="en">
</ul> </ul>
</div> </div>
</div> </div>
–version
<div id="outline-container-1" class="outline-2"> The ParaView binary executables in the ThirdParty distribution will only work with PRECISELY the same version of Qt
<h2 id="sec-1">1 Copyright</h2> with which it was compiled. The 64-bit version of ParaView was compiled with Qt-4.3.1 (with openSuSE-10.3) and the
<div id="text-1"> 32-bit version of ParaView was compiled with Qt-4.3.2 (with ubuntu-7.10). If the user finds that a ParaView binary
fails to run, then it is almost certainly due to a conflict in compiled and installed Qt versions and they will need to
consult the section below on "Compiling ParaView and the PV3FoamReader module."
<p>OpenFOAM 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 2 of the License, or (at your option) any later
version. See the file COPYING in this directory, for a description of the GNU
General Public License terms under which you can copy the files.
</p>
</div>
</div>
<div id="outline-container-2" class="outline-2">
<h2 id="sec-2">2 System requirements</h2>
<div id="text-2">
<p>OpenFOAM is developed and tested on Linux, but should work with other Unix
style systems. To check your system setup, execute the foamSystemCheck script
in the bin/ directory of the OpenFOAM installation. If no problems are
reported, proceed to "3. Installation"; otherwise contact your system
administrator.
</p>
<p>
If the user wishes to run OpenFOAM in 32/64-bit mode they should consult the
section "Running OpenFOAM in 32-bit mode".
</p>
</div>
<div id="outline-container-2.1" class="outline-3">
<h3 id="sec-2.1">2.1 Qt (from <a href="http://trolltech.com/products/qt">http://trolltech.com/products/qt</a>)</h3>
<div id="text-2.1">
<p>The ParaView 3.3 visualisation package requires that Qt version 4.3.x MUST
be installed on the system. Earlier or more recent versions (4.2.x or
4.4.x) will NOT work. To check whether Qt4 is installed, and the version,
type:
</p><ul>
<li>
qmake &ndash;version
</li>
</ul>
<p>The ParaView binary executables in the ThirdParty distribution will only
work with PRECISELY the same version of Qt with which it was compiled. The
64-bit version of ParaView was compiled with Qt-4.3.1 (with openSuSE-10.3)
and the 32-bit version of ParaView was compiled with Qt-4.3.2 (with
ubuntu-7.10). If the user finds that a ParaView binary fails to run, then
it is almost certainly due to a conflict in compiled and installed Qt
versions and they will need to consult the section below on "Compiling
ParaView and the PV3FoamReader module."
</p>
<p>
The default versions of Qt used by some GNU/Linux releases are as follows. The default versions of Qt used by some GNU/Linux releases are as follows.
</p><ul>
<li>
ubuntu-7.10: Version 4.3.2
</li>
<li>
ubuntu-8.04: Version 4.3.4
</li>
<li>
openSuSE-10.2: Version 4.2.1 - too old
</li>
<li>
openSuSE-10.3: Version 4.3.1
</li>
<li>
openSuSE-11.0: Version 4.4.0 - too new
</li> * ubuntu-7.10: Version 4.3.2
</ul> * ubuntu-8.04: Version 4.3.4
* openSuSE-10.2: Version 4.2.1 - too old
* openSuSE-10.3: Version 4.3.1
* openSuSE-11.0: Version 4.4.0 - too new
<p>Compilation and running of ParaView has been successful using the libraries Compilation and running of ParaView has been successful using the libraries downloaded in the "libqt4-dev" package on
downloaded in the "libqt4-dev" package on ubuntu. ubuntu.
</p>
<p>
If you don't have an appropriate version of Qt installed you can download
the sources from TrollTech e.g.:
<a href="ftp://ftp.trolltech.com/qt/source/qt-x11-opensource-src-4.3.5.tar.bz2">ftp://ftp.trolltech.com/qt/source/qt-x11-opensource-src-4.3.5.tar.bz2</a>
and compile and install in /usr/local or some other location that does to
conflict with the pre-installed version.
</p>
</div>
</div>
</div> If you don't have an appropriate version of Qt installed you can download the sources from TrollTech e.g.: ftp://
ftp.trolltech.com/qt/source/qt-x11-opensource-src-4.3.5.tar.bz2 and compile and install in /usr/local or some other
location that does to conflict with the pre-installed version.
<div id="outline-container-3" class="outline-2"> 3 Installation
<h2 id="sec-3">3 Installation</h2>
<div id="text-3">
<p>Download and unpack the files in the $HOME/OpenFOAM directory as described in: Download and unpack the files in the $HOME/OpenFOAM directory as described in: http://www.OpenFOAM.org/download.html
<a href="http://www.OpenFOAM.org/download.html">http://www.OpenFOAM.org/download.html</a>
</p>
<p>
The environment variable settings are contained in files in an etc/ directory
in the OpenFOAM release. e.g. in
</p>
<ul>
<li>
$HOME/OpenFOAM/OpenFOAM-&lt;VERSION&gt;/etc/
</li>
<li>
where &lt;VERSION&gt; corresponds to the version 1.4, 1.5, &hellip;
</li> The environment variable settings are contained in files in an etc/ directory in the OpenFOAM release. e.g. in
<li>
EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), source the
etc/bashrc file by adding the following line to the end of your
$HOME/.bashrc file:
<ul> * $HOME/OpenFOAM/OpenFOAM-<VERSION>/etc/
<li> * where <VERSION> corresponds to the version 1.4, 1.5, …
. $HOME/OpenFOAM/OpenFOAM-&lt;VERSION&gt;/etc/bashrc
</li> * EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), source the etc/bashrc file by adding the following
</ul> line to the end of your $HOME/.bashrc file:
<p>Then update the environment variables by sourcing the $HOME/.bashrc file by + . $HOME/OpenFOAM/OpenFOAM-<VERSION>/etc/bashrc
typing in the terminal:
</p>
<ul>
<li>
. $HOME/.bashrc
</li> Then update the environment variables by sourcing the $HOME/.bashrc file by typing in the terminal:
</ul>
</li>
<li>
OR, if running tcsh or csh, source the etc/cshrc file by adding the
following line to the end of your $HOME/.cshrc file:
<ul> + . $HOME/.bashrc
<li>
source $HOME/OpenFOAM/OpenFOAM-&lt;VERSION&gt;/etc/cshrc
</li> * OR, if running tcsh or csh, source the etc/cshrc file by adding the following line to the end of your $HOME/.cshrc
</ul> file:
<p>Then update the environment variables by sourcing the $HOME/.cshrc file by + source $HOME/OpenFOAM/OpenFOAM-<VERSION>/etc/cshrc
typing in the terminal:
</p>
<ul>
<li>
source $HOME/.cshrc
</li> Then update the environment variables by sourcing the $HOME/.cshrc file by typing in the terminal:
</ul>
</li>
</ul>
</div> + source $HOME/.cshrc
<div id="outline-container-3.1" class="outline-3"> 3.1 Installation in alternative locations
<h3 id="sec-3.1">3.1 Installation in alternative locations</h3>
<div id="text-3.1">
<p>OpenFOAM may also be installed in alternative locations. However, the OpenFOAM may also be installed in alternative locations. However, the installation directory should be network
installation directory should be network available (e.g., NFS) if parallel available (e.g., NFS) if parallel calculations are planned.
calculations are planned.
</p>
<p>
The environment variable 'FOAM_INST_DIR' can be used to find and source the
appropriate resource file. Here is a bash/ksh/sh example:
</p>
<ul>
<li>
export FOAM_INST_DIR=/data/app/OpenFOAM
</li>
<li>
foamDotFile=$FOAM_INST_DIR/OpenFOAM-&lt;VERSION&gt;/etc/bashrc
</li>
<li>
[ -f $foamDotFile ] &amp;&amp; . $foamDotFile
</li> The environment variable 'FOAM_INST_DIR' can be used to find and source the appropriate resource file. Here is a bash/
</ul> ksh/sh example:
<p>and a csh/tcsh example: * export FOAM_INST_DIR=/data/app/OpenFOAM
</p> * foamDotFile=$FOAM_INST_DIR/OpenFOAM-<VERSION>/etc/bashrc
<ul> * [ -f $foamDotFile ] && . $foamDotFile
<li>
setenv FOAM_INST_DIR /data/app/OpenFOAM
</li>
<li>
foamDotFile=$FOAM_INST_DIR/OpenFOAM-&lt;VERSION&gt;/etc/bashrc
</li>
<li>
if ( -f $foamDotFile ) source $foamDotFile
</li> and a csh/tcsh example:
</ul>
<p>The value set in '$FOAM_INST_DIR' will be used to locate the remaining parts * setenv FOAM_INST_DIR /data/app/OpenFOAM
of the OpenFOAM installation. * foamDotFile=$FOAM_INST_DIR/OpenFOAM-<VERSION>/etc/bashrc
</p> * if ( -f $foamDotFile ) source $foamDotFile
</div>
</div>
</div> The value set in '$FOAM_INST_DIR' will be used to locate the remaining parts of the OpenFOAM installation.
<div id="outline-container-4" class="outline-2"> 4 Building from Sources (Optional)
<h2 id="sec-4">4 Building from Sources (Optional)</h2>
<div id="text-4">
<p>If you cannot find an appropriate binary pack for your platform, you can build If you cannot find an appropriate binary pack for your platform, you can build the complete OpenFOAM from the
the complete OpenFOAM from the source-pack. You will first need to compile or source-pack. You will first need to compile or obtain a recent version of gcc (we recomend gcc-4.3.?) for your
obtain a recent version of gcc (we recomend gcc-4.3.?) for your platform, platform, which may be obtained from http://gcc.gnu.org/.
which may be obtained from <a href="http://gcc.gnu.org/">http://gcc.gnu.org/</a>.
</p>
<p>
Install the compiler in
$WM_PROJECT_INST_DIR/ThirdParty/gcc-&lt;GCC_VERSION&gt;/platforms/$WM_ARCH$WM_COMPILER_ARCH/
and change the gcc version number in $WM_PROJECT_DIR/etc/settings.sh and
$WM_PROJECT_DIR/etc/settings.csh appropriately and finally update the
environment variables as in section 3.
</p>
<p>
Now go to the top-level source directory $WM_PROJECT_DIR and execute the
top-level build script './Allwmake'. In principle this will build everything,
but if problems occur with the build order it may be necessary to update the
environment variables and re-execute 'Allwmake'. If you experience
difficulties with building the source-pack, or your platform is not currently
supported, please contact &lt;enquiries@OpenCFD.co.uk&gt; to negotiate a support
contract and we will do the port and maintain it for future releases.
</p>
</div>
</div> Install the compiler in $WM_PROJECT_INST_DIR/ThirdParty/gcc-<GCC_VERSION>/platforms/$WM_ARCH$WM_COMPILER_ARCH/ and
change the gcc version number in $WM_PROJECT_DIR/etc/settings.sh and $WM_PROJECT_DIR/etc/settings.csh appropriately and
finally update the environment variables as in section 3.
<div id="outline-container-5" class="outline-2"> Now go to the top-level source directory $WM_PROJECT_DIR and execute the top-level build script './Allwmake'. In
<h2 id="sec-5">5 Testing the installation</h2> principle this will build everything, but if problems occur with the build order it may be necessary to update the
<div id="text-5"> environment variables and re-execute 'Allwmake'. If you experience difficulties with building the source-pack, or your
platform is not currently supported, please contact <enquiries@OpenCFD.co.uk> to negotiate a support contract and we
will do the port and maintain it for future releases.
<p>To check your installation setup, execute the 'foamInstallationTest' script 5 Testing the installation
(in the bin/ directory of the OpenFOAM installation). If no problems are
reported, proceed to getting started with OpenFOAM; otherwise, go back and
check you have installed the software correctly and/or contact your system
administrator.
</p>
</div>
</div> To check your installation setup, execute the 'foamInstallationTest' script (in the bin/ directory of the OpenFOAM
installation). If no problems are reported, proceed to getting started with OpenFOAM; otherwise, go back and check you
have installed the software correctly and/or contact your system administrator.
<div id="outline-container-6" class="outline-2"> 6 Getting Started
<h2 id="sec-6">6 Getting Started</h2>
<div id="text-6">
<p>Create a project directory within the $HOME/OpenFOAM directory named Create a project directory within the $HOME/OpenFOAM directory named <USER>-<VERSION> (e.g. 'chris-1.5' for user chris
&lt;USER&gt;-&lt;VERSION&gt; (e.g. 'chris-1.5' for user chris and OpenFOAM version 1.5) and OpenFOAM version 1.5) and create a directory named 'run' within it, e.g. by typing:
and create a directory named 'run' within it, e.g. by typing:
</p>
<ul>
<li>
mkdir -p $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
</li> * mkdir -p $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
</ul>
<p>Copy the 'tutorial' examples directory in the OpenFOAM distribution to the Copy the 'tutorial' examples directory in the OpenFOAM distribution to the 'run' directory. If the OpenFOAM environment
'run' directory. If the OpenFOAM environment variables are set correctly, variables are set correctly, then the following command will be correct:
then the following command will be correct:
</p>
<ul>
<li>
cp -r $WM_PROJECT_DIR/tutorials
$HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
</li> * cp -r $WM_PROJECT_DIR/tutorials $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
</ul>
<p>Run the first example case of incompressible laminar flow in a cavity: Run the first example case of incompressible laminar flow in a cavity:
</p>
<ul>
<li>
cd $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run/tutorials/icoFoam/cavity
</li>
<li>
blockMesh
</li>
<li>
icoFoam
</li>
<li>
paraFoam
</li> * cd $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run/tutorials/icoFoam/cavity
</ul> * blockMesh
</div> * icoFoam
* paraFoam
</div> 7 Compiling Paraview 3.3 and the PV3FoamReader module
<div id="outline-container-7" class="outline-2"> A version of Qt 4.3.x must be installed to compile ParaView. The compilation is a fairly simple process using the
<h2 id="sec-7">7 Compiling Paraview 3.3 and the PV3FoamReader module</h2> supplied buildParaView3.3-cvs script that has worked is our tests with other packages supplied in the ThirdParty
<div id="text-7">
<p>A version of Qt 4.3.x must be installed to compile ParaView. The compilation
is a fairly simple process using the supplied buildParaView3.3-cvs script that
has worked is our tests with other packages supplied in the ThirdParty
directory, namely cmake-2.4.6 and gcc-4.3.1. Execute the following: directory, namely cmake-2.4.6 and gcc-4.3.1. Execute the following:
</p><ul>
<li>
cd $FOAM_INST_DIR/ThirdParty
</li>
<li>
rm -rf ParaView3.3-cvs/platforms
</li>
<li>
buildParaView3.3-cvs
</li> * cd $FOAM_INST_DIR/ThirdParty
</ul> * rm -rf ParaView3.3-cvs/platforms
* buildParaView3.3-cvs
<p>The PV3FoamReader module is an OpenFOAM utility that can be compiled in the The PV3FoamReader module is an OpenFOAM utility that can be compiled in the usual manner as follows:
usual manner as follows:
</p><ul>
<li>
cd $FOAM_UTILITIES/postProcessing/graphics/PV3FoamReader
</li>
<li>
./Allwclean
</li>
<li>
./Allwmake
</li> * cd $FOAM_UTILITIES/postProcessing/graphics/PV3FoamReader
</ul> * ./Allwclean
</div> * ./Allwmake
</div> 8 Documentation
<div id="outline-container-8" class="outline-2"> http://www.OpenFOAM.org/doc
<h2 id="sec-8">8 Documentation</h2>
<div id="text-8">
<p><a href="http://www.OpenFOAM.org/doc">http://www.OpenFOAM.org/doc</a> 9 Help
</p>
</div>
</div> http://www.OpenFOAM.org http://www.OpenFOAM.org/discussion.html
<div id="outline-container-9" class="outline-2"> 10 Reporting Bugs in OpenFOAM
<h2 id="sec-9">9 Help</h2>
<div id="text-9">
<p><a href="http://www.OpenFOAM.org">http://www.OpenFOAM.org</a> <a href="http://www.OpenFOAM.org/discussion.html">http://www.OpenFOAM.org/discussion.html</a> http://www.OpenFOAM.org/bugs.html
</p>
</div>
</div> 11 Running OpenFOAM in 32-bit mode on 64-bit machines
<div id="outline-container-10" class="outline-2"> Linux users with a 64-bit machine may install either the OpenFOAM 32-bit version (linux) or the OpenFOAM 64-bit version
<h2 id="sec-10">10 Reporting Bugs in OpenFOAM</h2> (linux64), or both. The 64-bit is the default mode on a 64-bit machine. To use an installed 32-bit version, the user
<div id="text-10"> must set the environment variable WM_ARCH_OPTION to 32 before sourcing the etc/bashrc (or etc/cshrc) file.
<p><a href="http://www.OpenFOAM.org/bugs.html">http://www.OpenFOAM.org/bugs.html</a> Date: 26 August 2008
</p>
</div>
</div> HTML generated by org-mode 6.06b in emacs 23
<div id="outline-container-11" class="outline-2">
<h2 id="sec-11">11 Running OpenFOAM in 32-bit mode on 64-bit machines</h2>
<div id="text-11">
<p>Linux users with a 64-bit machine may install either the OpenFOAM 32-bit
version (linux) or the OpenFOAM 64-bit version (linux64), or both. The 64-bit
is the default mode on a 64-bit machine. To use an installed 32-bit version,
the user must set the environment variable $WM_32 (to anything, e.g. "on")
before sourcing the etc/bashrc (or etc/cshrc) file.
</p></div>
</div>
<div id="postamble"><p class="date"> Date: 14 July 2008</p>
<p>HTML generated by org-mode 6.05a in emacs 23<p>
</div></body>
</html>

4
ReleaseNotes-1.5
View File

@ -2,9 +2,9 @@
# #
#+TITLE: *OpenFOAM release notes for version 1.5* #+TITLE: *OpenFOAM release notes for version 1.5*
#+AUTHOR: OpenCFD Ltd. #+AUTHOR: OpenCFD Ltd.
#+DATE: 14 July 2008 #+DATE: 26 August 2008
#+LINK: http://www.opencfd.co.uk #+LINK: http://www.opencfd.co.uk
#+OPTIONS: author:nil #+OPTIONS: author:nil ^:{}
* Overview * Overview
OpenFOAM-1.5 is is a significant upgrade to version 1.4 in ways which are OpenFOAM-1.5 is is a significant upgrade to version 1.4 in ways which are

559
ReleaseNotes-1.5.html
View File

@ -1,42 +1,27 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" OpenFOAM release notes for version 1.5
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 1 Overview
lang="en" xml:lang="en">
<head> OpenFOAM-1.5 is is a significant upgrade to version 1.4 in ways which are
<title><b>OpenFOAM release notes for version 1.5</b></title> outlined below. This release passes all our standard tests and the tutorials
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/> have been broadly checked. If there are any bugs, please report them using the
<meta name="generator" content="Org-mode"/> instructions set out in: http://www.openfoam.org/bugs.html.
<meta name="generated" content="14 July 2008"/>
<meta name="author" content="OpenCFD Ltd."/> Most of the developments for this release are in: new applications, e.g. for
<style type="text/css"> multiphase flow and cavitation, buoyancy-flow and heat transfer, high speed
html { flows and even molecular dynamics; new utilities, e.g. for meshing and case
font-family: Times, serif; monitoring; and, new modelling, e.g. in Lagrangian particle tracking,
font-size: 12pt; radiation and rotating frames of reference. With these new applications come
} numerous new example cases.
.title { text-align: center; }
.todo { color: red; } 2 GNU/Linux version
.done { color: green; }
.timestamp { color: grey } The 64bit binary packs of the OpenFOAM release were compiled on a machine
.timestamp-kwd { color: CadetBlue } running SuSE GNU/Linux version 10.3 and the 32bit on a machine running Ubuntu
.tag { background-color:lightblue; font-weight:normal } GNU/Linux version 7.1 and also tested on Ubuntu 8.04. We recommend that users
.target { } run OpenFOAM on one of these or a similar recent version of GNU/Linux. This
pre { release has also been successfully compiled and tested on older GNU/Linux
border: 1pt solid #AEBDCC; releases but this re<div id="table-of-contents">
background-color: #F3F5F7;
padding: 5pt;
font-family: courier, monospace;
font-size: 90%;
}
table { border-collapse: collapse; }
td, th {
vertical-align: top;
<!--border: 1pt solid #ADB9CC;-->
}
dt { font-weight: bold; }
</style>
</head><body>
<h1 class="title"><b>OpenFOAM release notes for version 1.5</b></h1>
<div id="table-of-contents">
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
@ -54,376 +39,170 @@ lang="en" xml:lang="en">
</ul> </ul>
</div> </div>
</div> </div>
quires the installation of Qt 4.3.? for ParaView-3 to run.
<div id="outline-container-1" class="outline-2"> 3 C++ Compiler version
<h2 id="sec-1">1 Overview</h2>
<div id="text-1">
<p>OpenFOAM-1.5 is is a significant upgrade to version 1.4 in ways which are * Released compiled with GCC 4.3.1, the latest version.
outlined below. This release passes all our standard tests and the tutorials * Built in support for the Intel C++ 10.? compiler (untested).
have been broadly checked. If there are any bugs, please report them using * The choice of the compiler is controlled by the setting of the
the instructions set out in: <a href="http://www.openfoam.org/bugs.html">http://www.openfoam.org/bugs.html</a>. $WM_COMPILER and $WM_COMPILER_ARCH environment variables in the
</p> OpenFOAM-1.5/etc/bashrc (or cshrc) file.
<p> * The location of the installation of the compiler is controlled by the
Most of the developments for this release are in: new applications, e.g. for $WM_COMPILER_INST environment variable in the OpenFOAM-1.5/etc/settings.sh
multiphase flow and cavitation, buoyancy-flow and heat transfer, high speed (or settings.csh) file.
flows and even molecular dynamics; new utilities, e.g. for meshing and case
monitoring; and, new modelling, e.g. in Lagrangian particle tracking,
radiation and rotating frames of reference. With these new applications come
numerous new example cases.
</p>
</div>
</div> 4 Developments to solvers (applications)
<div id="outline-container-2" class="outline-2"> * New rhoCentralFoam solver for high-speed, viscous, compressible flows
<h2 id="sec-2">2 GNU/Linux version</h2> using non-oscillatory, central-upwind schemes.
<div id="text-2"> * New interDyMFoam solver for 2 incompressible, isothermal, immiscible
fluids using a VoF phase-fraction based interface capturing approach, with
optional mesh motion and mesh topology changes including adaptive mesh
(un)refinement. Useful for simulations such as tank filling, sloshing ---
using solid body motion e.g. SDA or SKA (6DoF) — and slamming (using the
mesh motion solver) and other large-scale applications that benefit from
the efficiency gain of adaptive mesh (un)refinement of the interface.
* New compressibleInterFoam solver for 2 compressible, isothermal,
immiscible fluids using a volume of fluid (VoF) phase-fraction approach
for interface-capturing. The momentum and other fluid properties are of
the "mixture" and a single momentum equation is solved. Turbulence is
modelled using a run-time selectable incompressible LES model.
* New interPhaseChangeFoam solver for 2 incompressible, isothermal,
immiscible fluids with phase-change, e.g. cavitation. Uses VoF interface
capturing, with momentum and other fluid properties described for the
``mixture'' and a single momentum equation is solved. The set of
phase-change models provided are designed to simulate cavitation but other
mechanisms of phase-change are supported within this solver framework.
* New rasCavitatingFoam solver for transient cavitation using a barotropic
compressibility model, with RAS turbulence.
* New lesCavitatingFoam solver for transient cavitation using a barotropic
compressibility model, with LES turbulence.
* New chtMultiRegionFoam solver that couples conjugate heat transfer in a
solid to a buoyancy-driven flow simulation.
* New PDRFoam solver for compressible premixed/partially-premixed turbulent
combustion that includes porosity/distributed resistance (PDR) modelling
to handle regions containing solid blockages which cannot be resolved by
the mesh. Requires the PDR fields.
* New lesBuoyantFoam solver for transient, buoyant, turbulent flow of
compressible fluids for ventilation and heat-transfer. Turbulence is
modelled using a run-time selectable compressible LES model.
* New rhoPimpleFoam solver for transient, turbulent flow of compressible
fluids for ventilation and heat-transfer. Uses the flexible PIMPLE
(PISO-SIMPLE) solution for time-resolved and pseudo-transient simulations.
* New buoyantSimpleRadiationFoam solver for steady-state, buoyant, turbulent
flow of compressible fluids with radiation, for ventilation and
heat-transfer.
* New rhoTurbTwinParcelFoam solver for transient for compressible, turbulent
flow with two thermo-clouds.
* New gnemdFOAM solver for general purpose molecular dynamics that simulates
atoms in arbitrary shaped domains and average atomic/molecular quantities
to the mesh to create field data.
* New mdEqulibrationFoam solver to equilibrates and/or preconditions
molecular dynamics systems.
* Demonstration SRFSimpleFoam solver based on simpleFoam that incorporates
the SRF extensions (see below) for rotating flows.
<p>The 64bit binary packs of the OpenFOAM release were compiled on a machine 5 Automatic mesher
running SuSE GNU/Linux version 10.3 and the 32bit on a machine running Ubuntu
GNU/Linux version 7.1 and also tested on Ubuntu 8.04. We recommend that
users run OpenFOAM on one of these or a similar recent version of GNU/Linux.
This release has also been successfully compiled and tested on older GNU/Linux
releases but this requires the installation of Qt 4.3.? for ParaView-3 to run.
</p>
</div>
</div> New snappyHexMesh utility that generates split-hex meshes automatically from
triangulated (STL) surface geometries. The mesh approximately conforms to the
surface by iteratively refining a starting mesh and morphing the resulting
split-hex mesh to the surface. An optional phase will shrink back the
resulting mesh and insert cell layers. It has a flexible specification of mesh
refinement level and robust surface handling with a pre-specified final mesh
quality. It runs in parallel with a load balancing step every iteration.
<div id="outline-container-3" class="outline-2"> 6 Developments to utilities
<h2 id="sec-3">3 C++ Compiler version</h2>
<div id="text-3">
<ul> * New extrude2DMesh utility that extrudes 2D meshes into a 3D mesh. 2D
<li> meshes are described by faces with 2 points, so can be used in combination
Released compiled with GCC 4.3.1, the latest version. with 2D meshes converted with ccm26ToFoam.
</li> * New couplePatches functionality integrated into createPatch, which
<li> optionally synchronises ("couples") points and faces of coupled (cyclic,
Built in support for the Intel C++ 10.? compiler (untested). processor) patches.
</li> * New applyBoundaryLayer pre-processing utility to apply 1/7th power-law
<li> boundary layers at walls, starting from uniform or potential flow
The choice of the compiler is controlled by the setting of the $WM_COMPILER solutions.
and $WM_COMPILER_ARCH environment variables in the OpenFOAM-1.5/etc/bashrc * New execFlowFunctionObjects utility executes functionObjects as a
(or cshrc) file. post-processing activity, e.g. probes, sampling, force calculation.
</li> * New changeDictionary utility makes batch changes to OpenFOAM input files,
<li> e.g. to change boundary conditions of field files.
The location of the installation of the compiler is controlled by the * New foamCalc utility, a generic post-processing field calculator tool
$WM_COMPILER_INST environment variable in the OpenFOAM-1.5/etc/settings.sh * New molConfig pre-processing utility for molecular dynamics cases. Fills
(or settings.csh) file. zones of a mesh with single crystal lattices of specified structure,
density, orientation, alignment and temperature.
* Extended splitMeshRegions utility to split multi-zone meshes, e.g. defined
through cellZones, into separate meshes.
* Extended the foamToVTK, decomposePar, reconstructPar and mapFields
utilities to include support for multiple particle clouds in parallel
processing.
</li> 7 Migration from ParaView 2.4 to ParaView 3.x
</ul>
</div>
</div> * Rewritten OpenFOAM Reader Module for version 3, a major redesign of
ParaView.
* New features include viewing patch names, reading of Lagrangian data,
handling of cell, face and point sets, multiple views.
<div id="outline-container-4" class="outline-2"> 8 Model development
<h2 id="sec-4">4 Developments to solvers (applications)</h2>
<div id="text-4">
<ul> * Overhauled the lagrangian library to support multiple clouds.
<li> * New lagrangianIntermediate library incorporating a hierarchy of parcel and
New rhoCentralFoam solver for high-speed, viscous, compressible flows using cloud types, accommodating kinematic, thermodynamic and reacting
non-oscillatory, central-upwind schemes. applications, including coupling to the new radiation library. Sub-models
</li> are added at the relevant level of physics, e.g.:
<li> + kinematic: injection, wall interaction, drag, dispersion;
New interDyMFoam solver for 2 incompressible, isothermal, immiscible fluids + thermo: heat transfer;
using a VoF phase-fraction based interface capturing approach, with optional + reacting: reacting composition, mass transfer, surface reactions.
mesh motion and mesh topology changes including adaptive mesh * New single rotating frame of reference (SRF) library for rotating flow
(un)refinement. Useful for simulations such as tank filling, sloshing --- applications, e.g. turbo-machinery.
using solid body motion e.g. SDA or SKA (6DoF) &mdash; and slamming (using the * New radiation library including the P1 model and associated Marshak
mesh motion solver) and other large-scale applications that benefit from the boundary conditions for incident radiation.
efficiency gain of adaptive mesh (un)refinement of the interface. * New displacementInterpolation motion solver for flexible mesh scaling.
</li> * New molecularDynamics Lagrangian library to calculate intermolecular
<li> forces between spherically symmetrical monatomic species in arbitrary
New compressibleInterFoam solver for 2 compressible, isothermal, immiscible geometries.
fluids using a volume of fluid (VoF) phase-fraction approach for
interface-capturing. The momentum and other fluid properties are of the
"mixture" and a single momentum equation is solved. Turbulence is modelled
using a run-time selectable incompressible LES model.
</li>
<li>
New interPhaseChangeFoam solver for 2 incompressible, isothermal, immiscible
fluids with phase-change, e.g. cavitation. Uses VoF interface capturing,
with momentum and other fluid properties described for the ``mixture'' and a
single momentum equation is solved. The set of phase-change models provided
are designed to simulate cavitation but other mechanisms of phase-change are
supported within this solver framework.
</li>
<li>
New rasCavitatingFoam solver for transient cavitation using a barotropic
compressibility model, with RAS turbulence.
</li>
<li>
New lesCavitatingFoam solver for transient cavitation using a barotropic
compressibility model, with LES turbulence.
</li>
<li>
New chtMultiRegionFoam solver that couples conjugate heat transfer in a
solid to a buoyancy-driven flow simulation.
</li>
<li>
New PDRFoam solver for compressible premixed/partially-premixed turbulent
combustion that includes porosity/distributed resistance (PDR) modelling to
handle regions containing solid blockages which cannot be resolved by the
mesh. Requires the PDR fields.
</li>
<li>
New lesBuoyantFoam solver for transient, buoyant, turbulent flow of
compressible fluids for ventilation and heat-transfer. Turbulence is
modelled using a run-time selectable compressible LES model.
</li>
<li>
New rhoPimpleFoam solver for transient, turbulent flow of compressible
fluids for ventilation and heat-transfer. Uses the flexible PIMPLE
(PISO-SIMPLE) solution for time-resolved and pseudo-transient simulations.
</li>
<li>
New buoyantSimpleRadiationFoam solver for steady-state, buoyant, turbulent
flow of compressible fluids with radiation, for ventilation and
heat-transfer.
</li>
<li>
New rhoTurbTwinParcelFoam solver for transient for compressible, turbulent
flow with two thermo-clouds.
</li>
<li>
New gnemdFOAM solver for general purpose molecular dynamics that simulates
atoms in arbitrary shaped domains and average atomic/molecular quantities to
the mesh to create field data.
</li>
<li>
New mdEqulibrationFoam solver to equilibrates and/or preconditions molecular
dynamics systems.
</li>
<li>
Demonstration SRFSimpleFoam solver based on simpleFoam that incorporates the
SRF extensions (see below) for rotating flows.
</li> 9 New functionObjects
</ul>
</div>
</div> To aid common monitoring and post-processing activities.
<div id="outline-container-5" class="outline-2"> * forces: calculate the force and moment on a patch or set of patches, e.g.
<h2 id="sec-5">5 Automatic mesher</h2> to calculate the lift, drag and moment of an object in the flow.
<div id="text-5"> * forceCoeffs: calculate the normalised force and moment on a patch or set
of patches, e.g. to calculate the lift, drag and moment coefficients of an
object in the flow.
* fieldAverage: calculate field arithmetic mean and prime-squared averages
for a list of fields.
* foamCalcFunctions: calculate field components, div, mag, magGrad or
magSqr.
<p>New snappyHexMesh utility that generates split-hex meshes automatically from 10 Improvements to boundary conditions
triangulated (STL) surface geometries. The mesh approximately conforms to
the surface by iteratively refining a starting mesh and morphing the
resulting split-hex mesh to the surface. An optional phase will shrink back
the resulting mesh and insert cell layers. It has a flexible specification
of mesh refinement level and robust surface handling with a pre-specified
final mesh quality. It runs in parallel with a load balancing step every
iteration.
</p>
</div>
</div> * Generalised jumpCyclic type: cyclic condition with an additional
prescribed jump in value.
* fan type: specialisation of jumpCyclic, applying a prescribed jump in
pressure to simulate a fan within a mesh.
* Generalised advective outflow boundary condition based on solving D/Dt
(psi, U) = 0 at the boundary.
* Additional turbulent flow inlet to specify mixing length and frequency.
* Generalisation of time varying set of boundary conditions.
<div id="outline-container-6" class="outline-2"> 11 Other
<h2 id="sec-6">6 Developments to utilities</h2>
<div id="text-6">
<ul> * New argument-free command execution, e.g typing "icoFoam" without root and
<li> case directory arguments.
New extrude2DMesh utility that extrudes 2D meshes into a 3D mesh. 2D meshes * Extended time command line options.
are described by faces with 2 points, so can be used in combination with 2D * Many enhancements to dictionary including macro substitution, optional
meshes converted with ccm26ToFoam. merging and default/overwrite behaviour, enhanced "#include" file handling
</li> and the framework to support function evaluation.
<li> * Cross-links between applications and Doxygen documentation with the "-doc"
New couplePatches functionality integrated into createPatch, which argument.
optionally synchronises ("couples") points and faces of coupled (cyclic, * Non-blocking, non-buffered, parallel transfers with potential scaling
processor) patches. benefits for larger number of processors.
</li>
<li>
New applyBoundaryLayer pre-processing utility to apply 1/7th power-law
boundary layers at walls, starting from uniform or potential flow solutions.
</li>
<li>
New execFlowFunctionObjects utility executes functionObjects as a
post-processing activity, e.g. probes, sampling, force calculation.
</li>
<li>
New changeDictionary utility makes batch changes to OpenFOAM input files,
e.g. to change boundary conditions of field files.
</li>
<li>
New foamCalc utility, a generic post-processing field calculator tool
</li>
<li>
New molConfig pre-processing utility for molecular dynamics cases. Fills
zones of a mesh with single crystal lattices of specified structure,
density, orientation, alignment and temperature.
</li>
<li>
Extended splitMeshRegions utility to split multi-zone meshes, e.g. defined
through cellZones, into separate meshes.
</li>
<li>
Extended the foamToVTK, decomposePar, reconstructPar and mapFields utilities
to include support for multiple particle clouds in parallel processing.
</li> Date: 26 August 2008
</ul>
</div>
</div> HTML generated by org-mode 6.06b in emacs 23
<div id="outline-container-7" class="outline-2">
<h2 id="sec-7">7 Migration from ParaView 2.4 to ParaView 3.x</h2>
<div id="text-7">
<ul>
<li>
Rewritten OpenFOAM Reader Module for version 3, a major redesign of
ParaView.
</li>
<li>
New features include viewing patch names, reading of Lagrangian data,
handling of cell, face and point sets, multiple views.
</li>
</ul>
</div>
</div>
<div id="outline-container-8" class="outline-2">
<h2 id="sec-8">8 Model development</h2>
<div id="text-8">
<ul>
<li>
Overhauled the lagrangian library to support multiple clouds.
</li>
<li>
New lagrangianIntermediate library incorporating a hierarchy of parcel and
cloud types, accommodating kinematic, thermodynamic and reacting
applications, including coupling to the new radiation library. Sub-models
are added at the relevant level of physics, e.g.:
<ul>
<li>
kinematic: injection, wall interaction, drag, dispersion;
</li>
<li>
thermo: heat transfer;
</li>
<li>
reacting: reacting composition, mass transfer, surface reactions.
</li>
</ul>
</li>
<li>
New single rotating frame of reference (SRF) library for rotating flow
applications, e.g. turbo-machinery.
</li>
<li>
New radiation library including the P1 model and associated Marshak boundary
conditions for incident radiation.
</li>
<li>
New displacementInterpolation motion solver for flexible mesh scaling.
</li>
<li>
New molecularDynamics Lagrangian library to calculate intermolecular forces
between spherically symmetrical monatomic species in arbitrary geometries.
</li>
</ul>
</div>
</div>
<div id="outline-container-9" class="outline-2">
<h2 id="sec-9">9 New functionObjects</h2>
<div id="text-9">
<p>To aid common monitoring and post-processing activities.
</p><ul>
<li>
forces: calculate the force and moment on a patch or set of patches, e.g. to
calculate the lift, drag and moment of an object in the flow.
</li>
<li>
forceCoeffs: calculate the normalised force and moment on a patch or set of
patches, e.g. to calculate the lift, drag and moment coefficients of an
object in the flow.
</li>
<li>
fieldAverage: calculate field arithmetic mean and prime-squared averages for
a list of fields.
</li>
<li>
foamCalcFunctions: calculate field components, div, mag, magGrad or magSqr.
</li>
</ul>
</div>
</div>
<div id="outline-container-10" class="outline-2">
<h2 id="sec-10">10 Improvements to boundary conditions</h2>
<div id="text-10">
<ul>
<li>
Generalised jumpCyclic type: cyclic condition with an additional prescribed
jump in value.
</li>
<li>
fan type: specialisation of jumpCyclic, applying a prescribed jump in
pressure to simulate a fan within a mesh.
</li>
<li>
Generalised advective outflow boundary condition based on solving D/Dt(psi,
U) = 0 at the boundary.
</li>
<li>
Additional turbulent flow inlet to specify mixing length and frequency.
</li>
<li>
Generalisation of time varying set of boundary conditions.
</li>
</ul>
</div>
</div>
<div id="outline-container-11" class="outline-2">
<h2 id="sec-11">11 Other</h2>
<div id="text-11">
<ul>
<li>
New argument-free command execution, e.g typing "icoFoam" without root and
case directory arguments.
</li>
<li>
Extended time command line options.
</li>
<li>
Many enhancements to dictionary including macro substitution, optional
merging and default/overwrite behaviour, enhanced "#include" file handling
and the framework to support function evaluation.
</li>
<li>
Cross-links between applications and Doxygen documentation with the "-doc"
argument.
</li>
<li>
Non-blocking, non-buffered, parallel transfers with potential scaling
benefits for larger number of processors.
</li>
</ul>
</div>
</div>
<div id="postamble"><p class="date"> Date: 14 July 2008</p>
<p>HTML generated by org-mode 6.05a in emacs 23<p>
</div></body>
</html>