1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.4.4-dev" />
7 <title>FreeFOAM README for Version
0.1.0</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.5em;
129 div
.content
{ /* Block element content. */
133 /* Block element titles. */
134 div
.title
, caption
.title
{
136 font-family: sans-serif
;
140 margin-bottom: 0.5em;
146 td div
.title:first-child
{
149 div
.content div
.title:first-child
{
152 div
.content
+ div
.title
{
156 div
.sidebarblock
> div
.content
{
158 border: 1px solid silver
;
162 div
.listingblock
> div
.content
{
163 border: 1px solid silver
;
172 div
.quoteblock
> div
.attribution
{
181 div
.verseblock
> div
.content
{
184 div
.verseblock
> div
.attribution
{
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div
.verseblock
+ div
.attribution
{
193 div
.admonitionblock
.icon
{
197 text-decoration: underline
;
199 padding-right: 0.5em;
201 div
.admonitionblock td
.content
{
203 border-left: 2px solid silver
;
206 div
.exampleblock
> div
.content
{
207 border-left: 2px solid silver
;
211 div
.imageblock div
.content
{ padding-left: 0; }
212 span
.image img
{ border-style: none
; }
213 a
.image:visited
{ color: white
; }
217 margin-bottom: 0.8em;
230 list-style-position: outside
;
233 list-style-type: decimal
;
236 list-style-type: lower-alpha
;
239 list-style-type: upper-alpha
;
242 list-style-type: lower-roman
;
245 list-style-type: upper-roman
;
248 div
.compact ul
, div
.compact ol
,
249 div
.compact p
, div
.compact p
,
250 div
.compact div
, div
.compact div
{
252 margin-bottom: 0.1em;
255 div
.tableblock
> table
{
256 border: 3px solid
#527bbd;
259 font-family: sans-serif
;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div
.tableblock
> table
[frame
="void"] {
275 div
.tableblock
> table
[frame
="hsides"] {
276 border-left-style: none
;
277 border-right-style: none
;
279 div
.tableblock
> table
[frame
="vsides"] {
280 border-top-style: none
;
281 border-bottom-style: none
;
287 margin-bottom: 0.8em;
290 padding-bottom: 15px;
292 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
298 padding-right: 0.8em;
304 div
.hdlist
.compact tr
{
314 div#footer-badges
{ display: none
; }
319 font-family: sans-serif
;
323 margin-bottom: 0.1em;
326 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
342 /* Workarounds for IE6's broken and incomplete CSS2. */
344 div
.sidebar-content
{
346 border: 1px solid silver
;
349 div
.sidebar-title
, div
.image-title
{
351 font-family: sans-serif
;
354 margin-bottom: 0.5em;
357 div
.listingblock div
.content
{
358 border: 1px solid silver
;
363 div
.quoteblock-attribution
{
368 div
.verseblock-content
{
371 div
.verseblock-attribution
{
376 div
.exampleblock-content
{
377 border-left: 2px solid silver
;
381 /* IE6 sets dynamically generated links as visited. */
382 div#toc
a:visited
{ color: blue
; }
384 <script type=
"text/javascript">
386 window
.onload = function(){generateToc(2)}
387 /* Author: Mihai Bazon, September 2002
388 * http://students.infoiasi.ro/~mishoo
390 * Table Of Content generator
393 * Feel free to use this script under the terms of the GNU General Public
394 * License, as long as you do not remove or alter this notice.
397 /* modified by Troy D. Hanson, September 2006. License: GPL */
398 /* modified by Stuart Rackham, October 2006. License: GPL */
400 function getText(el
) {
402 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
403 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
405 else if (i
.firstChild
!= null)
411 function TocEntry(el
, text
, toclevel
) {
414 this.toclevel
= toclevel
;
417 function tocEntries(el
, toclevels
) {
418 var result
= new Array
;
419 var re
= new RegExp('[hH]([2-'+(toclevels
+1)+'])');
420 // Function that scans the DOM tree for header elements (the DOM2
421 // nodeIterator API would be a better technique but not supported by all
423 var iterate = function (el
) {
424 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
425 if (i
.nodeType
== 1 /* Node.ELEMENT_NODE */) {
426 var mo
= re
.exec(i
.tagName
)
428 result
[result
.length
] = new TocEntry(i
, getText(i
), mo
[1]-1);
437 // This function does the work. toclevels = 1..4.
438 function generateToc(toclevels
) {
439 var toc
= document
.getElementById("toc");
440 var entries
= tocEntries(document
.getElementsByTagName("body")[0], toclevels
);
441 for (var i
= 0; i
< entries
.length
; ++i
) {
442 var entry
= entries
[i
];
443 if (entry
.element
.id
== "")
444 entry
.element
.id
= "toc" + i
;
445 var a
= document
.createElement("a");
446 a
.href
= "#" + entry
.element
.id
;
447 a
.appendChild(document
.createTextNode(entry
.text
));
448 var div
= document
.createElement("div");
450 div
.className
= "toclevel" + entry
.toclevel
;
451 toc
.appendChild(div
);
453 if (entries
.length
== 0)
454 document
.getElementById("header").removeChild(toc
);
461 <h1>FreeFOAM README for Version
0.1.0</h1>
462 <span id=
"author">Michael Wild
</span><br />
463 <span id=
"email"><tt><<a href=
"mailto:themiwi@users.sourceforge.net">themiwi@users.sourceforge.net
</a>></tt></span><br />
464 <span id=
"revnumber">version
0.1.0,
</span>
465 <span id=
"revdate">15 May
2009</span>
467 <div id=
"toctitle">Table of Contents
</div>
468 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.
</b></p></noscript>
472 <div class=
"sectionbody">
473 <div class=
"paragraph"><p><a href=
"http://freefoam.sourceforge.net">http://freefoam.sourceforge.net
</a></p></div>
476 <h2 id=
"_copyright">1. Copyright
</h2>
477 <div class=
"sectionbody">
478 <div class=
"paragraph"><p>FreeFOAM is free software; you can redistribute it and/or modify it under the
479 terms of the GNU General Public License as published by the Free Software
480 Foundation; either version
2 of the License, or (at your option) any later
481 version. See the file COPYING in this directory, for a description of the GNU
482 General Public License terms under which you can copy the files.
</p></div>
484 <h2 id=
"_system_requirements">2. System requirements
</h2>
485 <div class=
"sectionbody">
486 <div class=
"paragraph"><p>FreeFOAM is developed and tested on Linux, but should work with other Unix style
487 systems, notably Mac OS X
©. The support for Microsoft Windows is a goal,
488 which, however, is still far off.
</p></div>
489 <h3 id=
"_required_software_to_build_freefoam">2.1. Required software to build FreeFOAM
</h3><div style=
"clear:left"></div>
490 <div class=
"dlist"><dl>
492 <a id=
"cmake"></a>CMake
496 In order to build FreeFOAM you need to have CMake with version
2.6.2 or
497 newer installed.
<a href=
"http://cmake.org">http://cmake.org
</a>
501 <a id=
"build_system"></a>Build system
505 CMake requires a native build system. On Unix like platforms GNU Make is
506 recommended.
<a href=
"http://www.gnu.org/software/make">http://www.gnu.org/software/make
</a>
510 <a id=
"cxx_compiler"></a>C++ compiler
514 In order to build FreeFOAM you need a C++ compiler with good support for
515 template expressions. The g++ compiler from GCC-
4.3 and above will do
516 fine.
<a href=
"http://gcc.gnu.org">http://gcc.gnu.org
</a>
520 <a id=
"flex"></a>flex
524 The flex lexer generator. Version
2.5.33 is known to work. For more recent
525 versions there have been reports of problems.
<a href=
"http://flex.sourceforge.net">http://flex.sourceforge.net
</a>
529 <a id=
"zlib"></a>zlib
533 zlib compression library.
<a href=
"http://www.zlib.net">http://www.zlib.net
</a>
537 <a id=
"metis"></a>METIS
541 The METIS graph partitioning library, version
5.0pre2. If your package manager
542 doesn
’t contain it, you can also have FreeFOAM build it automatically for you
543 (see the
<a href=
"#installation">installation section
</a>).
544 <a href=
"http://glaros.dtc.umn.edu/gkhome/metis/metis/overview">http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
</a>
548 <h3 id=
"_optional_software">2.2. Optional software
</h3><div style=
"clear:left"></div>
549 <div class=
"dlist"><dl>
555 To check out a current development version of FreeFOAM, git is required.
556 <a href=
"http://git.or.cz">http://git.or.cz
</a>
560 <a id=
"parlib"></a>Parallel Communications Library
564 In order to run FreeFOAM in parallel, a communications library is required.
565 The following list gives an overview of the available options:
567 <div class=
"ulist"><ul>
570 MPI (
<em>Message Passing Interface
</em>): There are many implementations of the MPI
571 standard. The one that has been tested and is known to work with FreeFOAM
572 is
<a href=
"http://www.open-mpi.org">OpenMPI
</a>.
577 PVM (
<em>Parallel Virtual Machine
</em>) is available from
578 <a href=
"http://www.csm.ornl.gov/pvm">http://www.csm.ornl.gov/pvm
</a>.
583 GAMMA (
<em>Genoa Active Message MAchine
</em>) is available from
584 <a href=
"http://www.disi.unige.it/project/gamma">http://www.disi.unige.it/project/gamma
</a>.
590 <a id=
"parmetis"></a>ParMetis
594 If you use an MPI library, the ParMetis library is required. If your package
595 manager doesn
’t contain this library, FreeFOAM can build it automatically for
596 you (refer to the
<a href=
"#installation">installation notes
</a> below).
597 <a href=
"http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview">http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview
</a>
601 <a id=
"mgridgen"></a>MGRIDGEN
605 MGRIDGEN is a grid coarsening library for multi-grid
606 solvers. FreeFOAM can build this automatically for you. Please refer to the
607 <a href=
"INSTALL.html#enable-parmgridgen">INSTALL
</a> file for license restrictions.
608 <a href=
"http://glaros.dtc.umn.edu/gkhome/mgridgen/overview">http://glaros.dtc.umn.edu/gkhome/mgridgen/overview
</a>
612 <a id=
"libccmio"></a>libccmio
616 pro-STAR
© input/output library. FreeFOAM can build this automatically for
617 you. Please refer to the
<a href=
"INSTALL.html#enable-ccmio">INSTALL
</a> file for
618 license restrictions.
619 <a href=
"https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz">https://wci.llnl.gov/codes/visit/
3rd_party/libccmio-
2.6.1.tar.gz
</a>
623 <a id=
"paraview"></a>ParaView
627 If you want to build the
<a href=
"http://paraview.org">ParaView
</a> plug-ins, you need a
628 ParaView with the development headers
<strong>and
</strong> the corresponding CMake configuration
629 files (
<em>ParaViewConfig.cmake
</em>,
<em>ParaViewUse.cmake
</em>,
<em>ParaViewLibraryDepends*.cmake
</em>).
630 Most likely this means that you have to build ParaView yourself.
631 <a href=
"http://paraview.org">http://paraview.org
</a>
639 Some of the provided tutorial cases require the M4 macro processor.
640 <a href=
"http://www.gnu.org/software/m4/">http://www.gnu.org/software/m4/
</a>
644 <a id=
"doxygen"></a>Doxygen
648 Automatic API-documentation generator. Required to build the source
649 documentation.
<a href=
"http://www.doxygen.org">http://www.doxygen.org
</a>
654 <h2 id=
"_installation">3. Installation
</h2>
655 <div class=
"sectionbody">
656 <div class=
"paragraph"><p>For installation and basic usage instructions, refer to the
657 <a href=
"INSTALL.html">INSTALL
</a> file.
</p></div>
659 <h2 id=
"_documentation">4. Documentation
</h2>
660 <div class=
"sectionbody">
661 <div class=
"paragraph"><p><a href=
"http://freefoam.sourceforge.net/doc/Doxygen/html">http://freefoam.sourceforge.net/doc/Doxygen/html
</a></p></div>
663 <h2 id=
"_help">5. Help
</h2>
664 <div class=
"sectionbody">
665 <div class=
"ulist"><ul>
668 <a href=
"http://freefoam.sourceforge.net">http://freefoam.sourceforge.net
</a>
673 <a href=
"https://freefoam.wiki.sourceforge.net/MailingLists">https://freefoam.wiki.sourceforge.net/MailingLists
</a>
678 <a href=
"http://www.cfd-online.com/Forums/openfoam/">http://www.cfd-online.com/Forums/openfoam/
</a> <strong>please only ask questions related
679 to
<em>OpenFOAM
</em> there
</strong>.
684 <h2 id=
"_reporting_bugs_in_freefoam">6. Reporting Bugs in FreeFOAM
</h2>
685 <div class=
"sectionbody">
686 <div class=
"paragraph"><p><a href=
"https://sourceforge.net/tracker/?group_id=215833">https://sourceforge.net/tracker/?group_id=
215833</a></p></div>
689 <div id=
"footer-text">
691 Last updated
2009-
05-
25 08:
54:
01 CEST