extendedLduAddressing with arbitrary extension level and extendedLduMatrix classes
[foam-extend-4.0.git] / ReleaseNotes.txt
blob5e3e43eb34392c0fae21ea590d7b4a7197194216
1                  _____________________________________
3                   *RELEASE NOTES FOR FOAM-EXTEND-3.2*
4                  _____________________________________
7                               August 2015
10 Table of Contents
11 _________________
13 1 Overview
14 2 Installation
15 3 Compatibility
16 4 Main differentiators between foam-extend and OpenFOAM
17 5 New features in foam-extend-3.2, since foam-extend-3.1
18 6 Recent successful compilations and tests
19 7 Reporting bugs
20 8 How to contribute
21 9 List of Contributors:
24 ###############################################################################
27 1 Overview
28 ==========
30   The foam-extend project is a fork of the OpenFOAMĀ® open source library
31   for Computational Fluid Dynamics (CFD). It is an open project
32   welcoming and integrating contributions from all users and
33   developers. Previously known as OpenFOAM-dev and OpenFOAM-extend, it
34   contains bug fixes and performance improvements, as well as extensions
35   and additional features provided by community contributors (see file
36   ListOfContributors), such as dynamic mesh and topological change
37   support, turbomachinery extensions including general grid
38   interpolation (GGI), cyclic GGI and mixing plane, block-coupled matrix
39   support, implicitly coupled conjugate heat transfer and other physics
40   coupling, finite area method, comprehensive dynamic mesh (motion and
41   topological changes) capability and GPU support. For a full list, see
42   below and previous release notes at:
43   [http://sourceforge.net/p/openfoam-extend/wiki/Home/]
45   Version 3.2, nicknamed "Ann Arbor", is the current version of
46   foam-extend. The release continues the tradition and spirit of the
47   original FOAM code developed by prof. Jasak and Mr. Weller during
48   their time at Imperial College and released as the general purpose
49   CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted 18
50   December 2013 to the original numbering scheme (foam-2.3.2, 13
51   December 2004) as release number 3.0.  Visit [http://foam-extend.org]
52   for more information.
54   OPENFOAM is a registered trademark of ESI Group. OpenFOAM-extend and
55   foam-extend are a community effort not endorsed by ESI Group.
58 2 Installation
59 ==============
61   foam-extend-3.2 can be compiled and runs on a large variety of Linux,
62   Mac or Windows systems
64   * Main supported OSs:
65     - Ubuntu 14.04
66     - Fedora 20
67     - Mac OS X
68     - Microsoft Windows 7 and 8.1
70   * Compile from source:
72     Please refer to doc/buildInstructions/ for details. Further
73     installation instruction are available on the unofficial OpenFOAM
74     Wiki:
75     [http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.1]
76     If you have improvements or build instructions for a new system,
77     please share them with the community (see section "How to
78     contribute", below).
80   * Download binary packages:
82     Binary packages are available for download at
83     [http://sourceforge.net/projects/openfoam-extend/] for the following
84     systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
86   * Accompanying ThirdParty software:
87     - gcc compatibility up to 4.9.2
88     - bison 2.7
89     - cmake 3.2.2
90     - flex-2.5.35
91     - hwloc 1.10.1
92     - libccmio 2.6.1
93     - mesquite 2.1.2
94     - metis 5.1.0
95     - openmpi 1.6.5
96     - Paraview 4.3.1
97     - parmetis 4.0.3
98     - ParMGridGen 1.0
99     - PyFoam 0.6.4
100     - qt 4.8.6
101     - scotch 6.0.4
102     - swak4Foam 0.3.2
105 3 Compatibility
106 ===============
108   Upstream features from the OpenFOAMĀ® code base are merged into
109   foam-extend on regular basis. The interface format of foam-extend-3.2
110   is largely compatible to foam-extend-3.1, to OpenFOAM-1.6-ext and
111   OpenFOAM-1.7.x. In some cases, the differences are caused by bug fixes
112   and algorithmic improvements, considered more important than
113   inter-operability.
116 4 Main differentiators between foam-extend and OpenFOAM
117 =======================================================
119   A large number of features have been lost within the release of
120   OpenFOAM since version 1.3, the code base has shrunk by more than 40%.
121   While we understand the lack of technical ability of supporting
122   advanced CFD features, we feel that existing features and specifically
123   large-scale contributions should remain active and developed
124   further. Below is a list of main features of foam-extend which are
125   lacking, lost, deactivated or unusable in ESI releases:
127   * Turbomachinery features, including General Grid Interface (GGI),
128     partial overlap GGI, cyclic GGI, with improvements in parallel
129     scaling.  First release of a mixing plane stage interface
131   * Dynamic mesh with topological changes Sliding interfaces, mesh
132     layering, attach-detach boundaries etc.  In foam-extend, full
133     parallel support for topological changes is released for the first
134     time
136   * Finite Element Method with support for polyhedral meshes This is
137     mainly used in mesh deformation and over the last 15 years it has
138     proven vastly superior to all other dynamic mesh methods.
140   * Advanced mesh deformation technology Including tet FEM mesh
141     deformation, Radial Basis Function (RBF) mesh deformation,
142     tetrahedral remeshing dynamic mesh support and solid body motion
143     functions.  All of the above include parallelisation support
145   * Library of dynamic meshes with topological changes with full second
146     order FVM discretisation support on moving meshes with topological
147     changes
149   * Internal combustion engine-specific dynamic mesh classes such as
150     two-stroke engine and various forms of 4-stroke and multi-valve
151     dynamic mesh classes
153   * Finite Area Method providing support for FVM-like discretisation on
154     a curved surface in 3-D, with examples of liquid film modeling
156   * Block-coupled matrix support, allowing fully implicit multi-equation
157     solution of NxN equation sets, with full parallelisation support.
158     First release of a block-AMG linear equation solver
160   * Fully implicit conjugate-coupled solution framework, allowing
161     implicit solution fo multiple equations over multiple meshes, with
162     parallelism
164   * Proper Orthogonal Decomposition data analysis tools, with
165     applications to FOAM field classes
167   * Equation reader classes and tutorials
169   * Multi-solver solution framework, allowing multiple field models to
170     be solved in a coupled manner
172   * A major contribution is solid mechanics modelling, including linear
173     and non-linear materials, contact, self-contact and friction, with
174     updated Lagrangian or absolute Lagrangian formulation.  Solution of
175     damage models and crack propagation in complex materials via
176     topological changes
178   * CUDA solver release, provided in full source and as an example of
179     coupling external linear equation solvers with FOAM
181   * Library-level support for Immersed Boundary Method and Overset Mesh
183   * Major improvements in accuracy and stability of FVM discretisation
184     with options on convection and diffusion discretisation, deferred
185     correction or explicit schemes
187   * Algebraic multigrid solver framework
189   * 243 tutorials with automated run scripts
191   * Automatic test harness
193   * Approximately 6000 bug fixes in fundamental level libraries and
194     discretisation techniques
197 5 New features in foam-extend-3.2, since foam-extend-3.1
198 ========================================================
200   The list of features is a result of the work of numerous
201   contributors. The maintainers of foam-extend would formally like to
202   thank them all.
204   Get a full log of the updates by (either):
205   ,----
206   | user@machine> git log 3.1.. > commitLog
207   `----
208   ,----
209   | user@machine> git log 3.1.. --oneline > commitLog
210   `----
211   ,----
212   | user@machine> gitg 3.1..
213   `----
215   * Major new features:
216     - Immersed Boundary method: full release
217     - Liquid film method, based on finite area infrastructure
218     - Global controlDict switches controlled from command line
219     - Integration of cfMesh automatic mesh solvers
220     - Update to block coupled solvers: Performance, Coupled RAS, MRF
221     - Rewrite of block-coupled matrix assembly and analysis tools
222     - New solver: potentialDyMFoam
223     - Rothalpy in compressible MRF solvers for turbomachinery
224     - Symmetry 2nd order accurate boundary condition
225     - Generation of config files (e.g. csh, tcsh, fishshell, zsh) from
226       bashrc
227     - Overhaul of fvDOM radiation model: symmetry plane and fast
228       convergence
229     - New compilers: GCC new versions, Icc 14 and Icc 16, Clang
230     - Long long support
231     - Long double support
232     - SuperBee01 and SuperBee01DC
233     - wallShearStress also for compressible flow (backport)
234     - Version updates of 3rd Party, PyFOAM, swak4Foam
235     - Extend-bazaar: Added makeAxialMesh
236     - Added limiters on turbulence viscosity
237     - Initial version of block-coupled turbulence models
238     - New ThirdParty app: ParaView server for parallel rendering
240   * Licence: GPLv3
242   * Software
243     - File name changes resolving name clashes on non-case-sensitive
244       filing systems
245     - Unified code base for Windows, Mac OS X and Linux compilation
246     - Parallel execution of automated test loops
248   * Installation:
249     - Native port to Microsoft Windows 7 and 8.1
250     - Updated and bug-fixed installation procedures
251     - Improved ThirdParty packages selection mechanism
253   * Solvers:
254     - potentialDyMFoam
255     - sonicDyMFoam
256     - sonicFoamAutoMotion
257     - MRFPorousFoam
258     - liquidFilmFoam
259     - surfactantFoam
260     - icoIbFoam
261     - interIbFoam
262     - porousSimpleIbFoam
263     - potentialIbFoam
264     - simpleIbFoam
266   * New tutorials:
267     - Mesquite mesh movement
268     - Immersed boundary method
269     - Liquid film examples
271   * Bug fixes: see git log for details
274 6 Recent successful compilations and tests
275 ==========================================
277   * CentOS 6.6:
279     [http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=49]
280     [http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=48]
282   * Ubuntu 14.04
284     [http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=47]
286   * Mac OS X 10.10
288     [http://foam-extend.sourceforge.net/CDash/buildSummary.php?buildid=46]
291 7 Reporting bugs
292 ================
294   To report bugs, please use the bugtracker at
295   [http://sourceforge.net/p/openfoam-extend/ticketsfoamextendrelease/]
298 8 How to contribute
299 ===================
301   All your contributions are highly welcome: New solvers, utilities and
302   models; bug fixes; documentation. The many ways of contributing and
303   the contribution process are described in detail at:
304   [http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/]
307 9 List of Contributors:
308 =======================
310   See file ListOfContributors