ReleaseNotes-foam-extend-3.0

   1 #                            -*- mode: org; -*-
   2 #
   3 #+TITLE:          *Release notes for foam-extend-3.0*
   4 #+AUTHOR:                      Hrvoje Jasak.
   5 #+DATE:                       18 December 2013
   6 #+LINK:                  http://foam-extend.org
   7 #+OPTIONS: author:nil
   8
   9 ################################################################################
  10
  11 Contents:
  12 * Overview
  13 * Installation
  14 * Compatibility
  15 * New features in foam-extend-3.0
  16 * Reporting bugs
  17 * How to contribute
  18 * List of Contributors
  19
  20 ################################################################################
  21
  22 * Overview
  23   The foam-extend project is a fork of the OpenFOAM® open source library for
  24   Computational Fluid Dynamics (CFD). It is an open project welcoming and
  25   integrating contributions from all users and developers. Previously known as
  26   OpenFOAM®-dev and OpenFOAM®-extend, it contains bug fixes and performance
  27   improvements, as well as extensions and additional features provided
  28   by community contributors (see list below), such as dynamic mesh and
  29   topological change support, turbomachinery extensions including general grid
  30   interpolation (GGI), cyclic GGI and mixing place, block-coupled matrix
  31   support, finite area method, comprehensive mesh motion capability and GPU
  32   support. For a full list, see below.
  33
  34   Version 3.0, nicknamed "Jeju", is the current version of foam-extend. The
  35   release now continues the tradition and spirit of the original FOAM code
  36   developed by prof. Jasak and Mr. Weller during their time at
  37   Imperial College and released as the general purpose CFD/CCM package by
  38   Nabla Ltd. in 2000. In this spirit, we shall revert to original numbering
  39   scheme (foam-2.3.2, 13 December 2004) as release number 3.0.
  40   Visit http://foam-extend.org for more information.
  41
  42   OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and
  43   foam-extend are a community effort not endorsed by ESI Group.
  44
  45 * Installation
  46     foam-extend-3.0 can be compiled and runs on any linux system and
  47     Apple Mac OS X.
  48
  49     ** From source
  50         Please refer to doc/buildInstructions/ for details. Further
  51         installation instruction are available on the unofficial OpenFOAM Wiki:
  52         http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0
  53         If you have improvements or build instructions for a new system, please
  54         share them with the community (see section "How to contribute", below).
  55
  56     ** Binary packages
  57         Binary packages are available for download at
  58         http://sourceforge.net/projects/openfoam-extend/
  59         for the following systems: Ubuntu 12.04, Ubuntu 13.10 and Fedora 19 .
  60
  61 * Compatibility
  62   Upstream features from the OpenFOAM® code base are merged into foam-extend
  63   on regular basis. The interface format of foam-extend-3.0 is largely
  64   compatible to OpenFOAM-1.6-ext and OpenFOAM-1.7.x. In some cases,
  65   the differences are caused by bug fixes and algorithmic improvements,
  66   considered more important than inter-operability.
  67
  68 * Main diferentiators
  69   A large number of features has been lost within the release cycle of OpenFOAM
  70   code; since version 1.3, the code base has shrunk by more than 40%.  While
  71   we understand the lack of technical ability of supporting advanced
  72   CFD features, we feel that existing features and specifically large-scale
  73   contributions should remain active and developed further. Below is a list
  74   of main features of foam-extend-3.0 which are lost, deactivated or unusable
  75   in ESI releases:
  76
  77     ** Turbomachinery features, including General Grid Interface (GGI),
  78        partial overlap GGI, cyclic GGI, with improvements in parallel scaling.
  79        First full and validated release of a mixing plane stage interface
  80
  81     ** Dynamic mesh with topological changes
  82         sliding interfaces, mesh layering, attach-detach boundaries etc.
  83         in foam-extend-3.0 full parallel support for topological changes
  84         is released for the first time
  85
  86     ** Finite Element Method with support for polyhedral meshes
  87         This is mainly used in mesh deformation and over the last 15 years
  88         it has proven vastly superior to all other dynamic mesh methods.
  89
  90     ** Advanced mesh deformation technology
  91         including tet FEM mesh deformation, Radial Basis Function (RBF) mesh
  92         deformation, tetrahedral remeshing dynamic mesh support and solid body
  93         motion functions.  All of the above include parallelisation support
  94
  95     ** Library of dynamic meshes with topological changes with full
  96        second order FVM discretisation support on moving meshes with
  97        topological changes
  98
  99     ** Internal combustion engine-specific dynamic mesh classes such as
 100        two-stroke engine and various forms of 4-stroke and multi-valve
 101        dynamic mesh classes
 102
 103     ** Finite Area Method providing support for FVM-like discretisation on
 104        a curved surface in 3-D, with examples of liquid film modelling
 105
 106     ** Block-coupled matrix support, allowing fully implicit multi-equation
 107        solution of NxN equation sets, with full parallelisation support.
 108        First release of a block-AMG linear equation solver
 109
 110     ** Fully implicit conjugate-coupled solution framework, allowing implicit
 111        solution fo multiple equations over multiple meshes, with parallelism
 112
 113     ** Proper Orthogonal Decomposition data analysis tools, with applications
 114        to FOAM field classes
 115
 116     ** Equation reader classes and tutorials
 117
 118     ** Multi-solver solution framework, allowing mutiple field models to be
 119        solved in a coupled manner
 120
 121     ** A major contribution is solid mechanics modelling, including linear
 122        and non-linear materials, contact, self-contact and friction, with
 123        updated Lagrangian or absolute Lagrangian formulation.  Solution o
 124        damage models and crack propagation in complex materials via
 125        topological changes
 126
 127     ** CUDA solver release, provided in full source and as an example of
 128        coupling external linear equation solvers with FOAM
 129
 130     ** Library-level support for Immersed Boundary Method and Overset Mesh
 131
 132     ** Major improvements in accuracy and stability of FVM discretisation
 133        with options on convection and diffusion discretisation, deferred
 134        correction or explicit schemes
 135
 136     ** Algebraic multigrid solver framerowk
 137
 138     ** 190 tutorials with automated run scripts
 139
 140     ** Automatic test harness
 141
 142 * New features in foam-extend-3.0
 143   The list of features is a result of the work of numerous contributors. The
 144   maintainers of foam-extend would formally like to thank them all. Features
 145   listed below have are new with regard to OpenFOAM-1.6-ext. For a list of
 146   extension features in OpenFOAM-1.6-ext, please refer to file
 147   "ReleaseNotes-1.6-ext".
 148
 149     ** Core library
 150
 151         cudaSolvers
 152         dynamicMesh
 153             dynamicTopoFvMesh:
 154                 dynamicTopoFvMeshCoupled
 155                 convexSetAlgorithm
 156                 fieldMapping
 157                 meshOpsTemplates
 158             msqAdditionalSrc
 159             tetDecompositionMotionSolver
 160             tetMotionSolver
 161             multiTopoBodyFvMesh
 162         engine
 163             accordionValve
 164             accordionEngineMesh
 165             attachDetachFunctions
 166             deformingEngineMesh
 167             regionSide
 168             twoStrokeEngine
 169         equationReader
 170         finiteArea:
 171             faMeshMapper
 172             faMeshUpdate.C
 173             interpolation:
 174                 mapping
 175         finitVolume:
 176             mixingPlane
 177             regionCouple
 178             adjConvectionSchemes
 179             backwardD2dt2Scheme
 180             skewCorrectedSnGrad
 181             singleCellFvMesh
 182             harmonic
 183                 harmonicTemplates
 184                 magLongDelta.[HC]
 185         multiSolver
 186         OpenFOAM:
 187             PriorityList
 188
 189             IOReferencer
 190             postfixedSubRegistry
 191
 192             symmTensor4thOrder
 193             VectorN
 194             diagTensor
 195             oscillatingFixedValue
 196
 197             profiling
 198
 199             MixingPlaneInterpolation
 200             splineInterpolateXY
 201
 202             BlockAmg solver
 203             blockVectorN solver
 204             BlockLduInterface
 205
 206             mixingPlane (also with GAMG)
 207             regionCouple (also with GAMG)
 208
 209             BlockCoeffNorm
 210
 211         postProcessing:
 212             foamCalcFunctions:
 213                 scalarMult
 214                 componentsTurbo
 215                 domainIntegrate
 216             functionObjects:
 217                 mixingPlaneCheck
 218                 maxFieldCell
 219         solidModels
 220         tetDecompositionFiniteElement
 221         thermophysicalModels:
 222             radiation:
 223                 viewFactor
 224         turbulenceModels:
 225             RWallFunctions
 226         VectorN
 227
 228     ** Solver applications
 229
 230         conjugateHeatSimpleFoam
 231         equationReaderDemo
 232         MRFSimpleFoam
 233         simpleSRFFoam
 234         MRFInterFoam
 235         multiSolver
 236         solidMechanics:
 237             elasticAcpSolidFoam
 238             elasticIncrAcpSolidFoam
 239             elasticIncrSolidFoam
 240             elasticNonLinIncrTLSolidFoam
 241             elasticNonLinTLSolidFoam
 242             elasticNonLinULSolidFoam
 243             elasticOrthoAcpSolidFoam
 244             elasticOrthoNonLinULSolidFoam
 245             elasticOrthoSolidFoam
 246             elasticPlasticSolidFoam
 247             elasticPlasticNonLinTLSolidFoam
 248             elasticPlasticNonLinULSolidFoam
 249             elasticSolidFoam
 250             elasticThermalSolidFoam
 251             icoFsiElasticNonLinULSolidFoam
 252             viscoElasticSolidFoam
 253
 254     ** Utilities
 255
 256         foamMeshToAbaqus
 257         multiSolver (postProcessing)
 258         solidMechanics:
 259             calculateCourantNumber
 260             forceDisp
 261             patchStressIntegrate
 262             smoothMesh
 263             surfaceTractions
 264
 265     ** ThirdParty software
 266         gcc compatibility up to 4.8.1
 267         Updated to:
 268             Paraview 4.1
 269             openmpi 1.6.5
 270             cmake 2.8.12
 271             metis 5.1.0
 272             parmetis 4.0.3
 273             scotch 6.0.0
 274             zoltan 3.6
 275
 276 * Reporting bugs
 277     To report bugs, please use the MantisBT bugtracker at
 278     http://sourceforge.net/apps/mantisbt/openfoam-extend/my_view_page.php .
 279
 280 * How to contribute
 281     All your contributions are highly welcome: New solvers, utilities and
 282     models; bug fixes; documentation. The many ways of contributing and the
 283     contribution process are described in detail in the file "HowToContribute".
 284
 285 * List of Contributors
 286     (If your name is missing in the list, please contact the maintainers at
 287     and it will be added asap.)
 288     Henry Weller
 289     Hrvoje Jasak
 290     Mattijs Janssens
 291     Zeljko Tukovic
 292     Bernhard Gschaider
 293     Tommaso Lucchini
 294     Martin Beaudoin
 295     Sandeep Menon
 296     Niklas Nordin
 297     Eugene De Villiers
 298     Henrik Rusche
 299     Ivor Clifford
 300     Philiposse Rajan
 301     Gavin Tabor
 302     Jovani Favero
 303     Frank Bos
 304     David Hill
 305     Niklas Wikstrom
 306     Dubravko Matijasevic
 307     Darrin Stephens
 308     Christian Beck
 309     Oliver Borm
 310     James Criner
 311     Hua Shan
 312     David Boner
 313     Pierre-Olivier Dallaire
 314     Norman Del Puppo
 315     Dennis Kingsley
 316     Frank Albina
 317     Flavio Galeazzo
 318     Hannes Kroger
 319     Olivier Petit
 320     David Schmidt
 321     Andreas Feymark
 322     Luca Mangani
 323     Daniel Schmode
 324     Christoph Goniva
 325     Takuya Oshima
 326     Juho Peltola
 327     Eric Paterson
 328     Fabian Peng Karrholm
 329     Aleksandar Karac
 330     Maria Garcia Camprubi
 331     Chris Greenshields
 332     Mark Olesen
 333     Hilary Spencer
 334     Andy Heather
 335     Dominik Christ
 336     Peter Janas
 337     Niels Linnemann
 338     Nikola Kornev