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