ReleaseNotes.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
   5 <head>
   6 <title><b>Release notes for foam-extend-3.2</b></title>
   7 <!-- 2015-09-11 Fri 18:01 -->
   8 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
   9 <meta  name="generator" content="Org-mode" />
  10 <style type="text/css">
  11  <!--/*--><![CDATA[/*><!--*/
  12   .title  { text-align: center; }
  13   .todo   { font-family: monospace; color: red; }
  14   .done   { color: green; }
  15   .tag    { background-color: #eee; font-family: monospace;
  16             padding: 2px; font-size: 80%; font-weight: normal; }
  17   .timestamp { color: #bebebe; }
  18   .timestamp-kwd { color: #5f9ea0; }
  19   .right  { margin-left: auto; margin-right: 0px;  text-align: right; }
  20   .left   { margin-left: 0px;  margin-right: auto; text-align: left; }
  21   .center { margin-left: auto; margin-right: auto; text-align: center; }
  22   .underline { text-decoration: underline; }
  23   #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  24   p.verse { margin-left: 3%; }
  25   pre {
  26     border: 1px solid #ccc;
  27     box-shadow: 3px 3px 3px #eee;
  28     padding: 8pt;
  29     font-family: monospace;
  30     overflow: auto;
  31     margin: 1.2em;
  32   }
  33   pre.src {
  34     position: relative;
  35     overflow: visible;
  36     padding-top: 1.2em;
  37   }
  38   pre.src:before {
  39     display: none;
  40     position: absolute;
  41     background-color: white;
  42     top: -10px;
  43     right: 10px;
  44     padding: 3px;
  45     border: 1px solid black;
  46   }
  47   pre.src:hover:before { display: inline;}
  48   pre.src-sh:before    { content: 'sh'; }
  49   pre.src-bash:before  { content: 'sh'; }
  50   pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  51   pre.src-R:before     { content: 'R'; }
  52   pre.src-perl:before  { content: 'Perl'; }
  53   pre.src-java:before  { content: 'Java'; }
  54   pre.src-sql:before   { content: 'SQL'; }
  55
  56   table { border-collapse:collapse; }
  57   td, th { vertical-align:top;  }
  58   th.right  { text-align: center;  }
  59   th.left   { text-align: center;   }
  60   th.center { text-align: center; }
  61   td.right  { text-align: right;  }
  62   td.left   { text-align: left;   }
  63   td.center { text-align: center; }
  64   dt { font-weight: bold; }
  65   .footpara:nth-child(2) { display: inline; }
  66   .footpara { display: block; }
  67   .footdef  { margin-bottom: 1em; }
  68   .figure { padding: 1em; }
  69   .figure p { text-align: center; }
  70   .inlinetask {
  71     padding: 10px;
  72     border: 2px solid gray;
  73     margin: 10px;
  74     background: #ffffcc;
  75   }
  76   #org-div-home-and-up
  77    { text-align: right; font-size: 70%; white-space: nowrap; }
  78   textarea { overflow-x: auto; }
  79   .linenr { font-size: smaller }
  80   .code-highlighted { background-color: #ffff00; }
  81   .org-info-js_info-navigation { border-style: none; }
  82   #org-info-js_console-label
  83     { font-size: 10px; font-weight: bold; white-space: nowrap; }
  84   .org-info-js_search-highlight
  85     { background-color: #ffff00; color: #000000; font-weight: bold; }
  86   /*]]>*/-->
  87 </style>
  88 <script type="text/javascript">
  89 /*
  90 @licstart  The following is the entire license notice for the
  91 JavaScript code in this tag.
  92
  93 Copyright (C) 2012-2013 Free Software Foundation, Inc.
  94
  95 The JavaScript code in this tag is free software: you can
  96 redistribute it and/or modify it under the terms of the GNU
  97 General Public License (GNU GPL) as published by the Free Software
  98 Foundation, either version 3 of the License, or (at your option)
  99 any later version.  The code is distributed WITHOUT ANY WARRANTY;
 100 without even the implied warranty of MERCHANTABILITY or FITNESS
 101 FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
 102
 103 As additional permission under GNU GPL version 3 section 7, you
 104 may distribute non-source (e.g., minimized or compacted) forms of
 105 that code without the copy of the GNU GPL normally required by
 106 section 4, provided you include this license notice and a URL
 107 through which recipients can access the Corresponding Source.
 108
 109
 110 @licend  The above is the entire license notice
 111 for the JavaScript code in this tag.
 112 */
 113 <!--/*--><![CDATA[/*><!--*/
 114  function CodeHighlightOn(elem, id)
 115  {
 116    var target = document.getElementById(id);
 117    if(null != target) {
 118      elem.cacheClassElem = elem.className;
 119      elem.cacheClassTarget = target.className;
 120      target.className = "code-highlighted";
 121      elem.className   = "code-highlighted";
 122    }
 123  }
 124  function CodeHighlightOff(elem, id)
 125  {
 126    var target = document.getElementById(id);
 127    if(elem.cacheClassElem)
 128      elem.className = elem.cacheClassElem;
 129    if(elem.cacheClassTarget)
 130      target.className = elem.cacheClassTarget;
 131  }
 132 /*]]>*///-->
 133 </script>
 134 </head>
 135 <body>
 136 <div id="content">
 137 <h1 class="title"><b>Release notes for foam-extend-3.2</b></h1>
 138 <div id="table-of-contents">
 139 <h2>Table of Contents</h2>
 140 <div id="text-table-of-contents">
 141 <ul>
 142 <li><a href="#sec-1">1. Overview</a></li>
 143 <li><a href="#sec-2">2. Installation</a></li>
 144 <li><a href="#sec-3">3. Compatibility</a></li>
 145 <li><a href="#sec-4">4. Main differentiators between foam-extend and OpenFOAM</a></li>
 146 <li><a href="#sec-5">5. New features in foam-extend-3.2, since foam-extend-3.1</a></li>
 147 <li><a href="#sec-6">6. Recent successful compilations and tests</a></li>
 148 <li><a href="#sec-7">7. Reporting bugs</a></li>
 149 <li><a href="#sec-8">8. How to contribute</a></li>
 150 <li><a href="#sec-9">9. List of Contributors:</a></li>
 151 </ul>
 152 </div>
 153 </div>
 154 <p>
 155 ###############################################################################
 156 </p>
 157
 158 <div id="outline-container-sec-1" class="outline-2">
 159 <h2 id="sec-1"><span class="section-number-2">1</span> Overview</h2>
 160 <div class="outline-text-2" id="text-1">
 161 <p>
 162 The foam-extend project is a fork of the OpenFOAM® open source
 163 library for Computational Fluid Dynamics (CFD). It is an open
 164 project welcoming and integrating contributions from all users and
 165 developers. Previously known as OpenFOAM-dev and OpenFOAM-extend,
 166 it contains bug fixes and performance improvements, as well as
 167 extensions and additional features provided by community
 168 contributors (see file ListOfContributors), such as dynamic mesh and
 169 topological change support, turbomachinery extensions including
 170 general grid interpolation (GGI), cyclic GGI and mixing plane,
 171 block-coupled matrix support, implicitly coupled conjugate heat
 172 transfer and other physics coupling, finite area method,
 173 comprehensive dynamic mesh (motion and topological changes)
 174 capability and GPU support. For a full list, see below and previous
 175 release notes at:
 176 <a href="http://sourceforge.net/p/openfoam-extend/wiki/Home/">http://sourceforge.net/p/openfoam-extend/wiki/Home/</a>
 177 </p>
 178
 179 <p>
 180 Version 3.2, nicknamed "Ann Arbor", is the current version of
 181 foam-extend. The release continues the tradition and spirit of the
 182 original FOAM code developed by prof. Jasak and Mr. Weller during
 183 their time at Imperial College and released as the general purpose
 184 CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted
 185 18 December 2013 to the original numbering scheme (foam-2.3.2, 13
 186 December 2004) as release number 3.0.  Visit <a href="http://foam-extend.org">http://foam-extend.org</a>
 187 for more information.
 188 </p>
 189
 190 <p>
 191 OPENFOAM is a registered trademark of ESI Group. OpenFOAM-extend and
 192 foam-extend are a community effort not endorsed by ESI Group.
 193 </p>
 194 </div>
 195 </div>
 196
 197 <div id="outline-container-sec-2" class="outline-2">
 198 <h2 id="sec-2"><span class="section-number-2">2</span> Installation</h2>
 199 <div class="outline-text-2" id="text-2">
 200 <p>
 201 foam-extend-3.2 can be compiled and runs on a large variety of Linux, Mac or Windows
 202 systems
 203 </p>
 204
 205 <ul class="org-ul">
 206 <li>Main supported OSs:
 207 <ul class="org-ul">
 208 <li>Ubuntu 14.04
 209 </li>
 210 <li>Fedora 20
 211 </li>
 212 <li>Mac OS X
 213 </li>
 214 <li>Microsoft Windows 7 and 8.1
 215 </li>
 216 </ul>
 217 </li>
 218
 219 <li>Compile from source:
 220
 221 <p>
 222 Please refer to doc/buildInstructions/ for details. Further
 223 installation instruction are available on the unofficial OpenFOAM
 224 Wiki:
 225 <a href="http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.1">http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.1</a>
 226 If you have improvements or build instructions for a new system,
 227 please share them with the community (see section "How to
 228 contribute", below).
 229 </p>
 230 </li>
 231
 232 <li>Download binary packages:
 233
 234 <p>
 235 Binary packages are available for download at
 236 <a href="http://sourceforge.net/projects/openfoam-extend/">http://sourceforge.net/projects/openfoam-extend/</a> for the following
 237 systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
 238 </p>
 239 </li>
 240
 241 <li>Accompanying ThirdParty software:
 242 <ul class="org-ul">
 243 <li>gcc compatibility up to 4.9.2
 244 </li>
 245 <li>bison 2.7
 246 </li>
 247 <li>cmake 3.2.2
 248 </li>
 249 <li>flex-2.5.35
 250 </li>
 251 <li>hwloc 1.10.1
 252 </li>
 253 <li>libccmio 2.6.1
 254 </li>
 255 <li>mesquite 2.1.2
 256 </li>
 257 <li>metis 5.1.0
 258 </li>
 259 <li>openmpi 1.6.5
 260 </li>
 261 <li>Paraview 4.3.1
 262 </li>
 263 <li>parmetis 4.0.3
 264 </li>
 265 <li>ParMGridGen 1.0
 266 </li>
 267 <li>PyFoam 0.6.4
 268 </li>
 269 <li>qt 4.8.6
 270 </li>
 271 <li>scotch 6.0.4
 272 </li>
 273 <li>swak4Foam 0.3.2
 274 </li>
 275 </ul>
 276 </li>
 277 </ul>
 278 </div>
 279 </div>
 280
 281 <div id="outline-container-sec-3" class="outline-2">
 282 <h2 id="sec-3"><span class="section-number-2">3</span> Compatibility</h2>
 283 <div class="outline-text-2" id="text-3">
 284 <p>
 285 Upstream features from the OpenFOAM® code base are merged into
 286 foam-extend on regular basis. The interface format of
 287 foam-extend-3.2 is largely compatible to foam-extend-3.1, to
 288 OpenFOAM-1.6-ext and OpenFOAM-1.7.x. In some cases, the
 289 differences are caused by bug fixes and algorithmic improvements,
 290 considered more important than inter-operability.
 291 </p>
 292 </div>
 293 </div>
 294 <div id="outline-container-sec-4" class="outline-2">
 295 <h2 id="sec-4"><span class="section-number-2">4</span> Main differentiators between foam-extend and OpenFOAM</h2>
 296 <div class="outline-text-2" id="text-4">
 297 <p>
 298 A large number of features have been lost within the release of
 299 OpenFOAM since version 1.3, the code base has shrunk by more than
 300 40%.  While we understand the lack of technical ability of
 301 supporting advanced CFD features, we feel that existing features and
 302 specifically large-scale contributions should remain active and
 303 developed further. Below is a list of main features of foam-extend
 304 which are lacking, lost, deactivated or unusable in ESI releases:
 305 </p>
 306
 307 <ul class="org-ul">
 308 <li>Turbomachinery features, including General Grid Interface (GGI),
 309 partial overlap GGI, cyclic GGI, with improvements in parallel
 310 scaling.  First release of a mixing plane stage interface
 311 </li>
 312
 313 <li>Dynamic mesh with topological changes Sliding interfaces, mesh
 314 layering, attach-detach boundaries etc.  In foam-extend, full
 315 parallel support for topological changes is released for the first
 316 time
 317 </li>
 318
 319 <li>Finite Element Method with support for polyhedral meshes This is
 320 mainly used in mesh deformation and over the last 15 years it has
 321 proven vastly superior to all other dynamic mesh methods.
 322 </li>
 323
 324 <li>Advanced mesh deformation technology Including tet FEM mesh
 325 deformation, Radial Basis Function (RBF) mesh deformation,
 326 tetrahedral remeshing dynamic mesh support and solid body motion
 327 functions.  All of the above include parallelisation support
 328 </li>
 329
 330 <li>Library of dynamic meshes with topological changes with full
 331 second order FVM discretisation support on moving meshes with
 332 topological changes
 333 </li>
 334
 335 <li>Internal combustion engine-specific dynamic mesh classes such as
 336 two-stroke engine and various forms of 4-stroke and multi-valve
 337 dynamic mesh classes
 338 </li>
 339
 340 <li>Finite Area Method providing support for FVM-like discretisation
 341 on a curved surface in 3-D, with examples of liquid film modeling
 342 </li>
 343
 344 <li>Block-coupled matrix support, allowing fully implicit
 345 multi-equation solution of NxN equation sets, with full
 346 parallelisation support.  First release of a block-AMG linear
 347 equation solver
 348 </li>
 349
 350 <li>Fully implicit conjugate-coupled solution framework, allowing
 351 implicit solution fo multiple equations over multiple meshes, with
 352 parallelism
 353 </li>
 354
 355 <li>Proper Orthogonal Decomposition data analysis tools, with
 356 applications to FOAM field classes
 357 </li>
 358
 359 <li>Equation reader classes and tutorials
 360 </li>
 361
 362 <li>Multi-solver solution framework, allowing multiple field models to
 363 be solved in a coupled manner
 364 </li>
 365
 366 <li>A major contribution is solid mechanics modelling, including
 367 linear and non-linear materials, contact, self-contact and
 368 friction, with updated Lagrangian or absolute Lagrangian
 369 formulation.  Solution of damage models and crack propagation in
 370 complex materials via topological changes
 371 </li>
 372
 373 <li>CUDA solver release, provided in full source and as an example of
 374 coupling external linear equation solvers with FOAM
 375 </li>
 376
 377 <li>Library-level support for Immersed Boundary Method and Overset
 378 Mesh
 379 </li>
 380
 381 <li>Major improvements in accuracy and stability of FVM discretisation
 382 with options on convection and diffusion discretisation, deferred
 383 correction or explicit schemes
 384 </li>
 385
 386 <li>Algebraic multigrid solver framework
 387 </li>
 388
 389 <li>243 tutorials with automated run scripts
 390 </li>
 391
 392 <li>Automatic test harness
 393 </li>
 394
 395 <li>Approximately 6000 bug fixes in fundamental level libraries and
 396 discretisation techniques
 397 </li>
 398 </ul>
 399 </div>
 400 </div>
 401 <div id="outline-container-sec-5" class="outline-2">
 402 <h2 id="sec-5"><span class="section-number-2">5</span> New features in foam-extend-3.2, since foam-extend-3.1</h2>
 403 <div class="outline-text-2" id="text-5">
 404 <p>
 405 The list of features is a result of the work of numerous
 406 contributors. The maintainers of foam-extend would formally like to
 407 thank them all.
 408 </p>
 409
 410 <p>
 411 Get a full log of the updates by (either):
 412 </p>
 413 <div class="org-src-container">
 414
 415 <pre class="src src-bash">user@machine&gt; git log 3.1.. &gt; commitLog
 416 </pre>
 417 </div>
 418 <div class="org-src-container">
 419
 420 <pre class="src src-bash">user@machine&gt; git log 3.1.. --oneline &gt; commitLog
 421 </pre>
 422 </div>
 423 <div class="org-src-container">
 424
 425 <pre class="src src-bash">user@machine&gt; gitg 3.1..
 426 </pre>
 427 </div>
 428
 429 <ul class="org-ul">
 430 <li>Major new features:
 431 <ul class="org-ul">
 432 <li>Immersed Boundary method: full release
 433 </li>
 434 <li>Liquid film method, based on finite area infrastructure
 435 </li>
 436 <li>Global controlDict switches controlled from command line
 437 </li>
 438 <li>Integration of cfMesh automatic mesh solvers
 439 </li>
 440 <li>Update to block coupled solvers: Performance, Coupled RAS, MRF
 441 </li>
 442 <li>Rewrite of block-coupled matrix assembly and analysis tools
 443 </li>
 444 <li>New solver: potentialDyMFoam
 445 </li>
 446 <li>Rothalpy in compressible MRF solvers for turbomachinery
 447 </li>
 448 <li>Symmetry 2nd order accurate boundary condition
 449 </li>
 450 <li>Generation of config files (e.g. csh, tcsh, fishshell, zsh) from bashrc
 451 </li>
 452 <li>Overhaul of fvDOM radiation model: symmetry plane and fast convergence
 453 </li>
 454 <li>New compilers: GCC new versions, Icc 14 and Icc 16, Clang
 455 </li>
 456 <li>Long long support
 457 </li>
 458 <li>Long double support
 459 </li>
 460 <li>SuperBee01 and SuperBee01DC
 461 </li>
 462 <li>wallShearStress also for compressible flow (backport)
 463 </li>
 464 <li>Version updates of 3rd Party, PyFOAM, swak4Foam
 465 </li>
 466 <li>Extend-bazaar: Added makeAxialMesh
 467 </li>
 468 <li>Added limiters on turbulence viscosity
 469 </li>
 470 <li>Initial version of block-coupled turbulence models
 471 </li>
 472 <li>New ThirdParty app: ParaView server for parallel rendering
 473 </li>
 474 </ul>
 475 </li>
 476
 477 <li>Licence: GPLv3
 478 </li>
 479
 480 <li>Software
 481 <ul class="org-ul">
 482 <li>File name changes resolving name clashes on non-case-sensitive filing
 483 systems
 484 </li>
 485 <li>Unified code base for Windows, Mac OS X and Linux compilation
 486 </li>
 487 <li>Parallel execution of automated test loops
 488 </li>
 489 </ul>
 490 </li>
 491
 492 <li>Installation:
 493 <ul class="org-ul">
 494 <li>Native port to Microsoft Windows 7 and 8.1
 495 </li>
 496 <li>Updated and bug-fixed installation procedures
 497 </li>
 498 <li>Improved ThirdParty packages selection mechanism
 499 </li>
 500 </ul>
 501 </li>
 502
 503 <li>Solvers:
 504 <ul class="org-ul">
 505 <li>potentialDyMFoam
 506 </li>
 507 <li>sonicDyMFoam
 508 </li>
 509 <li>sonicFoamAutoMotion
 510 </li>
 511 <li>MRFPorousFoam
 512 </li>
 513 <li>liquidFilmFoam
 514 </li>
 515 <li>surfactantFoam
 516 </li>
 517 <li>icoIbFoam
 518 </li>
 519 <li>interIbFoam
 520 </li>
 521 <li>porousSimpleIbFoam
 522 </li>
 523 <li>potentialIbFoam
 524 </li>
 525 <li>simpleIbFoam
 526 </li>
 527 </ul>
 528 </li>
 529
 530 <li>New tutorials:
 531 <ul class="org-ul">
 532 <li>Mesquite mesh movement
 533 </li>
 534 <li>Immersed boundary method
 535 </li>
 536 <li>Liquid film examples
 537 </li>
 538 </ul>
 539 </li>
 540
 541 <li>Bug fixes: see git log for details
 542 </li>
 543 </ul>
 544 </div>
 545 </div>
 546 <div id="outline-container-sec-6" class="outline-2">
 547 <h2 id="sec-6"><span class="section-number-2">6</span> Recent successful compilations and tests</h2>
 548 <div class="outline-text-2" id="text-6">
 549 <ul class="org-ul">
 550 <li>CentOS 6.6:
 551
 552 <p>
 553 <a href="http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=49">http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=49</a>
 554 <a href="http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=48">http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=48</a>
 555 </p>
 556 </li>
 557
 558 <li>Ubuntu 14.04
 559
 560 <p>
 561 <a href="http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=47">http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=47</a>
 562 </p>
 563 </li>
 564
 565 <li>Mac OS X 10.10
 566
 567 <p>
 568 <a href="http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=46">http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=46</a>
 569 </p>
 570 </li>
 571 </ul>
 572 </div>
 573 </div>
 574 <div id="outline-container-sec-7" class="outline-2">
 575 <h2 id="sec-7"><span class="section-number-2">7</span> Reporting bugs</h2>
 576 <div class="outline-text-2" id="text-7">
 577 <p>
 578 To report bugs, please use the bugtracker at
 579 <a href="http://sourceforge.net/p/openfoam-extend/ticketsfoamextendrelease/">http://sourceforge.net/p/openfoam-extend/ticketsfoamextendrelease/</a>
 580 </p>
 581 </div>
 582 </div>
 583 <div id="outline-container-sec-8" class="outline-2">
 584 <h2 id="sec-8"><span class="section-number-2">8</span> How to contribute</h2>
 585 <div class="outline-text-2" id="text-8">
 586 <p>
 587 All your contributions are highly welcome: New solvers, utilities and
 588 models; bug fixes; documentation. The many ways of contributing and the
 589 contribution process are described in detail at:
 590 <a href="http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/">http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/</a>
 591 </p>
 592 </div>
 593 </div>
 594 <div id="outline-container-sec-9" class="outline-2">
 595 <h2 id="sec-9"><span class="section-number-2">9</span> List of Contributors:</h2>
 596 <div class="outline-text-2" id="text-9">
 597 <p>
 598 See file ListOfContributors
 599 </p>
 600 </div>
 601 </div>
 602 </div>
 603 <div id="postamble" class="status">
 604 <p class="date">Date: August 2015</p>
 605 <p class="date">Created: 2015-09-11 Fri 18:01</p>
 606 <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.3.1 (<a href="http://orgmode.org">Org</a> mode 8.2.4)</p>
 607 <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
 608 </div>
 609 </body>
 610 </html>