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">
6 <title><b>Release notes for foam-extend-
3.1</b></title>
7 <meta http-equiv=
"Content-Type" content=
"text/html;charset=utf-8"/>
8 <meta name=
"title" content=
"<b>Release notes for foam-extend-3.1</b>"/>
9 <meta name=
"generator" content=
"Org-mode"/>
10 <meta name=
"generated" content=
"8 June 2014"/>
11 <meta name=
"author" content=
"Bernhard Gschaider"/>
12 <meta name=
"description" content=
""/>
13 <meta name=
"keywords" content=
""/>
14 <style type=
"text/css">
15 <!--/*--><![CDATA[/*
><!--*/
16 html { font-family: Times, serif; font-size: 12pt; }
17 .title { text-align: center; }
19 .done { color: green; }
20 .tag { background-color: #add8e6; font-weight:normal }
22 .timestamp { color: #bebebe; }
23 .timestamp-kwd { color: #5f9ea0; }
24 .right {margin-left:auto; margin-right:0px; text-align:right;}
25 .left {margin-left:0px; margin-right:auto; text-align:left;}
26 .center {margin-left:auto; margin-right:auto; text-align:center;}
27 p.verse { margin-left: 3% }
29 border: 1pt solid #AEBDCC;
30 background-color: #F3F5F7;
32 font-family: courier, monospace;
36 table { border-collapse: collapse; }
37 td, th { vertical-align: top; }
38 th.right { text-align:center; }
39 th.left { text-align:center; }
40 th.center { text-align:center; }
41 td.right { text-align:right; }
42 td.left { text-align:left; }
43 td.center { text-align:center; }
44 dt { font-weight: bold; }
45 div.figure { padding: 0.5em; }
46 div.figure p { text-align: center; }
49 border:2px solid gray;
53 textarea { overflow-x: auto; }
54 .linenr { font-size:smaller }
55 .code-highlighted {background-color:#ffff00;}
56 .org-info-js_info-navigation { border-style:none; }
57 #org-info-js_console-label { font-size:10px; font-weight:bold;
59 .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
63 <script type=
"text/javascript">
65 @licstart The following is the entire license notice for the
66 JavaScript code in this tag.
68 Copyright (C)
2012-
2013 Free Software Foundation, Inc.
70 The JavaScript code in this tag is free software: you can
71 redistribute it and/or modify it under the terms of the GNU
72 General Public License (GNU GPL) as published by the Free Software
73 Foundation, either version
3 of the License, or (at your option)
74 any later version. The code is distributed WITHOUT ANY WARRANTY;
75 without even the implied warranty of MERCHANTABILITY or FITNESS
76 FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
78 As additional permission under GNU GPL version
3 section
7, you
79 may distribute non-source (e.g., minimized or compacted) forms of
80 that code without the copy of the GNU GPL normally required by
81 section
4, provided you include this license notice and a URL
82 through which recipients can access the Corresponding Source.
85 @licend The above is the entire license notice
86 for the JavaScript code in this tag.
88 <!--/*--><![CDATA[/*
><!--*/
89 function CodeHighlightOn(elem, id)
91 var target = document.getElementById(id);
93 elem.cacheClassElem = elem.className;
94 elem.cacheClassTarget = target.className;
95 target.className = "code-highlighted";
96 elem.className = "code-highlighted";
99 function CodeHighlightOff(elem, id)
101 var target = document.getElementById(id);
102 if(elem.cacheClassElem)
103 elem.className = elem.cacheClassElem;
104 if(elem.cacheClassTarget)
105 target.className = elem.cacheClassTarget;
118 <h1 class=
"title"><b>Release notes for foam-extend-
3.1</b></h1>
120 <p>################################################################################
123 <div id=
"table-of-contents">
124 <h2>Table of Contents
</h2>
125 <div id=
"text-table-of-contents">
127 <li><a href=
"#sec-1">1 Overview
</a></li>
128 <li><a href=
"#sec-2">2 Installation
</a></li>
129 <li><a href=
"#sec-3">3 Compatibility
</a></li>
130 <li><a href=
"#sec-4">4 Main differentiators between foam-extend and OpenFOAM
</a></li>
131 <li><a href=
"#sec-5">5 New features in foam-extend-
3.1, since foam-extend-
3.0</a></li>
132 <li><a href=
"#sec-6">6 Recent successful compilations and tests
</a></li>
133 <li><a href=
"#sec-7">7 Reporting bugs
</a></li>
134 <li><a href=
"#sec-8">8 How to contribute
</a></li>
135 <li><a href=
"#sec-9">9 List of Contributors:
</a></li>
140 <div id=
"outline-container-1" class=
"outline-3">
141 <h3 id=
"sec-1"><span class=
"section-number-3">1</span> Overview
</h3>
142 <div class=
"outline-text-3" id=
"text-1">
144 <p> The foam-extend project is a fork of the OpenFOAM® open source
145 library for Computational Fluid Dynamics (CFD). It is an open
146 project welcoming and integrating contributions from all users and
147 developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend,
148 it contains bug fixes and performance improvements, as well as
149 extensions and additional features provided by community
150 contributors (see file ListOfContributors), such as dynamic mesh and
151 topological change support, turbomachinery extensions including
152 general grid interpolation (GGI), cyclic GGI and mixing plane,
153 block-coupled matrix support, implicitly coupled conjugate heat
154 transfer and other pyshics coupling, finite area method,
155 comprehensive dynamic mesh (motion and topological changes)
156 capability and GPU support. For a full list, see below and previous
158 <a href=
"http://sourceforge.net/p/openfoam-extend/wiki/Home/">http://sourceforge.net/p/openfoam-extend/wiki/Home/
</a>
161 Version
3.1, nicknamed
"Zagreb", is the current version of
162 foam-extend. The release continues the tradition and spirit of the
163 original FOAM code developed by prof. Jasak and Mr. Weller during
164 their time at Imperial College and released as the general purpose
165 CFD/CCM package by Nabla Ltd. in
2000. In this spirit, we reverted
166 18 December
2013 to the original numbering scheme (foam-
2.3.2,
13
167 December
2004) as release number
3.0. Visit
<a href=
"http://foam-extend.org">http://foam-extend.org
</a>
168 for more information.
171 OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and
172 foam-extend are a community effort not endorsed by ESI Group.
178 <div id=
"outline-container-2" class=
"outline-3">
179 <h3 id=
"sec-2"><span class=
"section-number-3">2</span> Installation
</h3>
180 <div class=
"outline-text-3" id=
"text-2">
182 <p> foam-extend-
3.1 can be compiled and runs on any linux system
185 <li>Main supported OSs:
197 <li>Compile from source:
200 Please refer to doc/buildInstructions/ for details. Further
201 installation instruction are available on the unofficial OpenFOAM
203 <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>
204 If you have improvements or build instructions for a new system,
205 please share them with the community (see section
"How to
209 <li>Download binary packages:
212 Binary packages are available for download at
213 <a href=
"http://sourceforge.net/projects/openfoam-extend/">http://sourceforge.net/projects/openfoam-extend/
</a> for the following
214 systems: Ubuntu
14.04, Fedora
20 and Mac OS X.
217 <li>Accompanying ThirdParty software:
219 <li>gcc compatibility up to
4.8.2
261 <div id=
"outline-container-3" class=
"outline-3">
262 <h3 id=
"sec-3"><span class=
"section-number-3">3</span> Compatibility
</h3>
263 <div class=
"outline-text-3" id=
"text-3">
265 <p> Upstream features from the OpenFOAM® code base are merged into
266 foam-extend on regular basis. The interface format of
267 foam-extend-
3.1 is largely compatible to OpenFOAM-
1.6-ext and
268 OpenFOAM-
1.7.x. In some cases, the differences are caused by bug
269 fixes and algorithmic improvements, considered more important than
276 <div id=
"outline-container-4" class=
"outline-3">
277 <h3 id=
"sec-4"><span class=
"section-number-3">4</span> Main differentiators between foam-extend and OpenFOAM
</h3>
278 <div class=
"outline-text-3" id=
"text-4">
280 <p> A large number of features have been lost within the release of
281 OpenFOAM since version
1.3, the code base has shrunk by more than
282 40%. While we understand the lack of technical ability of
283 supporting advanced CFD features, we feel that existing features and
284 specifically large-scale contributions should remain active and
285 developed further. Below is a list of main features of foam-extend
286 which are lacking, lost, deactivated or unusable in ESI releases:
289 <li>Turbomachinery features, including General Grid Interface (GGI),
290 partial overlap GGI, cyclic GGI, with improvements in parallel
291 scaling. First release of a mixing plane stage interface
294 <li>Dynamic mesh with topological changes Sliding interfaces, mesh
295 layering, attach-detach boundaries etc. In foam-extend, full
296 parallel support for topological changes is released for the first
300 <li>Finite Element Method with support for polyhedral meshes This is
301 mainly used in mesh deformation and over the last
15 years it has
302 proven vastly superior to all other dynamic mesh methods.
305 <li>Advanced mesh deformation technology Including tet FEM mesh
306 deformation, Radial Basis Function (RBF) mesh deformation,
307 tetrahedral remeshing dynamic mesh support and solid body motion
308 functions. All of the above include parallelisation support
311 <li>Library of dynamic meshes with topological changes with full
312 second order FVM discretisation support on moving meshes with
316 <li>Internal combustion engine-specific dynamic mesh classes such as
317 two-stroke engine and various forms of
4-stroke and multi-valve
321 <li>Finite Area Method providing support for FVM-like discretisation
322 on a curved surface in
3-D, with examples of liquid film modelling
325 <li>Block-coupled matrix support, allowing fully implicit
326 multi-equation solution of NxN equation sets, with full
327 parallelisation support. First release of a block-AMG linear
331 <li>Fully implicit conjugate-coupled solution framework, allowing
332 implicit solution fo multiple equations over multiple meshes, with
336 <li>Proper Orthogonal Decomposition data analysis tools, with
337 applications to FOAM field classes
340 <li>Equation reader classes and tutorials
343 <li>Multi-solver solution framework, allowing multiple field models to
344 be solved in a coupled manner
347 <li>A major contribution is solid mechanics modelling, including
348 linear and non-linear materials, contact, self-contact and
349 friction, with updated Lagrangian or absolute Lagrangian
350 formulation. Solution of damage models and crack propagation in
351 complex materials via topological changes
354 <li>CUDA solver release, provided in full source and as an example of
355 coupling external linear equation solvers with FOAM
358 <li>Library-level support for Immersed Boundary Method and Overset
362 <li>Major improvements in accuracy and stability of FVM discretisation
363 with options on convection and diffusion discretisation, deferred
364 correction or explicit schemes
367 <li>Algebraic multigrid solver framework
370 <li>210 tutorials with automated run scripts
373 <li>Automatic test harness
376 <li>Approximately
6000 bug fixes in fundamental level libraries and
377 discretisation techniques
386 <div id=
"outline-container-5" class=
"outline-3">
387 <h3 id=
"sec-5"><span class=
"section-number-3">5</span> New features in foam-extend-
3.1, since foam-extend-
3.0</h3>
388 <div class=
"outline-text-3" id=
"text-5">
390 <p> The list of features is a result of the work of numerous
391 contributors. The maintainers of foam-extend would formally like to
395 Get a full log of the updates by (either):
399 <pre class=
"example">user@machine
> git log
3.0..
> commitLog
403 <pre class=
"example">user@machine
> git log
3.0.. --oneline
> commitLog
407 <pre class=
"example">user@machine
> gitg
3.0..
412 <li>Major new features:
414 <li>Pressure-based compressible turbo functionalities
416 <li>Pressure-based coupled solver (block-coupling p and U)
418 <li>Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam
420 <li>Major update and validation of mixing plane boundary
422 <li>Full deploymenr of block matrix, including block-AMG solverse
424 <li>Further parallel dynamic mesh capability: all topological changes
425 supported in parallel execution
427 <li>Major upgrade of solid mechanics solvers
429 <li>Support for CLang-based compilers
440 <li>Updated and bug-fixed installation procedures
442 <li>Removed need for gmake link in Ubuntu
444 <li>Scripts for minimizing installation after compilation
446 <li>ThirdParty/Allclean alsoPackage - new option
448 <li>wcleanAllButLibBinLnInclude
453 <li>Fixed problem with ParaView reader for Ubuntu
14.04
455 <li>foamToTecplot360: building tecio doesn't require X.org
464 <li>compressible/dbnsFoam
466 <li>compressible/dbnsTurbFoam
468 <li>compressible/steadyCompressibleFoam
470 <li>compressible/steadyCompressibleMRFFoam
472 <li>compressible/steadyCompressibleSRFFoam
474 <li>coupled/pUCoupledFoam (incl. core library changes)
477 <li>Update and cleanup of solvers/solidMechanics
479 <li>Update for segregated FEM matrix,
480 solvers/solidMechanics/stressFemFoam
488 <li>convertPhi (for steadyCompressible solvers)
490 <li>foamMeshToElmer, fluent3DMeshToElmer
492 <li>transformPoints -cylToCart
"origin axis direction" - new option
494 <li>blockMesh syntax update (see commit a78b12074)
504 <li>Added Gauss-Seidel as asymmetric solver
506 <li>Block matrix agglomeration (for pUCoupledFoam)
510 <li>dbns library (src/dbns)
515 <li>Boundary conditions:
517 <li>cfdTools/general/SRF/derivedFvPatchFields/SRFFlowRateInletVelocity
519 <li>cfdTools/general/SRF/derivedFvPatchFields/SRFSurfaceNormalVelocity
521 <li>cfdTools/general/SRF/derivedFvPatchFields/SRFTotalPressure
523 <li>cfdTools/general/SRF/derivedFvPatchFields/SRFTotalTemperature
525 <li>cfdTools/general/SRF/derivedFvPatchFields/pulseFixedValue
527 <li>cfdTools/general/SRF/derivedFvPatchFields/waveTransmissiveInlet
529 <li>thermophysicalModels/basic/derivedFvPatchFields/isentropicTotalTemperature
531 <li>thermophysicalModels/basic/derivedFvPatchFields/temperatureDirectedInletOutletVelocity
533 <li>fvMesh/fvPatches/constraint/mixingPlane
538 <li>Turbulence modeling:
540 <li>Removed kOmegaSST_lowRe - use standard kOmegaSST
549 <li>Tutorial updates (settings, initial conditions, bug fixes etc.):
551 <li>incompressible/icoDyMFoam/mixerGgi
553 <li>incompressible/icoDyMFoam/movingConeMotion
555 <li>incompressible/icoDyMFoam/movingConeTopo
557 <li>solidMechanics/elasticNonLinTLSolidFoam/largeStrainCantileverBeam
559 <li>solidMechanics/elasticNonLinTLSolidFoam/nonLinBlock
561 <li>solidMechanics/elasticNonLinTLSolidFoam/rotateSphereTL
563 <li>solidMechanics/elasticThermalSolidFoam/hotCylinder
565 <li>solidMechanics/stressFemFoam/plateHole
567 <li>Many other updates due to blockMesh syntax update
575 <li>compressible/dbnsFoam/forwardStep
577 <li>compressible/dbnsFoam/shockTube
579 <li>compressible/dbnsTurbFoam/naca0012
581 <li>compressible/steadyCompressibleFoam/
2bump
583 <li>compressible/steadyCompressibleFoam/bumpBlockMesh
585 <li>compressible/steadyCompressibleFoam/bumpFine05
587 <li>compressible/steadyCompressibleMRFFoam/bentRotorStator
589 <li>compressible/steadyCompressibleMRFFoam/simpleRotorStator
591 <li>compressible/steadyCompressibleSRFFoam/bentBlade
593 <li>compressible/steadyCompressibleSRFFoam/simpleBlade
595 <li>coupled/pUCoupledFoam/cavity
597 <li>incompressible/MRFSimpleFoam/axialTurbine_ggi
599 <li>incompressible/MRFSimpleFoam/axialTurbine_mixingPlane
601 <li>incompressible/pimpleDyMFoam/axialTurbine
603 <li>incompressible/pimpleDyMFoam/movingCylinders
605 <li>incompressible/pUCoupledFoam/backwardFacingStepLaminar
607 <li>incompressible/pUCoupledFoam/backwardFacingStepTurbulent
609 <li>incompressible/pUCoupledFoam/cavity
611 <li>incompressible/simpleSRFFoam/axialTurbine
613 <li>mesh/moveDynamicMesh/movingCylinders
621 <li>Correct snGrad on coupled boundaries
623 <li>Handling of static null pointers: safe to dereference
625 <li>LinearUpwind no longer hangs in parallel execution on empty patches
627 <li>Mesh update on parallel topo changes: zones before boundaries
629 <li>GGI interpolation updates on topologically changing meshes
631 <li>Cell layering issues off complex surfaces
633 <li>Template depth for block matrix support
635 <li>Parallel efficiency improvements
647 <div id=
"outline-container-6" class=
"outline-3">
648 <h3 id=
"sec-6"><span class=
"section-number-3">6</span> Recent successful compilations and tests
</h3>
649 <div class=
"outline-text-3" id=
"text-6">
655 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
736</a>
661 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
738</a>
667 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
734</a>
670 <li>Mac OX X
10.9.3 Maverick
& CLang (XCode compiler):
673 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
733</a>
676 <li>Mac OX X
& gcc (Macports)
679 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
737</a>
682 <li>Linux PPC ppc64 (Blue Gene)
685 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=742">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
742</a>
688 <li>Red Hat Enterprise Linux Server release
5.2 (Tikanga), Intel CC
11.1
691 <a href=
"http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=
743</a>
700 <div id=
"outline-container-7" class=
"outline-3">
701 <h3 id=
"sec-7"><span class=
"section-number-3">7</span> Reporting bugs
</h3>
702 <div class=
"outline-text-3" id=
"text-7">
704 <p> To report bugs, please use the MantisBT bugtracker at
705 <a href=
"http://sourceforge.net/apps/mantisbt/openfoam-extend">http://sourceforge.net/apps/mantisbt/openfoam-extend
</a>
711 <div id=
"outline-container-8" class=
"outline-3">
712 <h3 id=
"sec-8"><span class=
"section-number-3">8</span> How to contribute
</h3>
713 <div class=
"outline-text-3" id=
"text-8">
715 <p> All your contributions are highly welcome: New solvers, utilities and
716 models; bug fixes; documentation. The many ways of contributing and the
717 contribution process are described in detail at:
718 <a href=
"http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/">http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/
</a>
724 <div id=
"outline-container-9" class=
"outline-3">
725 <h3 id=
"sec-9"><span class=
"section-number-3">9</span> List of Contributors:
</h3>
726 <div class=
"outline-text-3" id=
"text-9">
728 <p> See file ListOfContributors
734 <p class=
"date">Date:
8 June
2014</p>
735 <p class=
"creator"><a href=
"http://orgmode.org">Org
</a> version
7.9.3f with
<a href=
"http://www.gnu.org/software/emacs/">Emacs
</a> version
24</p>
736 <a href=
"http://validator.w3.org/check?uri=referer">Validate XHTML
1.0</a>