ReleaseNotes

   1 #                            -*- mode: org; -*-
   2 #
   3 #+TITLE:             *Release notes for foam-extend-3.1*
   4 #+AUTHOR:                foam-extend administrators:
   5 #+AUTHOR:                        Hrvoje Jasak
   6 #+AUTHOR:                       Håkan Nilsson
   7 #+AUTHOR:                       Henrik Rusche
   8 #+AUTHOR:                      Martin Beaudoin
   9 #+AUTHOR:                     Bernhard Gschaider
  10 #+DATE:                          8 June 2014
  11 #+LINK:                     http://foam-extend.org
  12 #+OPTIONS: author:nil
  13 #+OPTIONS: toc:2
  14 #+OPTIONS: _:nil
  15 #+OPTIONS: ^:nil
  16
  17 ###############################################################################
  18
  19 ** Overview
  20   The foam-extend project is a fork of the OpenFOAM® open source
  21   library for Computational Fluid Dynamics (CFD). It is an open
  22   project welcoming and integrating contributions from all users and
  23   developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend,
  24   it contains bug fixes and performance improvements, as well as
  25   extensions and additional features provided by community
  26   contributors (see file ListOfContributors), such as dynamic mesh and
  27   topological change support, turbomachinery extensions including
  28   general grid interpolation (GGI), cyclic GGI and mixing plane,
  29   block-coupled matrix support, implicitly coupled conjugate heat
  30   transfer and other pyshics coupling, finite area method,
  31   comprehensive dynamic mesh (motion and topological changes)
  32   capability and GPU support. For a full list, see below and previous
  33   release notes at:
  34   http://sourceforge.net/p/openfoam-extend/wiki/Home/
  35
  36   Version 3.1, nicknamed "Zagreb", is the current version of
  37   foam-extend. The release continues the tradition and spirit of the
  38   original FOAM code developed by prof. Jasak and Mr. Weller during
  39   their time at Imperial College and released as the general purpose
  40   CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted
  41   18 December 2013 to the original numbering scheme (foam-2.3.2, 13
  42   December 2004) as release number 3.0.  Visit http://foam-extend.org
  43   for more information.
  44
  45   OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and
  46   foam-extend are a community effort not endorsed by ESI Group.
  47
  48 ** Installation
  49    foam-extend-3.1 can be compiled and runs on any linux system
  50
  51   * Main supported OSs:
  52     - Ubuntu 14.04
  53     - Fedora 20
  54     - Mac OS X
  55
  56   * Compile from source:
  57
  58     Please refer to doc/buildInstructions/ for details. Further
  59     installation instruction are available on the unofficial OpenFOAM
  60     Wiki:
  61     http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.1
  62     If you have improvements or build instructions for a new system,
  63     please share them with the community (see section "How to
  64     contribute", below).
  65
  66   * Download binary packages:
  67
  68     Binary packages are available for download at
  69     http://sourceforge.net/projects/openfoam-extend/ for the following
  70     systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
  71
  72   * Accompanying ThirdParty software:
  73     - gcc compatibility up to 4.8.2
  74     - Paraview 4.0.1
  75     - qt 4.8.5
  76     - openmpi 1.6.5
  77     - cmake 2.8.12
  78     - metis 5.1.0
  79     - parmetis 4.0.3
  80     - scotch 6.0.0
  81     - ParMGridGen 1.0
  82     - mesquite 2.1.2
  83     - PyFoam 0.6.3
  84     - swak4Foam 0.3.1
  85     - zoltan 3.6
  86     - bison 2.7
  87     - hwloc 1.7.2
  88     - libccmio 2.6.1
  89
  90 ** Compatibility
  91   Upstream features from the OpenFOAM® code base are merged into
  92   foam-extend on regular basis. The interface format of
  93   foam-extend-3.1 is largely compatible to OpenFOAM-1.6-ext and
  94   OpenFOAM-1.7.x. In some cases, the differences are caused by bug
  95   fixes and algorithmic improvements, considered more important than
  96   inter-operability.
  97
  98 ** Main differentiators between foam-extend and OpenFOAM
  99   A large number of features have been lost within the release of
 100   OpenFOAM since version 1.3, the code base has shrunk by more than
 101   40%.  While we understand the lack of technical ability of
 102   supporting advanced CFD features, we feel that existing features and
 103   specifically large-scale contributions should remain active and
 104   developed further. Below is a list of main features of foam-extend
 105   which are lacking, lost, deactivated or unusable in ESI releases:
 106
 107   * Turbomachinery features, including General Grid Interface (GGI),
 108     partial overlap GGI, cyclic GGI, with improvements in parallel
 109     scaling.  First release of a mixing plane stage interface
 110
 111   * Dynamic mesh with topological changes Sliding interfaces, mesh
 112     layering, attach-detach boundaries etc.  In foam-extend, full
 113     parallel support for topological changes is released for the first
 114     time
 115
 116   * Finite Element Method with support for polyhedral meshes This is
 117     mainly used in mesh deformation and over the last 15 years it has
 118     proven vastly superior to all other dynamic mesh methods.
 119
 120   * Advanced mesh deformation technology Including tet FEM mesh
 121     deformation, Radial Basis Function (RBF) mesh deformation,
 122     tetrahedral remeshing dynamic mesh support and solid body motion
 123     functions.  All of the above include parallelisation support
 124
 125   * Library of dynamic meshes with topological changes with full
 126     second order FVM discretisation support on moving meshes with
 127     topological changes
 128
 129   * Internal combustion engine-specific dynamic mesh classes such as
 130     two-stroke engine and various forms of 4-stroke and multi-valve
 131     dynamic mesh classes
 132
 133   * Finite Area Method providing support for FVM-like discretisation
 134     on a curved surface in 3-D, with examples of liquid film modelling
 135
 136   * Block-coupled matrix support, allowing fully implicit
 137     multi-equation solution of NxN equation sets, with full
 138     parallelisation support.  First release of a block-AMG linear
 139     equation solver
 140
 141   * Fully implicit conjugate-coupled solution framework, allowing
 142     implicit solution fo multiple equations over multiple meshes, with
 143     parallelism
 144
 145   * Proper Orthogonal Decomposition data analysis tools, with
 146     applications to FOAM field classes
 147
 148   * Equation reader classes and tutorials
 149
 150   * Multi-solver solution framework, allowing multiple field models to
 151     be solved in a coupled manner
 152
 153   * A major contribution is solid mechanics modelling, including
 154     linear and non-linear materials, contact, self-contact and
 155     friction, with updated Lagrangian or absolute Lagrangian
 156     formulation.  Solution of damage models and crack propagation in
 157     complex materials via topological changes
 158
 159   * CUDA solver release, provided in full source and as an example of
 160     coupling external linear equation solvers with FOAM
 161
 162   * Library-level support for Immersed Boundary Method and Overset
 163     Mesh
 164
 165   * Major improvements in accuracy and stability of FVM discretisation
 166     with options on convection and diffusion discretisation, deferred
 167     correction or explicit schemes
 168
 169   * Algebraic multigrid solver framework
 170
 171   * 210 tutorials with automated run scripts
 172
 173   * Automatic test harness
 174
 175   * Approximately 6000 bug fixes in fundamental level libraries and
 176     discretisation techniques
 177
 178 ** New features in foam-extend-3.1, since foam-extend-3.0
 179   The list of features is a result of the work of numerous
 180   contributors. The maintainers of foam-extend would formally like to
 181   thank them all.
 182
 183   Get a full log of the updates by (either):
 184 #+BEGIN_SRC bash
 185 user@machine> git log 3.0.. > commitLog
 186 #+END_SRC
 187 #+BEGIN_SRC bash
 188     user@machine> git log 3.0.. --oneline > commitLog
 189 #+END_SRC
 190 #+BEGIN_SRC bash
 191     user@machine> gitg 3.0..
 192 #+END_SRC
 193
 194   * Major new features:
 195     - Pressure-based compressible turbo functionalities
 196     - Pressure-based coupled solver (block-coupling p and U)
 197     - Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam
 198     - Major update and validation of mixing plane boundary
 199     - Full deployment of block matrix, including block-AMG solverse
 200     - Further parallel dynamic mesh capability: all topological changes
 201       supported in parallel execution
 202     - Major upgrade of solid mechanics solvers
 203     - Support for CLang-based compilers
 204
 205   * Licence: GPLv3
 206
 207   * Installation:
 208     - Updated and bug-fixed installation procedures
 209     - Removed need for gmake link in Ubuntu
 210     - Scripts for minimizing installation after compilation
 211       - ThirdParty/Allclean alsoPackage - new option
 212       - wcleanAllButLibBinLnInclude
 213     - Fixed problem with ParaView reader for Ubuntu 14.04
 214     - foamToTecplot360: building tecio doesn't require X.org
 215       development files
 216
 217   * Solvers:
 218     - compressible/dbnsFoam
 219     - compressible/dbnsTurbFoam
 220     - compressible/steadyCompressibleFoam
 221     - compressible/steadyCompressibleMRFFoam
 222     - compressible/steadyCompressibleSRFFoam
 223     - coupled/pUCoupledFoam (incl. core library changes)
 224
 225     - Update and cleanup of solvers/solidMechanics
 226     - Update for segregated FEM matrix,
 227       solvers/solidMechanics/stressFemFoam
 228
 229   * Utilities:
 230     - convertPhi (for steadyCompressible solvers)
 231     - foamMeshToElmer, fluent3DMeshToElmer
 232     - transformPoints -cylToCart "origin axis direction" - new option
 233     - blockMesh syntax update (see commit a78b12074)
 234
 235   * Libraries:
 236     - General:
 237       - Added Gauss-Seidel as asymmetric solver
 238       - Block matrix agglomeration (for pUCoupledFoam)
 239       - Block AMG solver
 240       - dbns library (src/dbns)
 241     - Boundary conditions:
 242       - cfdTools/general/SRF/derivedFvPatchFields/SRFFlowRateInletVelocity
 243       - cfdTools/general/SRF/derivedFvPatchFields/SRFSurfaceNormalVelocity
 244       - cfdTools/general/SRF/derivedFvPatchFields/SRFTotalPressure
 245       - cfdTools/general/SRF/derivedFvPatchFields/SRFTotalTemperature
 246       - cfdTools/general/SRF/derivedFvPatchFields/pulseFixedValue
 247       - cfdTools/general/SRF/derivedFvPatchFields/waveTransmissiveInlet
 248       - thermophysicalModels/basic/derivedFvPatchFields/isentropicTotalTemperature
 249       - thermophysicalModels/basic/derivedFvPatchFields/temperatureDirectedInletOutletVelocity
 250       - fvMesh/fvPatches/constraint/mixingPlane
 251     - Turbulence modeling:
 252       - Removed kOmegaSST_lowRe - use standard kOmegaSST
 253
 254   * Tutorial updates (settings, initial conditions, bug fixes etc.):
 255     - incompressible/icoDyMFoam/mixerGgi
 256     - incompressible/icoDyMFoam/movingConeMotion
 257     - incompressible/icoDyMFoam/movingConeTopo
 258     - solidMechanics/elasticNonLinTLSolidFoam/largeStrainCantileverBeam
 259     - solidMechanics/elasticNonLinTLSolidFoam/nonLinBlock
 260     - solidMechanics/elasticNonLinTLSolidFoam/rotateSphereTL
 261     - solidMechanics/elasticThermalSolidFoam/hotCylinder
 262     - solidMechanics/stressFemFoam/plateHole
 263     - Many other updates due to blockMesh syntax update
 264
 265   * New tutorials:
 266     - compressible/dbnsFoam/forwardStep
 267     - compressible/dbnsFoam/shockTube
 268     - compressible/dbnsTurbFoam/naca0012
 269     - compressible/steadyCompressibleFoam/2bump
 270     - compressible/steadyCompressibleFoam/bumpBlockMesh
 271     - compressible/steadyCompressibleFoam/bumpFine05
 272     - compressible/steadyCompressibleMRFFoam/bentRotorStator
 273     - compressible/steadyCompressibleMRFFoam/simpleRotorStator
 274     - compressible/steadyCompressibleSRFFoam/bentBlade
 275     - compressible/steadyCompressibleSRFFoam/simpleBlade
 276     - coupled/pUCoupledFoam/cavity
 277     - incompressible/MRFSimpleFoam/axialTurbine_ggi
 278     - incompressible/MRFSimpleFoam/axialTurbine_mixingPlane
 279     - incompressible/pimpleDyMFoam/axialTurbine
 280     - incompressible/pimpleDyMFoam/movingCylinders
 281     - incompressible/pUCoupledFoam/backwardFacingStepLaminar
 282     - incompressible/pUCoupledFoam/backwardFacingStepTurbulent
 283     - incompressible/pUCoupledFoam/cavity
 284     - incompressible/simpleSRFFoam/axialTurbine
 285     - mesh/moveDynamicMesh/movingCylinders
 286
 287   * Bug fixes:
 288     - Correct snGrad on coupled boundaries
 289     - Handling of static null pointers: safe to dereference
 290     - LinearUpwind no longer hangs in parallel execution on empty patches
 291     - Mesh update on parallel topo changes: zones before boundaries
 292     - GGI interpolation updates on topologically changing meshes
 293     - Cell layering issues off complex surfaces
 294     - Template depth for block matrix support
 295     - Parallel efficiency improvements
 296
 297 ** Recent successful compilations and tests
 298    * Ubuntu 14.04:
 299
 300      http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736
 301
 302    * Ubuntu 12.04:
 303
 304      http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738
 305
 306    * CentOS 6.4:
 307
 308      http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734
 309
 310    * Mac OX X 10.9.3 Maverick & CLang (XCode compiler):
 311
 312      http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733
 313
 314    * Mac OX X & gcc (Macports)
 315
 316      http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737
 317
 318   * Linux PPC ppc64 (Blue Gene)
 319
 320     http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=742
 321
 322   * Red Hat Enterprise Linux Server release 5.2 (Tikanga), Intel CC 11.1
 323
 324     http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743
 325
 326 ** Reporting bugs
 327     To report bugs, please use the MantisBT bugtracker at
 328     http://sourceforge.net/apps/mantisbt/openfoam-extend
 329
 330 ** How to contribute
 331     All your contributions are highly welcome: New solvers, utilities and
 332     models; bug fixes; documentation. The many ways of contributing and the
 333     contribution process are described in detail at:
 334     http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/
 335
 336 ** List of Contributors:
 337     See file ListOfContributors