README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2                "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"
   4 lang="en" xml:lang="en">
   5 <head>
   6 <title><b>OpenFOAM README for version 1.5</b></title>
   7 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
   8 <meta name="generator" content="Org-mode"/>
   9 <meta name="generated" content="19 August 2008"/>
  10 <meta name="author" content="Hrvoje Jasak"/>
  11 <style type="text/css">
  12   html {
  13         font-family: Times, serif;
  14         font-size: 12pt;
  15   }
  16   .title { text-align: center; }
  17   .todo  { color: red; }
  18   .done { color: green; }
  19   .timestamp { color: grey }
  20   .timestamp-kwd { color: CadetBlue }
  21   .tag { background-color:lightblue; font-weight:normal }
  22   .target { }
  23   pre {
  24         border: 1pt solid #AEBDCC;
  25         background-color: #F3F5F7;
  26         padding: 5pt;
  27         font-family: courier, monospace;
  28   }
  29   table { border-collapse: collapse; }
  30   td, th {
  31         vertical-align: top;
  32         <!--border: 1pt solid #ADB9CC;-->
  33   }
  34 </style>
  35 </head><body>
  36 <h1 class="title"><b>OpenFOAM README for version 1.5</b></h1>
  37 <div id="table-of-contents">
  38 <h2>Table of Contents</h2>
  39 <div id="text-table-of-contents">
  40 <ul>
  41 <li><a href="#sec-1">1 Copyright</a></li>
  42 <li><a href="#sec-2">2 System requirements</a>
  43 <ul>
  44 <li><a href="#sec-2.1">2.1 Qt (from http://trolltech.com/products/qt)</a></li>
  45 </ul>
  46 </li>
  47 <li><a href="#sec-3">3 Installation</a>
  48 <ul>
  49 <li><a href="#sec-3.1">3.1 Installation in alternative locations</a></li>
  50 </ul>
  51 </li>
  52 <li><a href="#sec-4">4 Building from Sources (Optional)</a></li>
  53 <li><a href="#sec-5">5 Testing the installation</a></li>
  54 <li><a href="#sec-6">6 Getting Started</a></li>
  55 <li><a href="#sec-7">7 Compiling Paraview 3.3 and the PV3FoamReader module</a></li>
  56 <li><a href="#sec-8">8 Documentation</a></li>
  57 <li><a href="#sec-9">9 Help</a></li>
  58 <li><a href="#sec-10">10 Reporting Bugs in OpenFOAM</a></li>
  59 <li><a href="#sec-11">11 Running OpenFOAM in 32-bit mode on 64-bit machines</a></li>
  60 </ul>
  61 </div>
  62 </div>
  63
  64 <div id="outline-container-1" class="outline-2">
  65 <h2 id="sec-1">1 Copyright</h2>
  66 <div id="text-1">
  67
  68 <p>OpenFOAM is free software; you can redistribute it and/or modify it under the
  69 terms of the GNU General Public License as published by the Free Software
  70 Foundation; either version 2 of the License, or (at your option) any later
  71 version.  See the file COPYING in this directory, for a description of the GNU
  72 General Public License terms under which you can copy the files.
  73 </p>
  74 </div>
  75
  76 </div>
  77
  78 <div id="outline-container-2" class="outline-2">
  79 <h2 id="sec-2">2 System requirements</h2>
  80 <div id="text-2">
  81
  82 <p>OpenFOAM is developed and tested on Linux, but should work with other Unix
  83 style systems.  To check your system setup, execute the foamSystemCheck script
  84 in the bin/ directory of the OpenFOAM installation. If no problems are
  85 reported, proceed to "3. Installation"; otherwise contact your system
  86 administrator.
  87 </p>
  88 <p>
  89 If the user wishes to run OpenFOAM in 32/64-bit mode they should consult the
  90 section "Running OpenFOAM in 32-bit mode".
  91 </p>
  92
  93 </div>
  94
  95 <div id="outline-container-2.1" class="outline-3">
  96 <h3 id="sec-2.1">2.1 Qt (from <a href="http://trolltech.com/products/qt">http://trolltech.com/products/qt</a>)</h3>
  97 <div id="text-2.1">
  98
  99 <p>The ParaView 3.3 visualisation package requires that Qt version 4.3.x MUST
 100 be installed on the system.  Earlier or more recent versions (4.2.x or
 101 4.4.x) will NOT work.  To check whether Qt4 is installed, and the version,
 102 type:
 103 </p><ul>
 104 <li>
 105 qmake --version
 106
 107 </li>
 108 </ul>
 109 <p>The ParaView binary executables in the ThirdParty distribution will only
 110 work with PRECISELY the same version of Qt with which it was compiled.  The
 111 64-bit version of ParaView was compiled with Qt-4.3.1 (with openSuSE-10.3)
 112 and the 32-bit version of ParaView was compiled with Qt-4.3.2 (with
 113 ubuntu-7.10).  If the user finds that a ParaView binary fails to run, then
 114 it is almost certainly due to a conflict in compiled and installed Qt
 115 versions and they will need to consult the section below on "Compiling
 116 ParaView and the PV3FoamReader module."
 117 </p>
 118 <p>
 119 The default versions of Qt used by some GNU/Linux releases are as follows.
 120 </p><ul>
 121 <li>
 122 ubuntu-7.10:   Version 4.3.2
 123 </li>
 124 <li>
 125 ubuntu-8.04:   Version 4.3.4
 126 </li>
 127 <li>
 128 openSuSE-10.2: Version 4.2.1 - too old
 129 </li>
 130 <li>
 131 openSuSE-10.3: Version 4.3.1
 132 </li>
 133 <li>
 134 openSuSE-11.0: Version 4.4.0 - too new
 135
 136 </li>
 137 </ul>
 138 <p>For openSuSE 10.2, 10.3 and 11.0, Qt version 4.3.5 can be downloaded from:
 139 <a href="http://download.opensuse.org/repositories/KDE:/Qt43">http://download.opensuse.org/repositories/KDE:/Qt43</a>
 140 </p>
 141 <p>
 142 Compilation and running of ParaView has been successful using the libraries
 143 downloaded in the "libqt4-dev" package on ubuntu.
 144 </p>
 145 </div>
 146 </div>
 147
 148 </div>
 149
 150 <div id="outline-container-3" class="outline-2">
 151 <h2 id="sec-3">3 Installation</h2>
 152 <div id="text-3">
 153
 154 <p>Download and unpack the files in the $HOME/OpenFOAM directory as described in:
 155 <a href="http://www.OpenFOAM.org/download.html">http://www.OpenFOAM.org/download.html</a>
 156 </p>
 157 <p>
 158 The environment variable settings are contained in files in an etc/ directory
 159 in the OpenFOAM release. e.g. in
 160 </p>
 161 <ul>
 162 <li>
 163 $HOME/OpenFOAM/OpenFOAM-&lt;VERSION&gt;/etc/
 164 </li>
 165 <li>
 166 where &lt;VERSION&gt; corresponds to the version 1.4, 1.5, &hellip;
 167
 168 </li>
 169 <li>
 170 EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), source the
 171 etc/bashrc file by adding the following line to the end of your
 172 $HOME/.bashrc file:
 173
 174 <ul>
 175 <li>
 176 . $HOME/OpenFOAM/OpenFOAM-&lt;VERSION&gt;/etc/bashrc
 177
 178 </li>
 179 </ul>
 180 <p>Then update the environment variables by sourcing the $HOME/.bashrc file by
 181 typing in the terminal:
 182 </p>
 183 <ul>
 184 <li>
 185 . $HOME/.bashrc
 186
 187 </li>
 188 </ul></li>
 189 <li>
 190 OR, if running tcsh or csh, source the etc/cshrc file by adding the
 191 following line to the end of your $HOME/.cshrc file:
 192
 193 <ul>
 194 <li>
 195 source $HOME/OpenFOAM/OpenFOAM-&lt;VERSION&gt;/etc/cshrc
 196
 197 </li>
 198 </ul>
 199 <p>Then update the environment variables by sourcing the $HOME/.cshrc file by
 200 typing in the terminal:
 201 </p>
 202 <ul>
 203 <li>
 204 source $HOME/.cshrc
 205
 206 </li>
 207 </ul></li>
 208 </ul>
 209 </div>
 210
 211 <div id="outline-container-3.1" class="outline-3">
 212 <h3 id="sec-3.1">3.1 Installation in alternative locations</h3>
 213 <div id="text-3.1">
 214
 215 <p>OpenFOAM may also be installed in alternative locations. However, the
 216 installation directory should be network available (e.g., NFS) if parallel
 217 calculations are planned.
 218 </p>
 219 <p>
 220 The environment variable 'FOAM_INST_DIR' can be used to find and source the
 221 appropriate resource file. Here is a bash/ksh/sh example:
 222 </p>
 223 <ul>
 224 <li>
 225 export FOAM_INST_DIR=/data/app/OpenFOAM
 226 </li>
 227 <li>
 228 foamDotFile=$FOAM_INST_DIR/OpenFOAM-&lt;VERSION&gt;/etc/bashrc
 229 </li>
 230 <li>
 231 [ -f $foamDotFile ] &amp;&amp; . $foamDotFile
 232
 233 </li>
 234 </ul>
 235 <p>and a csh/tcsh example:
 236 </p>
 237 <ul>
 238 <li>
 239 setenv FOAM_INST_DIR /data/app/OpenFOAM
 240 </li>
 241 <li>
 242 foamDotFile=$FOAM_INST_DIR/OpenFOAM-&lt;VERSION&gt;/etc/bashrc
 243 </li>
 244 <li>
 245 if ( -f $foamDotFile ) source $foamDotFile
 246
 247 </li>
 248 </ul>
 249 <p>The value set in '$FOAM_INST_DIR' will be used to locate the remaining parts
 250 of the OpenFOAM installation.
 251 </p>
 252 </div>
 253 </div>
 254
 255 </div>
 256
 257 <div id="outline-container-4" class="outline-2">
 258 <h2 id="sec-4">4 Building from Sources (Optional)</h2>
 259 <div id="text-4">
 260
 261 <p>If you cannot find an appropriate binary pack for your platform, you can build
 262 the complete OpenFOAM from the source-pack.  You will first need to compile or
 263 obtain a recent version of gcc (we recomend gcc-4.3.?) for your platform,
 264 which may be obtained from <a href="http://gcc.gnu.org/">http://gcc.gnu.org/</a>.
 265 </p>
 266 <p>
 267 Install the compiler in
 268 $WM_PROJECT_INST_DIR/ThirdParty/gcc-&lt;GCC_VERSION&gt;/platforms/$WM_ARCH$WM_COMPILER_ARCH/
 269 and change the gcc version number in $WM_PROJECT_DIR/etc/settings.sh and
 270 $WM_PROJECT_DIR/etc/settings.csh appropriately and finally update the
 271 environment variables as in section 3.
 272 </p>
 273 <p>
 274 Now go to the top-level source directory $WM_PROJECT_DIR and execute the
 275 top-level build script './Allwmake'.  In principle this will build everything,
 276 but if problems occur with the build order it may be necessary to update the
 277 environment variables and re-execute 'Allwmake'. If you experience
 278 difficulties with building the source-pack, or your platform is not currently
 279 supported, please contact &lt;enquiries@wikki.co.uk&gt; to negotiate a support
 280 contract and we will do the port and maintain it for future releases.
 281 </p>
 282 </div>
 283
 284 </div>
 285
 286 <div id="outline-container-5" class="outline-2">
 287 <h2 id="sec-5">5 Testing the installation</h2>
 288 <div id="text-5">
 289
 290 <p>To check your installation setup, execute the 'foamInstallationTest' script
 291 (in the bin/ directory of the OpenFOAM installation). If no problems are
 292 reported, proceed to getting started with OpenFOAM; otherwise, go back and
 293 check you have installed the software correctly and/or contact your system
 294 administrator.
 295 </p>
 296 </div>
 297
 298 </div>
 299
 300 <div id="outline-container-6" class="outline-2">
 301 <h2 id="sec-6">6 Getting Started</h2>
 302 <div id="text-6">
 303
 304 <p>Create a project directory within the $HOME/OpenFOAM directory named
 305 &lt;USER&gt;-&lt;VERSION&gt; (e.g. 'chris-1.5' for user chris and OpenFOAM version 1.5)
 306 and create a directory named 'run' within it, e.g. by typing:
 307 </p>
 308 <ul>
 309 <li>
 310 mkdir -p $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
 311
 312 </li>
 313 </ul>
 314 <p>Copy the 'tutorial' examples directory in the OpenFOAM distribution to the
 315 'run' directory.  If the OpenFOAM environment variables are set correctly,
 316 then the following command will be correct:
 317 </p>
 318 <ul>
 319 <li>
 320 cp -r $WM_PROJECT_DIR/tutorials
 321 $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run
 322
 323 </li>
 324 </ul>
 325 <p>Run the first example case of incompressible laminar flow in a cavity:
 326 </p>
 327 <ul>
 328 <li>
 329 cd $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run/tutorials/icoFoam/cavity
 330 </li>
 331 <li>
 332 blockMesh
 333 </li>
 334 <li>
 335 icoFoam
 336 </li>
 337 <li>
 338 paraFoam
 339
 340 </li>
 341 </ul></div>
 342
 343 </div>
 344
 345 <div id="outline-container-7" class="outline-2">
 346 <h2 id="sec-7">7 Compiling Paraview 3.3 and the PV3FoamReader module</h2>
 347 <div id="text-7">
 348
 349 <p>A version of Qt 4.3.x must be installed to compile ParaView.  The compilation
 350 is a fairly simple process using the supplied buildParaView3.3-cvs script that
 351 has worked is our tests with other packages supplied in the ThirdParty
 352 directory, namely cmake-2.4.6 and gcc-4.3.1.  Execute the following:
 353 </p><ul>
 354 <li>
 355 cd $FOAM_INST_DIR/ThirdParty
 356 </li>
 357 <li>
 358 rm -rf ParaView3.3-cvs/platforms
 359 </li>
 360 <li>
 361 buildParaView3.3-cvs
 362
 363 </li>
 364 </ul>
 365 <p>The PV3FoamReader module is an OpenFOAM utility that can be compiled in the
 366 usual manner as follows:
 367 </p><ul>
 368 <li>
 369 cd $FOAM_UTILITIES/postProcessing/graphics/PV3FoamReader
 370 </li>
 371 <li>
 372 ./Allwclean
 373 </li>
 374 <li>
 375 ./Allwmake
 376
 377 </li>
 378 </ul></div>
 379
 380 </div>
 381
 382 <div id="outline-container-8" class="outline-2">
 383 <h2 id="sec-8">8 Documentation</h2>
 384 <div id="text-8">
 385
 386 <p><a href="http://www.OpenFOAM.org/doc">http://www.OpenFOAM.org/doc</a>
 387 </p>
 388 </div>
 389
 390 </div>
 391
 392 <div id="outline-container-9" class="outline-2">
 393 <h2 id="sec-9">9 Help</h2>
 394 <div id="text-9">
 395
 396 <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>
 397 </p>
 398 </div>
 399
 400 </div>
 401
 402 <div id="outline-container-10" class="outline-2">
 403 <h2 id="sec-10">10 Reporting Bugs in OpenFOAM</h2>
 404 <div id="text-10">
 405
 406 <p><a href="http://www.OpenFOAM.org/bugs.html">http://www.OpenFOAM.org/bugs.html</a>
 407 </p></div>
 408
 409 </div>
 410
 411 <div id="outline-container-11" class="outline-2">
 412 <h2 id="sec-11">11 Running OpenFOAM in 32-bit mode on 64-bit machines</h2>
 413 <div id="text-11">
 414
 415 <p>Linux users with a 64-bit machine may install either the OpenFOAM 32-bit
 416 version (linux) or the OpenFOAM 64-bit version (linux64), or both.  The 64-bit
 417 is the default mode on a 64-bit machine.  To use an installed 32-bit version,
 418 the user must set the environment variable $WM_32 (to anything, e.g. "on")
 419 before sourcing the etc/bashrc (or etc/cshrc) file.
 420 </p>
 421 </div>
 422 </div>
 423 <div id="postamble"><p class="date"> Date: 14 July 2008</p>
 424 </div></body>
 425 </html>