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.
 145
 146     ** Core library
 147
 148         cudaSolvers
 149         dynamicMesh
 150             dynamicTopoFvMesh:
 151                 dynamicTopoFvMeshCoupled
 152                 convexSetAlgorithm
 153                 fieldMapping
 154                 meshOpsTemplates
 155             msqAdditionalSrc
 156             tetDecompositionMotionSolver
 157             tetMotionSolver
 158             multiTopoBodyFvMesh
 159         engine
 160             accordionValve
 161             accordionEngineMesh
 162             attachDetachFunctions
 163             deformingEngineMesh
 164             regionSide
 165             twoStrokeEngine
 166         equationReader
 167         finiteArea:
 168             faMeshMapper
 169             faMeshUpdate.C
 170             interpolation:
 171                 mapping
 172         finitVolume:
 173             mixingPlane
 174             regionCouple
 175             adjConvectionSchemes
 176             backwardD2dt2Scheme
 177             skewCorrectedSnGrad
 178             singleCellFvMesh
 179             harmonic
 180                 harmonicTemplates
 181                 magLongDelta.[HC]
 182         multiSolver
 183         OpenFOAM:
 184             PriorityList
 185
 186             IOReferencer
 187             postfixedSubRegistry
 188
 189             symmTensor4thOrder
 190             VectorN
 191             diagTensor
 192             oscillatingFixedValue
 193
 194             profiling
 195
 196             MixingPlaneInterpolation
 197             splineInterpolateXY
 198
 199             BlockAmg solver
 200             blockVectorN solver
 201             BlockLduInterface
 202
 203             mixingPlane (also with GAMG)
 204             regionCouple (also with GAMG)
 205
 206             BlockCoeffNorm
 207
 208         postProcessing:
 209             foamCalcFunctions:
 210                 scalarMult
 211                 componentsTurbo
 212                 domainIntegrate
 213             functionObjects:
 214                 mixingPlaneCheck
 215                 maxFieldCell
 216         solidModels
 217         tetDecompositionFiniteElement
 218         thermophysicalModels:
 219             radiation:
 220                 viewFactor
 221         turbulenceModels:
 222             RWallFunctions
 223         VectorN
 224
 225     ** Solver applications
 226
 227         conjugateHeatSimpleFoam
 228         equationReaderDemo
 229         MRFSimpleFoam
 230         simpleSRFFoam
 231         MRFInterFoam
 232         multiSolver
 233         solidMechanics:
 234             elasticAcpSolidFoam
 235             elasticIncrAcpSolidFoam
 236             elasticIncrSolidFoam
 237             elasticNonLinIncrTLSolidFoam
 238             elasticNonLinTLSolidFoam
 239             elasticNonLinULSolidFoam
 240             elasticOrthoAcpSolidFoam
 241             elasticOrthoNonLinULSolidFoam
 242             elasticOrthoSolidFoam
 243             elasticPlasticSolidFoam
 244             elasticPlasticNonLinTLSolidFoam
 245             elasticPlasticNonLinULSolidFoam
 246             elasticSolidFoam
 247             elasticThermalSolidFoam
 248             icoFsiElasticNonLinULSolidFoam
 249             viscoElasticSolidFoam
 250
 251     ** Utilities
 252
 253         foamMeshToAbaqus
 254         multiSolver (postProcessing)
 255         solidMechanics:
 256             calculateCourantNumber
 257             forceDisp
 258             patchStressIntegrate
 259             smoothMesh
 260             surfaceTractions
 261
 262     ** ThirdParty software
 263         gcc compatibility up to 4.8.1
 264         Updated to:
 265             Paraview 4.1
 266             openmpi 1.6.5
 267             cmake 2.8.12
 268             metis 5.1.0
 269             parmetis 4.0.3
 270             scotch 6.0.0
 271             zoltan 3.6
 272
 273 * Reporting bugs
 274     To report bugs, please use the MantisBT bugtracker at
 275     http://sourceforge.net/apps/mantisbt/openfoam-extend/my_view_page.php .
 276
 277 * How to contribute
 278     All your contributions are highly welcome: New solvers, utilities and
 279     models; bug fixes; documentation. The many ways of contributing and the
 280     contribution process are described in detail in the file "HowToContribute".
 281
 282 * List of Contributors: See file ListOfContributors