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-4.0</b></title>
   7 <!-- 2016-12-09 Fri 16:16 -->
   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   caption.t-above { caption-side: top; }
  58   caption.t-bottom { caption-side: bottom; }
  59   td, th { vertical-align:top;  }
  60   th.right  { text-align: center;  }
  61   th.left   { text-align: center;   }
  62   th.center { text-align: center; }
  63   td.right  { text-align: right;  }
  64   td.left   { text-align: left;   }
  65   td.center { text-align: center; }
  66   dt { font-weight: bold; }
  67   .footpara:nth-child(2) { display: inline; }
  68   .footpara { display: block; }
  69   .footdef  { margin-bottom: 1em; }
  70   .figure { padding: 1em; }
  71   .figure p { text-align: center; }
  72   .inlinetask {
  73     padding: 10px;
  74     border: 2px solid gray;
  75     margin: 10px;
  76     background: #ffffcc;
  77   }
  78   #org-div-home-and-up
  79    { text-align: right; font-size: 70%; white-space: nowrap; }
  80   textarea { overflow-x: auto; }
  81   .linenr { font-size: smaller }
  82   .code-highlighted { background-color: #ffff00; }
  83   .org-info-js_info-navigation { border-style: none; }
  84   #org-info-js_console-label
  85     { font-size: 10px; font-weight: bold; white-space: nowrap; }
  86   .org-info-js_search-highlight
  87     { background-color: #ffff00; color: #000000; font-weight: bold; }
  88   /*]]>*/-->
  89 </style>
  90 <script type="text/javascript">
  91 /*
  92 @licstart  The following is the entire license notice for the
  93 JavaScript code in this tag.
  94
  95 Copyright (C) 2012-2013 Free Software Foundation, Inc.
  96
  97 The JavaScript code in this tag is free software: you can
  98 redistribute it and/or modify it under the terms of the GNU
  99 General Public License (GNU GPL) as published by the Free Software
 100 Foundation, either version 3 of the License, or (at your option)
 101 any later version.  The code is distributed WITHOUT ANY WARRANTY;
 102 without even the implied warranty of MERCHANTABILITY or FITNESS
 103 FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
 104
 105 As additional permission under GNU GPL version 3 section 7, you
 106 may distribute non-source (e.g., minimized or compacted) forms of
 107 that code without the copy of the GNU GPL normally required by
 108 section 4, provided you include this license notice and a URL
 109 through which recipients can access the Corresponding Source.
 110
 111
 112 @licend  The above is the entire license notice
 113 for the JavaScript code in this tag.
 114 */
 115 <!--/*--><![CDATA[/*><!--*/
 116  function CodeHighlightOn(elem, id)
 117  {
 118    var target = document.getElementById(id);
 119    if(null != target) {
 120      elem.cacheClassElem = elem.className;
 121      elem.cacheClassTarget = target.className;
 122      target.className = "code-highlighted";
 123      elem.className   = "code-highlighted";
 124    }
 125  }
 126  function CodeHighlightOff(elem, id)
 127  {
 128    var target = document.getElementById(id);
 129    if(elem.cacheClassElem)
 130      elem.className = elem.cacheClassElem;
 131    if(elem.cacheClassTarget)
 132      target.className = elem.cacheClassTarget;
 133  }
 134 /*]]>*///-->
 135 </script>
 136 </head>
 137 <body>
 138 <div id="content">
 139 <h1 class="title"><b>Release notes for foam-extend-4.0</b></h1>
 140 <div id="table-of-contents">
 141 <h2>Table of Contents</h2>
 142 <div id="text-table-of-contents">
 143 <ul>
 144 <li><a href="#sec-1">1. Overview</a></li>
 145 <li><a href="#sec-2">2. Installation</a></li>
 146 <li><a href="#sec-3">3. Compatibility</a></li>
 147 <li><a href="#sec-4">4. Main differentiators between foam-extend and OpenFOAM</a></li>
 148 <li><a href="#sec-5">5. New features in foam-extend-4.0, since foam-extend-3.2</a></li>
 149 <li><a href="#sec-6">6. Recent successful compilations and tests</a></li>
 150 <li><a href="#sec-7">7. Reporting bugs</a></li>
 151 <li><a href="#sec-8">8. How to contribute</a></li>
 152 <li><a href="#sec-9">9. List of Contributors:</a></li>
 153 </ul>
 154 </div>
 155 </div>
 156 <p>
 157 ###############################################################################
 158 </p>
 159
 160 <div id="outline-container-sec-1" class="outline-2">
 161 <h2 id="sec-1"><span class="section-number-2">1</span> Overview</h2>
 162 <div class="outline-text-2" id="text-1">
 163 <p>
 164 The foam-extend project is a fork of the OpenFOAM® open source
 165 library for Computational Fluid Dynamics (CFD). It is an open
 166 project welcoming and integrating contributions from all users and
 167 developers. Previously known as OpenFOAM-dev and OpenFOAM-extend,
 168 it contains bug fixes and performance improvements, as well as
 169 extensions and additional features provided by community
 170 contributors (see file ListOfContributors), such as dynamic mesh and
 171 topological change support, turbomachinery extensions including
 172 general grid interpolation (GGI), cyclic GGI and mixing plane,
 173 block-coupled matrix support, implicitly coupled conjugate heat
 174 transfer and other physics coupling, finite area method,
 175 comprehensive dynamic mesh (motion and topological changes)
 176 capability and GPU support. For a full list, see below and previous
 177 release notes at:
 178 <a href="http://sourceforge.net/p/foam-extend/wiki/Home/">http://sourceforge.net/p/foam-extend/wiki/Home/</a>
 179 </p>
 180
 181 <p>
 182 Version 4.0, nicknamed "Guimaraes", is the current version of
 183 foam-extend. The release continues the tradition and spirit of the
 184 original FOAM code developed by prof. Jasak and Mr. Weller during
 185 their time at Imperial College and released as the general purpose
 186 CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted
 187 18 December 2013 to the original numbering scheme (foam-2.3.2, 13
 188 December 2004) as release number 3.0.  Visit <a href="http://foam-extend.org">http://foam-extend.org</a>
 189 for more information.
 190 </p>
 191
 192 <p>
 193 OPENFOAM is a registered trademark of ESI Group. OpenFOAM-extend and
 194 foam-extend are a community effort not endorsed by ESI Group.
 195 </p>
 196 </div>
 197 </div>
 198
 199
 200 <div id="outline-container-sec-2" class="outline-2">
 201 <h2 id="sec-2"><span class="section-number-2">2</span> Installation</h2>
 202 <div class="outline-text-2" id="text-2">
 203 <p>
 204 foam-extend-4.0 can be compiled and runs on a large variety of Linux, Mac or Windows
 205 systems
 206 </p>
 207
 208 <ul class="org-ul">
 209 <li>Main supported OSs:
 210 <ul class="org-ul">
 211 <li>Ubuntu 16.04 LTS
 212 </li>
 213 <li>Ubuntu 14.04 LTS
 214 </li>
 215 <li>Fedora 24
 216 </li>
 217 <li>Mac OS X
 218 </li>
 219 <li>Microsoft Windows 7, 8.1 and 10
 220 </li>
 221 </ul>
 222 </li>
 223
 224 <li>Compile from source:
 225
 226 <p>
 227 Please refer to doc/buildInstructions/ for details. Further
 228 installation instruction are available on the unofficial OpenFOAM
 229 Wiki:
 230 <a href="http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-4.0">http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-4.0</a>
 231 If you have improvements or build instructions for a new system,
 232 please share them with the community (see section "How to
 233 contribute", below).
 234 </p>
 235 </li>
 236
 237 <li>Download binary packages:
 238
 239 <p>
 240 Binary packages are available for download at
 241 <a href="http://sourceforge.net/projects/foam-extend/">http://sourceforge.net/projects/foam-extend/</a> for the following
 242 systems: Ubuntu 16.04, Fedora 24 and Mac OS X and Windows 10.
 243 </p>
 244 </li>
 245
 246 <li>Accompanying ThirdParty software:
 247 <ul class="org-ul">
 248 <li>gcc compatibility up to 4.9.2
 249 </li>
 250 <li>bison 2.7
 251 </li>
 252 <li>cmake 3.2.2
 253 </li>
 254 <li>flex-2.5.35
 255 </li>
 256 <li>hwloc 1.10.1
 257 </li>
 258 <li>libccmio 2.6.1
 259 </li>
 260 <li>mesquite 2.1.2
 261 </li>
 262 <li>metis 5.1.0
 263 </li>
 264 <li>openmpi 1.8.8
 265 </li>
 266 <li>Paraview 4.4.0
 267 </li>
 268 <li>parmetis 4.0.3
 269 </li>
 270 <li>ParMGridGen 1.0
 271 </li>
 272 <li>PyFoam 0.6.4
 273 </li>
 274 <li>qt 4.8.6
 275 </li>
 276 <li>scotch 6.0.4
 277 </li>
 278 <li>swak4Foam 0.4.0
 279 </li>
 280 </ul>
 281 </li>
 282 </ul>
 283 </div>
 284 </div>
 285
 286
 287 <div id="outline-container-sec-3" class="outline-2">
 288 <h2 id="sec-3"><span class="section-number-2">3</span> Compatibility</h2>
 289 <div class="outline-text-2" id="text-3">
 290 <p>
 291 Upstream features from the OpenFOAM® code base are merged into
 292 foam-extend on regular basis. The interface format of
 293 foam-extend-4.0 is largely compatible to foam-extend-3.2, to
 294 OpenFOAM-1.6-ext and OpenFOAM-1.7.x. In some cases, the
 295 differences are caused by bug fixes and algorithmic improvements,
 296 considered more important than inter-operability.
 297 </p>
 298 </div>
 299 </div>
 300
 301 <div id="outline-container-sec-4" class="outline-2">
 302 <h2 id="sec-4"><span class="section-number-2">4</span> Main differentiators between foam-extend and OpenFOAM</h2>
 303 <div class="outline-text-2" id="text-4">
 304 <p>
 305 A large number of features have been lost within the release of
 306 OpenFOAM since version 1.3, the code base has shrunk by more than
 307 40%.  While we understand the lack of technical ability of
 308 supporting advanced CFD features, we feel that existing features and
 309 specifically large-scale contributions should remain active and
 310 developed further. Below is a list of main features of foam-extend
 311 which are lacking, lost, deactivated or unusable in ESI releases:
 312 </p>
 313
 314 <ul class="org-ul">
 315 <li>Turbomachinery features, including General Grid Interface (GGI),
 316 partial overlap GGI, cyclic GGI, with improvements in parallel
 317 scaling.  First release of a mixing plane stage interface
 318 </li>
 319
 320 <li>Dynamic mesh with topological changes Sliding interfaces, mesh
 321 layering, attach-detach boundaries etc.  In foam-extend, full
 322 parallel support for topological changes is released for the first
 323 time
 324 </li>
 325
 326 <li>Finite Element Method with support for polyhedral meshes This is
 327 mainly used in mesh deformation and over the last 15 years it has
 328 proven vastly superior to all other dynamic mesh methods.
 329 </li>
 330
 331 <li>Advanced mesh deformation technology Including tet FEM mesh
 332 deformation, Radial Basis Function (RBF) mesh deformation,
 333 tetrahedral remeshing dynamic mesh support and solid body motion
 334 functions.  All of the above include parallelisation support
 335 </li>
 336
 337 <li>Library of dynamic meshes with topological changes with full
 338 second order FVM discretisation support on moving meshes with
 339 topological changes
 340 </li>
 341
 342 <li>Internal combustion engine-specific dynamic mesh classes such as
 343 two-stroke engine and various forms of 4-stroke and multi-valve
 344 dynamic mesh classes
 345 </li>
 346
 347 <li>Finite Area Method providing support for FVM-like discretisation
 348 on a curved surface in 3-D, with examples of liquid film modeling
 349 </li>
 350
 351 <li>Block-coupled matrix support, allowing fully implicit
 352 multi-equation solution of NxN equation sets, with full
 353 parallelisation support.  First release of a block-AMG linear
 354 equation solver
 355 </li>
 356
 357 <li>Fully implicit conjugate-coupled solution framework, allowing
 358 implicit solution fo multiple equations over multiple meshes, with
 359 parallelism
 360 </li>
 361
 362 <li>Proper Orthogonal Decomposition data analysis tools, with
 363 applications to FOAM field classes
 364 </li>
 365
 366 <li>Equation reader classes and tutorials
 367 </li>
 368
 369 <li>Multi-solver solution framework, allowing multiple field models to
 370 be solved in a coupled manner
 371 </li>
 372
 373 <li>A major contribution is solid mechanics modelling, including
 374 linear and non-linear materials, contact, self-contact and
 375 friction, with updated Lagrangian or absolute Lagrangian
 376 formulation.  Solution of damage models and crack propagation in
 377 complex materials via topological changes
 378 </li>
 379
 380 <li>CUDA solver release, provided in full source and as an example of
 381 coupling external linear equation solvers with FOAM
 382 </li>
 383
 384 <li>Library-level support for Immersed Boundary Method and Overset
 385 Mesh
 386 </li>
 387
 388 <li>Major improvements in accuracy and stability of FVM discretisation
 389 with options on convection and diffusion discretisation, deferred
 390 correction or explicit schemes
 391 </li>
 392
 393 <li>Algebraic multigrid solver framework
 394 </li>
 395
 396 <li>253 tutorials with automated run scripts
 397 </li>
 398
 399 <li>Automatic test harness
 400 </li>
 401
 402 <li>Approximately 6000 bug fixes in fundamental level libraries and
 403 discretisation techniques
 404 </li>
 405 </ul>
 406 </div>
 407 </div>
 408
 409 <div id="outline-container-sec-5" class="outline-2">
 410 <h2 id="sec-5"><span class="section-number-2">5</span> New features in foam-extend-4.0, since foam-extend-3.2</h2>
 411 <div class="outline-text-2" id="text-5">
 412 <p>
 413 The list of features is a result of the work of numerous
 414 contributors. The maintainers of foam-extend would formally like to
 415 thank them all.
 416 </p>
 417
 418 <p>
 419 Get a full log of the updates by (either):
 420 </p>
 421 <div class="org-src-container">
 422
 423 <pre class="src src-bash">user@machine&gt; git log 4.0.. &gt; commitLog
 424 </pre>
 425 </div>
 426 <div class="org-src-container">
 427
 428 <pre class="src src-bash">user@machine&gt; git log 4.0.. --oneline &gt; commitLog
 429 </pre>
 430 </div>
 431 <div class="org-src-container">
 432
 433 <pre class="src src-bash">user@machine&gt; gitg 4.0..
 434 </pre>
 435 </div>
 436
 437 <ul class="org-ul">
 438 <li>Major new features:
 439 <ul class="org-ul">
 440 <li>Improved BlockLduMatrix and block-coupled p-U solver and associated tools
 441 </li>
 442 <li>ILUCp and block ILUCp preconditioners
 443 </li>
 444 <li>Added MRF and porous media handling to the block-coupled solver
 445 </li>
 446 <li>Change of generic turbulence modelling interface: no U required
 447 </li>
 448 <li>Updated version of block-coupled turbulence models
 449 </li>
 450 <li>Major improvements in immersed boundary method library: improved performance
 451 and parallel scaling.  Completed supporft for moving deforming immersed boundary
 452 </li>
 453 <li>Adopted vanilla OpenFOAM solver control format (solutionControl class)
 454 </li>
 455 <li>Implicit adjoint convection operator
 456 </li>
 457 <li>Improved GGI interpolation and cutting, with better parallel scaling
 458 </li>
 459 <li>Global GGI search option for parallel cases
 460 </li>
 461 <li>GGI and mixing planes with jump condition for the rothalpy equation
 462 </li>
 463 <li>Improved 6-DOF solver, with new handling of constraints
 464 </li>
 465 <li>Fully integrated real gas library
 466 </li>
 467 <li>Updated viscoelastoplastic models
 468 </li>
 469 <li>New steady-state universal flow solver, handling incompressible and compressible
 470 flows within the same framework
 471 </li>
 472 <li>Time consistent incompressible solvers update
 473 </li>
 474 <li>Added decaying turbulence inlet boundary condition by Kornev
 475 </li>
 476 <li>New gradient limiter implementation
 477 </li>
 478 <li>Full gradient cacheing capability
 479 </li>
 480 <li>Removed fluxRequired from solution dictionaries
 481 </li>
 482 <li>Consistent notation of 1/aP
 483 </li>
 484 <li>Dynamic mesh improvements: prescribed motion functions
 485 </li>
 486 </ul>
 487 </li>
 488
 489 <li>Software
 490 <ul class="org-ul">
 491 <li>New handling of lnInclude directories: avoid file copying on MS Windows
 492 </li>
 493 <li>Changes to controlDict and options on MS Windows
 494 </li>
 495 <li>Consistency in formatting of compression options
 496 </li>
 497 <li>Raspberry Pi port
 498 </li>
 499 </ul>
 500 </li>
 501
 502 <li>Installation:
 503 <ul class="org-ul">
 504 <li>Compilation improvements
 505 </li>
 506 <li>Updated packages versions and compilation in ThirdParty
 507 </li>
 508 <li>Changed compilation options for Infiniband: new versions of MPI
 509 </li>
 510 <li>Added support for mvapich2-2.2
 511 </li>
 512 <li>Updated compilation for latest version of XCode for Mac OSX
 513 </li>
 514 <li>Updates for MS Windows build
 515 </li>
 516 </ul>
 517 </li>
 518
 519 <li>Solvers:
 520 <ul class="org-ul">
 521 <li>Updated time consistent incompressible solvers (channelFoam, icoFoam, nonNewtonianIcoFoam, pimpleDyMFoam, pimpleFoam, simpleFoam, simpleSRFFoam)
 522 </li>
 523 <li>Steady universal (compressible and incompressible) flow solver (steadyUniversalFoam)
 524 </li>
 525 <li>Block-coupled p-U solver improvements (MRFPorousFoam and pUCoupledFoam)
 526 </li>
 527 <li>Improved steadyCompressibleMRFFoam
 528 </li>
 529 </ul>
 530 </li>
 531
 532 <li>New tutorials:
 533 <ul class="org-ul">
 534 <li>Transient real fluid examples
 535 </li>
 536 <li>Universal steady-state MRF examples
 537 </li>
 538 <li>Additional coupled CHT example
 539 </li>
 540 <li>Additional immersed boundary example
 541 </li>
 542 <li>Additional steady-state MRF and GGI example
 543 </li>
 544 </ul>
 545 </li>
 546
 547 <li>Bug fixes: see git log for details
 548 </li>
 549 </ul>
 550 </div>
 551 </div>
 552
 553 <div id="outline-container-sec-6" class="outline-2">
 554 <h2 id="sec-6"><span class="section-number-2">6</span> Recent successful compilations and tests</h2>
 555 <div class="outline-text-2" id="text-6">
 556 <ul class="org-ul">
 557 <li>Ubuntu 16.04 LTS
 558 </li>
 559 </ul>
 560 </div>
 561 </div>
 562
 563 <div id="outline-container-sec-7" class="outline-2">
 564 <h2 id="sec-7"><span class="section-number-2">7</span> Reporting bugs</h2>
 565 <div class="outline-text-2" id="text-7">
 566 <p>
 567 To report bugs, please use the bugtracker at
 568 <a href="http://sourceforge.net/p/foam-extend/tickets/">http://sourceforge.net/p/foam-extend/tickets/</a>
 569 </p>
 570 </div>
 571 </div>
 572
 573 <div id="outline-container-sec-8" class="outline-2">
 574 <h2 id="sec-8"><span class="section-number-2">8</span> How to contribute</h2>
 575 <div class="outline-text-2" id="text-8">
 576 <p>
 577 All your contributions are highly welcome: New solvers, utilities and
 578 models; bug fixes; documentation. The many ways of contributing and the
 579 contribution process are described in detail at:
 580 <a href="http://sourceforge.net/p/foam-extend/wiki/HowToContribute/">http://sourceforge.net/p/foam-extend/wiki/HowToContribute/</a>
 581 </p>
 582 </div>
 583 </div>
 584
 585 <div id="outline-container-sec-9" class="outline-2">
 586 <h2 id="sec-9"><span class="section-number-2">9</span> List of Contributors:</h2>
 587 <div class="outline-text-2" id="text-9">
 588 <p>
 589 See file ListOfContributors
 590 </p>
 591 </div>
 592 </div>
 593 </div>
 594 <div id="postamble" class="status">
 595 <p class="date">Date: December 2016</p>
 596 <p class="date">Created: 2016-12-09 Fri 16:16</p>
 597 <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.5.1 (<a href="http://orgmode.org">Org</a> mode 8.2.10)</p>
 598 <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
 599 </div>
 600 </body>
 601 </html>