README.html

   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">
   4 <head>
   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.0rc4</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Workarounds for IE6's broken and incomplete CSS2. */
 343
 344 div.sidebar-content {
 345   background: #ffffee;
 346   border: 1px solid silver;
 347   padding: 0.5em;
 348 }
 349 div.sidebar-title, div.image-title {
 350   color: #527bbd;
 351   font-family: sans-serif;
 352   font-weight: bold;
 353   margin-top: 0.0em;
 354   margin-bottom: 0.5em;
 355 }
 356
 357 div.listingblock div.content {
 358   border: 1px solid silver;
 359   background: #f4f4f4;
 360   padding: 0.5em;
 361 }
 362
 363 div.quoteblock-attribution {
 364   padding-top: 0.5em;
 365   text-align: right;
 366 }
 367
 368 div.verseblock-content {
 369   white-space: pre;
 370 }
 371 div.verseblock-attribution {
 372   padding-top: 0.75em;
 373   text-align: left;
 374 }
 375
 376 div.exampleblock-content {
 377   border-left: 2px solid silver;
 378   padding-left: 0.5em;
 379 }
 380
 381 /* IE6 sets dynamically generated links as visited. */
 382 div#toc a:visited { color: blue; }
 383 </style>
 384 <script type="text/javascript">
 385 /*<![CDATA[*/
 386 window.onload = function(){generateToc(2)}
 387 /* Author: Mihai Bazon, September 2002
 388  * http://students.infoiasi.ro/~mishoo
 389  *
 390  * Table Of Content generator
 391  * Version: 0.4
 392  *
 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.
 395  */
 396
 397  /* modified by Troy D. Hanson, September 2006. License: GPL */
 398  /* modified by Stuart Rackham, October 2006. License: GPL */
 399
 400 function getText(el) {
 401   var text = "";
 402   for (var i = el.firstChild; i != null; i = i.nextSibling) {
 403     if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 404       text += i.data;
 405     else if (i.firstChild != null)
 406       text += getText(i);
 407   }
 408   return text;
 409 }
 410
 411 function TocEntry(el, text, toclevel) {
 412   this.element = el;
 413   this.text = text;
 414   this.toclevel = toclevel;
 415 }
 416
 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
 422   // browsers).
 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)
 427         if (mo)
 428           result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 429         iterate(i);
 430       }
 431     }
 432   }
 433   iterate(el);
 434   return result;
 435 }
 436
 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");
 449     div.appendChild(a);
 450     div.className = "toclevel" + entry.toclevel;
 451     toc.appendChild(div);
 452   }
 453   if (entries.length == 0)
 454     document.getElementById("header").removeChild(toc);
 455 }
 456 /*]]>*/
 457 </script>
 458 </head>
 459 <body>
 460 <div id="header">
 461 <h1>FreeFOAM README for Version 0.1.0rc4</h1>
 462 <span id="author">Michael Wild</span><br />
 463 <span id="email"><tt>&lt;<a href="mailto:themiwi@users.sourceforge.net">themiwi@users.sourceforge.net</a>&gt;</tt></span><br />
 464 <span id="revnumber">version 0.1.0rc4,</span>
 465 <span id="revdate">2009-06-29</span>
 466 <div id="toc">
 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>
 469 </div>
 470 </div>
 471 <div id="preamble">
 472 <div class="sectionbody">
 473 <div class="paragraph"><p><a href="http://freefoam.sourceforge.net">http://freefoam.sourceforge.net</a></p></div>
 474 </div>
 475 </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>
 483 </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 &#169;. 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>
 491 <dt class="hdlist1">
 492 <a id="cmake"></a>CMake
 493 </dt>
 494 <dd>
 495 <p>
 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>
 498 </p>
 499 </dd>
 500 <dt class="hdlist1">
 501 <a id="build_system"></a>Build system
 502 </dt>
 503 <dd>
 504 <p>
 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>
 507 </p>
 508 </dd>
 509 <dt class="hdlist1">
 510 <a id="cxx_compiler"></a>C++ compiler
 511 </dt>
 512 <dd>
 513 <p>
 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>
 517 </p>
 518 </dd>
 519 <dt class="hdlist1">
 520 <a id="flex"></a>flex
 521 </dt>
 522 <dd>
 523 <p>
 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>
 526 </p>
 527 </dd>
 528 <dt class="hdlist1">
 529 <a id="zlib"></a>zlib
 530 </dt>
 531 <dd>
 532 <p>
 533   zlib compression library. <a href="http://www.zlib.net">http://www.zlib.net</a>
 534 </p>
 535 </dd>
 536 <dt class="hdlist1">
 537 <a id="metis"></a>METIS
 538 </dt>
 539 <dd>
 540 <p>
 541   The METIS graph partitioning library, version 5.0pre2. If your package manager
 542   doesn&#8217;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>
 545 </p>
 546 </dd>
 547 </dl></div>
 548 <h3 id="_optional_software">2.2. Optional software</h3><div style="clear:left"></div>
 549 <div class="dlist"><dl>
 550 <dt class="hdlist1">
 551 <a id="git"></a>git
 552 </dt>
 553 <dd>
 554 <p>
 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>
 557 </p>
 558 </dd>
 559 <dt class="hdlist1">
 560 <a id="parlib"></a>Parallel Communications Library
 561 </dt>
 562 <dd>
 563 <p>
 564   In order to run FreeFOAM in parallel, a communications library is required.
 565   The following list gives an overview of the available options:
 566 </p>
 567 <div class="ulist"><ul>
 568 <li>
 569 <p>
 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>.
 573 </p>
 574 </li>
 575 <li>
 576 <p>
 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>.
 579 </p>
 580 </li>
 581 <li>
 582 <p>
 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>.
 585 </p>
 586 </li>
 587 </ul></div>
 588 </dd>
 589 <dt class="hdlist1">
 590 <a id="parmetis"></a>ParMetis
 591 </dt>
 592 <dd>
 593 <p>
 594   If you use an MPI library, the ParMetis library is required. If your package
 595   manager doesn&#8217;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>
 598 </p>
 599 </dd>
 600 <dt class="hdlist1">
 601 <a id="mgridgen"></a>MGRIDGEN
 602 </dt>
 603 <dd>
 604 <p>
 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>
 609 </p>
 610 </dd>
 611 <dt class="hdlist1">
 612 <a id="libccmio"></a>libccmio
 613 </dt>
 614 <dd>
 615 <p>
 616   pro-STAR &#169; 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>
 620 </p>
 621 </dd>
 622 <dt class="hdlist1">
 623 <a id="paraview"></a>ParaView
 624 </dt>
 625 <dd>
 626 <p>
 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>
 632 </p>
 633 </dd>
 634 <dt class="hdlist1">
 635 <a id="m4"></a>M4
 636 </dt>
 637 <dd>
 638 <p>
 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>
 641 </p>
 642 </dd>
 643 <dt class="hdlist1">
 644 <a id="doxygen"></a>Doxygen
 645 </dt>
 646 <dd>
 647 <p>
 648   Automatic API-documentation generator. Required to build the source
 649   documentation. <a href="http://www.doxygen.org">http://www.doxygen.org</a>
 650 </p>
 651 </dd>
 652 </dl></div>
 653 </div>
 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>
 658 </div>
 659 <h2 id="_documentation">4. Documentation</h2>
 660 <div class="sectionbody">
 661 <div class="paragraph"><p>All the applications and the frequently used script utilities come with a brief
 662 man-page. Unfortunately, most of them are little more than stubs and need more
 663 work. The man-pages <em>freefoam(7)</em> gives a short overview over all applications
 664 and utilities, and <em>freefoam-config(7)</em> documents the FreeFOAM configuration
 665 options.</p></div>
 666 <div class="paragraph"><p>API-documentation is available from
 667 <a href="http://freefoam.sourceforge.net/doc/Doxygen/html">http://freefoam.sourceforge.net/doc/Doxygen/html</a></p></div>
 668 <div class="paragraph"><p>Further, most FreeFOAM applications and utilities support the <em>-doc</em> and
 669 <em>-srcDoc</em> options, which will automatically display the API-documentation and
 670 the source code of the application, respectively.</p></div>
 671 </div>
 672 <h2 id="_help">5. Help</h2>
 673 <div class="sectionbody">
 674 <div class="ulist"><ul>
 675 <li>
 676 <p>
 677 <a href="http://freefoam.sourceforge.net">http://freefoam.sourceforge.net</a>
 678 </p>
 679 </li>
 680 <li>
 681 <p>
 682 <a href="https://freefoam.wiki.sourceforge.net/MailingLists">https://freefoam.wiki.sourceforge.net/MailingLists</a>
 683 </p>
 684 </li>
 685 <li>
 686 <p>
 687 <a href="http://www.cfd-online.com/Forums/openfoam/">http://www.cfd-online.com/Forums/openfoam/</a> <strong>please only ask questions related
 688   to <em>OpenFOAM</em> there</strong>.
 689 </p>
 690 </li>
 691 </ul></div>
 692 </div>
 693 <h2 id="_reporting_bugs_in_freefoam">6. Reporting Bugs in FreeFOAM</h2>
 694 <div class="sectionbody">
 695 <div class="paragraph"><p><a href="https://sourceforge.net/tracker/?group_id=215833">https://sourceforge.net/tracker/?group_id=215833</a></p></div>
 696 </div>
 697 <div id="footer">
 698 <div id="footer-text">
 699 Version 0.1.0rc4<br />
 700 Last updated 2009-06-29 14:26:47 CEST
 701 </div>
 702 </div>
 703 </body>
 704 </html>