ReleaseNotes

   1 #                            -*- mode: org; -*-
   2 #
   3 #+TITLE:             *Release notes for foam-extend-3.2*
   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:                          August 2015
  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 physics 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.2, nicknamed "Ann Arbor", 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
  49 ** Installation
  50    foam-extend-3.2 can be compiled and runs on a large variety of Linux, Mac or Windows
  51    systems
  52
  53   * Main supported OSs:
  54     - Ubuntu 14.04
  55     - Fedora 20
  56     - Mac OS X
  57     - Microsoft Windows 7 and 8.1
  58
  59   * Compile from source:
  60
  61     Please refer to doc/buildInstructions/ for details. Further
  62     installation instruction are available on the unofficial OpenFOAM
  63     Wiki:
  64     http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.1
  65     If you have improvements or build instructions for a new system,
  66     please share them with the community (see section "How to
  67     contribute", below).
  68
  69   * Download binary packages:
  70
  71     Binary packages are available for download at
  72     http://sourceforge.net/projects/openfoam-extend/ for the following
  73     systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
  74
  75   * Accompanying ThirdParty software:
  76     - gcc compatibility up to 4.9.2
  77     - bison 2.7
  78     - cmake 3.2.2
  79     - flex-2.5.35
  80     - hwloc 1.10.1
  81     - libccmio 2.6.1
  82     - mesquite 2.1.2
  83     - metis 5.1.0
  84     - openmpi 1.6.5
  85     - Paraview 4.3.1
  86     - parmetis 4.0.3
  87     - ParMGridGen 1.0
  88     - PyFoam 0.6.4
  89     - qt 4.8.6
  90     - scotch 6.0.4
  91     - swak4Foam 0.3.2
  92
  93
  94 ** Compatibility
  95   Upstream features from the OpenFOAM® code base are merged into
  96   foam-extend on regular basis. The interface format of
  97   foam-extend-3.2 is largely compatible to foam-extend-3.1, to
  98   OpenFOAM-1.6-ext and OpenFOAM-1.7.x. In some cases, the
  99   differences are caused by bug fixes and algorithmic improvements,
 100   considered more important than inter-operability.
 101
 102 ** Main differentiators between foam-extend and OpenFOAM
 103   A large number of features have been lost within the release of
 104   OpenFOAM since version 1.3, the code base has shrunk by more than
 105   40%.  While we understand the lack of technical ability of
 106   supporting advanced CFD features, we feel that existing features and
 107   specifically large-scale contributions should remain active and
 108   developed further. Below is a list of main features of foam-extend
 109   which are lacking, lost, deactivated or unusable in ESI releases:
 110
 111   * Turbomachinery features, including General Grid Interface (GGI),
 112     partial overlap GGI, cyclic GGI, with improvements in parallel
 113     scaling.  First release of a mixing plane stage interface
 114
 115   * Dynamic mesh with topological changes Sliding interfaces, mesh
 116     layering, attach-detach boundaries etc.  In foam-extend, full
 117     parallel support for topological changes is released for the first
 118     time
 119
 120   * Finite Element Method with support for polyhedral meshes This is
 121     mainly used in mesh deformation and over the last 15 years it has
 122     proven vastly superior to all other dynamic mesh methods.
 123
 124   * Advanced mesh deformation technology Including tet FEM mesh
 125     deformation, Radial Basis Function (RBF) mesh deformation,
 126     tetrahedral remeshing dynamic mesh support and solid body motion
 127     functions.  All of the above include parallelisation support
 128
 129   * Library of dynamic meshes with topological changes with full
 130     second order FVM discretisation support on moving meshes with
 131     topological changes
 132
 133   * Internal combustion engine-specific dynamic mesh classes such as
 134     two-stroke engine and various forms of 4-stroke and multi-valve
 135     dynamic mesh classes
 136
 137   * Finite Area Method providing support for FVM-like discretisation
 138     on a curved surface in 3-D, with examples of liquid film modeling
 139
 140   * Block-coupled matrix support, allowing fully implicit
 141     multi-equation solution of NxN equation sets, with full
 142     parallelisation support.  First release of a block-AMG linear
 143     equation solver
 144
 145   * Fully implicit conjugate-coupled solution framework, allowing
 146     implicit solution fo multiple equations over multiple meshes, with
 147     parallelism
 148
 149   * Proper Orthogonal Decomposition data analysis tools, with
 150     applications to FOAM field classes
 151
 152   * Equation reader classes and tutorials
 153
 154   * Multi-solver solution framework, allowing multiple field models to
 155     be solved in a coupled manner
 156
 157   * A major contribution is solid mechanics modelling, including
 158     linear and non-linear materials, contact, self-contact and
 159     friction, with updated Lagrangian or absolute Lagrangian
 160     formulation.  Solution of damage models and crack propagation in
 161     complex materials via topological changes
 162
 163   * CUDA solver release, provided in full source and as an example of
 164     coupling external linear equation solvers with FOAM
 165
 166   * Library-level support for Immersed Boundary Method and Overset
 167     Mesh
 168
 169   * Major improvements in accuracy and stability of FVM discretisation
 170     with options on convection and diffusion discretisation, deferred
 171     correction or explicit schemes
 172
 173   * Algebraic multigrid solver framework
 174
 175   * 243 tutorials with automated run scripts
 176
 177   * Automatic test harness
 178
 179   * Approximately 6000 bug fixes in fundamental level libraries and
 180     discretisation techniques
 181
 182 ** New features in foam-extend-3.2, since foam-extend-3.1
 183   The list of features is a result of the work of numerous
 184   contributors. The maintainers of foam-extend would formally like to
 185   thank them all.
 186
 187   Get a full log of the updates by (either):
 188 #+BEGIN_SRC bash
 189     user@machine> git log 3.1.. > commitLog
 190 #+END_SRC
 191 #+BEGIN_SRC bash
 192     user@machine> git log 3.1.. --oneline > commitLog
 193 #+END_SRC
 194 #+BEGIN_SRC bash
 195     user@machine> gitg 3.1..
 196 #+END_SRC
 197
 198   * Major new features:
 199     - Immersed Boundary method: full release
 200     - Liquid film method, based on finite area infrastructure
 201     - Global controlDict switches controlled from command line
 202     - Integration of cfMesh automatic mesh solvers
 203     - Update to block coupled solvers: Performance, Coupled RAS, MRF
 204     - Rewrite of block-coupled matrix assembly and analysis tools
 205     - New solver: potentialDyMFoam
 206     - Rothalpy in compressible MRF solvers for turbomachinery
 207     - Symmetry 2nd order accurate boundary condition
 208     - Generation of config files (e.g. csh, tcsh, fishshell, zsh) from bashrc
 209     - Overhaul of fvDOM radiation model: symmetry plane and fast convergence
 210     - New compilers: GCC new versions, Icc 14 and Icc 16, Clang
 211     - Long long support
 212     - Long double support
 213     - SuperBee01 and SuperBee01DC
 214     - wallShearStress also for compressible flow (backport)
 215     - Version updates of 3rd Party, PyFOAM, swak4Foam
 216     - Extend-bazaar: Added makeAxialMesh
 217     - Added limiters on turbulence viscosity
 218     - Initial version of block-coupled turbulence models
 219     - New ThirdParty app: ParaView server for parallel rendering
 220
 221   * Licence: GPLv3
 222
 223   * Software
 224     - File name changes resolving name clashes on non-case-sensitive filing
 225       systems
 226     - Unified code base for Windows, Mac OS X and Linux compilation
 227     - Parallel execution of automated test loops
 228
 229   * Installation:
 230     - Native port to Microsoft Windows 7 and 8.1
 231     - Updated and bug-fixed installation procedures
 232     - Improved ThirdParty packages selection mechanism
 233
 234   * Solvers:
 235     - potentialDyMFoam
 236     - sonicDyMFoam
 237     - sonicFoamAutoMotion
 238     - MRFPorousFoam
 239     - liquidFilmFoam
 240     - surfactantFoam
 241     - icoIbFoam
 242     - interIbFoam
 243     - porousSimpleIbFoam
 244     - potentialIbFoam
 245     - simpleIbFoam
 246
 247   * New tutorials:
 248     - Mesquite mesh movement
 249     - Immersed boundary method
 250     - Liquid film examples
 251
 252   * Bug fixes: see git log for details
 253
 254 ** Recent successful compilations and tests
 255    * CentOS 6.6:
 256
 257      http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=49
 258      http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=48
 259
 260    * Ubuntu 14.04
 261
 262      http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=47
 263
 264    * Mac OS X 10.10
 265
 266     http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=46
 267
 268 ** Reporting bugs
 269     To report bugs, please use the bugtracker at
 270     http://sourceforge.net/p/openfoam-extend/ticketsfoamextendrelease/
 271
 272 ** How to contribute
 273     All your contributions are highly welcome: New solvers, utilities and
 274     models; bug fixes; documentation. The many ways of contributing and the
 275     contribution process are described in detail at:
 276     http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/
 277
 278 ** List of Contributors:
 279     See file ListOfContributors