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