diff --git a/HowToContribute b/HowToContribute deleted file mode 100644 index 0f17f5b6c..000000000 --- a/HowToContribute +++ /dev/null @@ -1,45 +0,0 @@ -Guide to contribute code to OpenFOAM-extend project - -You have developed a new top-level solver or utility. You have implemented a further turbulence model, interface to a material properties library or created a really useful boundary condition? This guide shows the ways to share this code with the OpenFOAM® communinity. - - -Why should I share my code? - -Depending on your background, motivations for contributing code to OpenFOAM® via the FOAM-extend project will differ. - -With an industrial background you may find it a cost-advantage compared to keeping everything in-house. Code contributed to the source-core will be maintained along with the complete project source code. This saves you the cost of porting your code to each new release. Furthermore, your code will be reviewed by experts with relevant OpenFOAM® experience, who will be able to spot design improvements that lead to increased speed of execution, better convergence, improved robustness, stability or all of the above. If you plan to deploy your code to clients, the extend-bazaar gives you a unified platform that is simple to use, easy to access and gives you maximum freedom in presenting your code. - -In academia, many OpenFOAM® developments are carried out within publicly funded projects, often as part of PhD studies. Unfortunately, much of this work is not re-used and developed further. A time-saving option to share this work is the extend-bazaar, where working code and example cases can be simply uploaded with a brief description. This can be expanded and may even form the base for a journal publication; a good example for this is the waves2Foam package by Niels Jacobsen LINK. Contributing gives the code visibility in the OpenFOAM® community and harvests public recognition long after the project has been completed. - -In both cases, the credit for your work, its authorship, and Copyright remains with you. We do not require contributors to give up the rights to their work. - -What is the difference between contibuting to source-core and to extend-bazaar? - -The \BOLD{source-core} of FOAM-extend meets the high quality standards of a software package that is deployed for production use. A contribution will be therefore reviewed by an experiened OpenFOAM®-extend maintainer. The code must adhere to OpenFOAM® coding style guideline LINK. The contribution procedure is: -* Check your code, especially regarding coding style and trailing whitespace -* Contact the maintainers of FOAM-extend repository to get write access , ???@???.org. -* Use git to make a local feature branch, move your contribution into this branch and push the branch to the repository. See details of the FOAM-extend branching model LINK and git usage LINK. -* Contact the maintainers and ask for review and merge of your code. Experience shows this involves a few iterative steps. -* Your code is merged and becomes part of FOAM-extend. You are added to the list of contributors FOAM-extend. -* Maintainance of your case is now part of the general development - -The \BOLD{extend-bazaar} has been created to minimize the effort for sharing your code. It is ideal for solvers and utilities that can live in the user-directory. The required steps are: - -* Create a user account on the OpenFOAM® Wiki. -* Go to the extend-bazaar page and find a category for your contribution. -* Create a new sub-page in the category and write a brief description/documentation for your contribution. Templates LINK exist that you can re-use. -* Upload your code. Options are: - * For small packages that will not change much in the future, you can upload a .tgz archive to your wiki page directly. - * For larger packages that contain for example big meshes, use a file-hoster and add a link to your wiki page. - * If your contribution is under active development, create a repository for example on sourceforge LINK or github LINK. Add a link to the repository on the wiki page. -* Implementing bug fixes, new features or ports to a new FOAM-extend release is at your discretion - - - - - - - - - -http://www.openfoam.org/contrib/code-style.php diff --git a/ReleaseNotes b/ReleaseNotes index 1e5b40ee8..c3e5169dd 100644 --- a/ReleaseNotes +++ b/ReleaseNotes @@ -195,12 +195,12 @@ user@machine> git log 3.0.. > commitLog - Pressure-based compressible turbo functionalities - Pressure-based coupled solver (block-coupling p and U) - Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam - - major update and validation of mixing plane boundary - - full deploymenr of block matrix, including block-AMG solverse - - further parallel dynamic mesh capability: all topological changes + - Major update and validation of mixing plane boundary + - Full deploymenr of block matrix, including block-AMG solverse + - Further parallel dynamic mesh capability: all topological changes supported in parallel execution - - major upgrade of solid mechanics solvers - - support for CLang-based compilers + - Major upgrade of solid mechanics solvers + - Support for CLang-based compilers * Licence: GPLv3 @@ -286,15 +286,15 @@ user@machine> git log 3.0.. > commitLog * Bug fixes: - Correct snGrad on coupled boundaries - - handling of static null pointers: safe to dereference + - Handling of static null pointers: safe to dereference - LinearUpwind no longer hangs in parallel execution on empty patches - - mesh update on parallel topo changes: zones before boundaries + - Mesh update on parallel topo changes: zones before boundaries - GGI interpolation updates on topologically changing meshes - - cell layering issues off complex surfaces - - template depth for block matrix support - - parallel efficiency improvements + - Cell layering issues off complex surfaces + - Template depth for block matrix support + - Parallel efficiency improvements -** Recent sucessful compilations and tests +** Recent successful compilations and tests * Ubuntu 14.04: http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736 @@ -330,8 +330,8 @@ user@machine> git log 3.0.. > commitLog ** How to contribute All your contributions are highly welcome: New solvers, utilities and models; bug fixes; documentation. The many ways of contributing and the - contribution process are described in detail in the file "HowToContribute" - and at http://sourceforge.net/p/openfoam-extend/wiki/Home/ + contribution process are described in detail at: + http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/ ** List of Contributors: See file ListOfContributors diff --git a/ReleaseNotes.html b/ReleaseNotes.html index 9f4647a40..762231e89 100644 --- a/ReleaseNotes.html +++ b/ReleaseNotes.html @@ -1,88 +1,63 @@ + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <b>Release notes for foam-extend-3.1</b> - - - + + + + + + + + + +
+ +
+

Release notes for foam-extend-3.1

+ +

################################################################################ +

+

Table of Contents

-

-################################################################################ -

-
-

1 Overview

-
-

-The foam-extend project is a fork of the OpenFOAM® open source -library for Computational Fluid Dynamics (CFD). It is an open -project welcoming and integrating contributions from all users and -developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend, -it contains bug fixes and performance improvements, as well as -extensions and additional features provided by community -contributors (see file ListOfContributors), such as dynamic mesh and -topological change support, turbomachinery extensions including -general grid interpolation (GGI), cyclic GGI and mixing plane, -block-coupled matrix support, implicitly coupled conjugate heat -transfer and other pyshics coupling, finite area method, -comprehensive dynamic mesh (motion and topological changes) -capability and GPU support. For a full list, see below and previous -release notes at: -http://sourceforge.net/p/openfoam-extend/wiki/Home/ -

+
+

1 Overview

+
-

-Version 3.1, nicknamed "Zagreb", is the current version of -foam-extend. The release continues the tradition and spirit of the -original FOAM code developed by prof. Jasak and Mr. Weller during -their time at Imperial College and released as the general purpose -CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted -18 December 2013 to the original numbering scheme (foam-2.3.2, 13 -December 2004) as release number 3.0. Visit http://foam-extend.org -for more information. +

The foam-extend project is a fork of the OpenFOAM® open source + library for Computational Fluid Dynamics (CFD). It is an open + project welcoming and integrating contributions from all users and + developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend, + it contains bug fixes and performance improvements, as well as + extensions and additional features provided by community + contributors (see file ListOfContributors), such as dynamic mesh and + topological change support, turbomachinery extensions including + general grid interpolation (GGI), cyclic GGI and mixing plane, + block-coupled matrix support, implicitly coupled conjugate heat + transfer and other pyshics coupling, finite area method, + comprehensive dynamic mesh (motion and topological changes) + capability and GPU support. For a full list, see below and previous + release notes at: + http://sourceforge.net/p/openfoam-extend/wiki/Home/

-

-OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and -foam-extend are a community effort not endorsed by ESI Group. + Version 3.1, nicknamed "Zagreb", is the current version of + foam-extend. The release continues the tradition and spirit of the + original FOAM code developed by prof. Jasak and Mr. Weller during + their time at Imperial College and released as the general purpose + CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted + 18 December 2013 to the original numbering scheme (foam-2.3.2, 13 + December 2004) as release number 3.0. Visit http://foam-extend.org + for more information. +

+

+ OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and + foam-extend are a community effort not endorsed by ESI Group.

-
-
-

2 Installation

-
-

-foam-extend-3.1 can be compiled and runs on any linux system -

-
    +
+ +
+

2 Installation

+
+ +

foam-extend-3.1 can be compiled and runs on any linux system +

+
  • Main supported OSs: -
      +
      • Ubuntu 14.04
      • Fedora 20
      • Mac OS X +
      - +
    • Compile from source:

      -Please refer to doc/buildInstructions/ for details. Further -installation instruction are available on the unofficial OpenFOAM -Wiki: -http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0 -If you have improvements or build instructions for a new system, -please share them with the community (see section "How to -contribute", below). + Please refer to doc/buildInstructions/ for details. Further + installation instruction are available on the unofficial OpenFOAM + Wiki: + http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0 + If you have improvements or build instructions for a new system, + please share them with the community (see section "How to + contribute", below).

      • -
    • Download binary packages:

      -Binary packages are available for download at -http://sourceforge.net/projects/openfoam-extend/ for the following -systems: Ubuntu 14.04, Fedora 20 and Mac OS X. + Binary packages are available for download at + http://sourceforge.net/projects/openfoam-extend/ for the following + systems: Ubuntu 14.04, Fedora 20 and Mac OS X.

      • -
    • Accompanying ThirdParty software: -
        +
        • gcc compatibility up to 4.8.2
        • Paraview 4.0.1 @@ -269,208 +249,218 @@ systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
        • libccmio 2.6.1
        +
      -
-
-
-

3 Compatibility

-
-

-Upstream features from the OpenFOAM® code base are merged into -foam-extend on regular basis. The interface format of -foam-extend-3.1 is largely compatible to OpenFOAM-1.6-ext and -OpenFOAM-1.7.x. In some cases, the differences are caused by bug -fixes and algorithmic improvements, considered more important than -inter-operability. -

-
-
-
-

4 Main differentiators between foam-extend and OpenFOAM

-
-

-A large number of features have been lost within the release of -OpenFOAM since version 1.3, the code base has shrunk by more than -40%. While we understand the lack of technical ability of -supporting advanced CFD features, we feel that existing features and -specifically large-scale contributions should remain active and -developed further. Below is a list of main features of foam-extend -which are lacking, lost, deactivated or unusable in ESI releases: -

-
    + +
+ +
+ +
+

3 Compatibility

+
+ +

Upstream features from the OpenFOAM® code base are merged into + foam-extend on regular basis. The interface format of + foam-extend-3.1 is largely compatible to OpenFOAM-1.6-ext and + OpenFOAM-1.7.x. In some cases, the differences are caused by bug + fixes and algorithmic improvements, considered more important than + inter-operability. +

+
+ +
+ +
+

4 Main differentiators between foam-extend and OpenFOAM

+
+ +

A large number of features have been lost within the release of + OpenFOAM since version 1.3, the code base has shrunk by more than + 40%. While we understand the lack of technical ability of + supporting advanced CFD features, we feel that existing features and + specifically large-scale contributions should remain active and + developed further. Below is a list of main features of foam-extend + which are lacking, lost, deactivated or unusable in ESI releases: +

+
  • Turbomachinery features, including General Grid Interface (GGI), -partial overlap GGI, cyclic GGI, with improvements in parallel -scaling. First release of a mixing plane stage interface -
    • + partial overlap GGI, cyclic GGI, with improvements in parallel + scaling. First release of a mixing plane stage interface +
  • Dynamic mesh with topological changes Sliding interfaces, mesh -layering, attach-detach boundaries etc. In foam-extend, full -parallel support for topological changes is released for the first -time -
    • + layering, attach-detach boundaries etc. In foam-extend, full + parallel support for topological changes is released for the first + time +
  • Finite Element Method with support for polyhedral meshes This is -mainly used in mesh deformation and over the last 15 years it has -proven vastly superior to all other dynamic mesh methods. -
    • + mainly used in mesh deformation and over the last 15 years it has + proven vastly superior to all other dynamic mesh methods. +
  • Advanced mesh deformation technology Including tet FEM mesh -deformation, Radial Basis Function (RBF) mesh deformation, -tetrahedral remeshing dynamic mesh support and solid body motion -functions. All of the above include parallelisation support -
    • + deformation, Radial Basis Function (RBF) mesh deformation, + tetrahedral remeshing dynamic mesh support and solid body motion + functions. All of the above include parallelisation support +
  • Library of dynamic meshes with topological changes with full -second order FVM discretisation support on moving meshes with -topological changes -
    • + second order FVM discretisation support on moving meshes with + topological changes +
  • Internal combustion engine-specific dynamic mesh classes such as -two-stroke engine and various forms of 4-stroke and multi-valve -dynamic mesh classes -
    • + two-stroke engine and various forms of 4-stroke and multi-valve + dynamic mesh classes +
  • Finite Area Method providing support for FVM-like discretisation -on a curved surface in 3-D, with examples of liquid film modelling -
    • + on a curved surface in 3-D, with examples of liquid film modelling +
  • Block-coupled matrix support, allowing fully implicit -multi-equation solution of NxN equation sets, with full -parallelisation support. First release of a block-AMG linear -equation solver -
    • + multi-equation solution of NxN equation sets, with full + parallelisation support. First release of a block-AMG linear + equation solver +
  • Fully implicit conjugate-coupled solution framework, allowing -implicit solution fo multiple equations over multiple meshes, with -parallelism -
    • + implicit solution fo multiple equations over multiple meshes, with + parallelism +
  • Proper Orthogonal Decomposition data analysis tools, with -applications to FOAM field classes -
    • + applications to FOAM field classes +
  • Equation reader classes and tutorials -
    • +
  • Multi-solver solution framework, allowing multiple field models to -be solved in a coupled manner -
    • + be solved in a coupled manner +
  • A major contribution is solid mechanics modelling, including -linear and non-linear materials, contact, self-contact and -friction, with updated Lagrangian or absolute Lagrangian -formulation. Solution of damage models and crack propagation in -complex materials via topological changes -
    • + linear and non-linear materials, contact, self-contact and + friction, with updated Lagrangian or absolute Lagrangian + formulation. Solution of damage models and crack propagation in + complex materials via topological changes +
  • CUDA solver release, provided in full source and as an example of -coupling external linear equation solvers with FOAM -
    • + coupling external linear equation solvers with FOAM +
  • Library-level support for Immersed Boundary Method and Overset -Mesh -
    • + Mesh +
  • Major improvements in accuracy and stability of FVM discretisation -with options on convection and diffusion discretisation, deferred -correction or explicit schemes -
    • + with options on convection and diffusion discretisation, deferred + correction or explicit schemes +
  • Algebraic multigrid solver framework -
    • +
  • 210 tutorials with automated run scripts -
    • +
  • Automatic test harness -
    • +
  • Approximately 6000 bug fixes in fundamental level libraries and -discretisation techniques + discretisation techniques
+ +
+
-
-

5 New features in foam-extend-3.1, since foam-extend-3.0

-
+ +
+

5 New features in foam-extend-3.1, since foam-extend-3.0

+
+ +

The list of features is a result of the work of numerous + contributors. The maintainers of foam-extend would formally like to + thank them all. +

-The list of features is a result of the work of numerous -contributors. The maintainers of foam-extend would formally like to -thank them all. + Get a full log of the updates by (either):

-

-Get a full log of the updates by (either): -

-
-
user@machine> git log 3.0.. > commitLog
+
user@machine> git log 3.0.. > commitLog
 

-
-
-
user@machine> git log 3.0.. --oneline > commitLog
+
+
user@machine> git log 3.0.. --oneline > commitLog
 

-
-
-
user@machine> gitg 3.0..
+
+
user@machine> gitg 3.0..
 

-
-
    + +
    • Major new features: -
        +
        • Pressure-based compressible turbo functionalities
        • Pressure-based coupled solver (block-coupling p and U)
        • Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam
          • -
        • major update and validation of mixing plane boundary +
        • Major update and validation of mixing plane boundary
          • -
        • full deploymenr of block matrix, including block-AMG solverse +
        • Full deploymenr of block matrix, including block-AMG solverse
          • -
        • further parallel dynamic mesh capability: all topological changes -supported in parallel execution +
        • Further parallel dynamic mesh capability: all topological changes + supported in parallel execution
          • -
        • major upgrade of solid mechanics solvers +
        • Major upgrade of solid mechanics solvers
          • -
        • support for CLang-based compilers +
        • Support for CLang-based compilers +
        - +
      • Licence: GPLv3 -
        • +
      • Installation: -
          +
          • Updated and bug-fixed installation procedures
          • Removed need for gmake link in Ubuntu
          • Scripts for minimizing installation after compilation -
              +
              • ThirdParty/Allclean alsoPackage - new option
              • wcleanAllButLibBinLnInclude
              +
            • Fixed problem with ParaView reader for Ubuntu 14.04
            • foamToTecplot360: building tecio doesn't require X.org -development files + development files +
            -
            • +
          • Solvers: -
              +
              • compressible/dbnsFoam
              • compressible/dbnsTurbFoam @@ -482,18 +472,19 @@ development files
              • compressible/steadyCompressibleSRFFoam
              • coupled/pUCoupledFoam (incl. core library changes) -
                • +
              • Update and cleanup of solvers/solidMechanics
              • Update for segregated FEM matrix, -solvers/solidMechanics/stressFemFoam + solvers/solidMechanics/stressFemFoam +
              - +
            • Utilities: -
                +
                • convertPhi (for steadyCompressible solvers)
                • foamMeshToElmer, fluent3DMeshToElmer @@ -501,14 +492,15 @@ solvers/solidMechanics/stressFemFoam
                • transformPoints -cylToCart "origin axis direction" - new option
                • blockMesh syntax update (see commit a78b12074) +
                - +
              • Libraries: -
                  +
                  • General: -
                      +
                      • Added Gauss-Seidel as asymmetric solver
                      • Block matrix agglomeration (for pUCoupledFoam) @@ -518,9 +510,10 @@ solvers/solidMechanics/stressFemFoam
                      • dbns library (src/dbns)
                      +
                    • Boundary conditions: -
                        +
                        • cfdTools/general/SRF/derivedFvPatchFields/SRFFlowRateInletVelocity
                        • cfdTools/general/SRF/derivedFvPatchFields/SRFSurfaceNormalVelocity @@ -540,18 +533,21 @@ solvers/solidMechanics/stressFemFoam
                        • fvMesh/fvPatches/constraint/mixingPlane
                        +
                      • Turbulence modeling: -
                          +
                          • Removed kOmegaSST_lowRe - use standard kOmegaSST -
                            • -
                          - -
                        -
                        • + +
                      + +
                      • +
                    + +
                  • Tutorial updates (settings, initial conditions, bug fixes etc.): -
                      +
                      • incompressible/icoDyMFoam/mixerGgi
                      • incompressible/icoDyMFoam/movingConeMotion @@ -569,12 +565,13 @@ solvers/solidMechanics/stressFemFoam
                      • solidMechanics/stressFemFoam/plateHole
                      • Many other updates due to blockMesh syntax update +
                      - +
                    • New tutorials: -
                        +
                        • compressible/dbnsFoam/forwardStep
                        • compressible/dbnsFoam/shockTube @@ -614,122 +611,130 @@ solvers/solidMechanics/stressFemFoam
                        • incompressible/simpleSRFFoam/axialTurbine
                        • mesh/moveDynamicMesh/movingCylinders +
                        - +
                      • Bug fixes: -
                          +
                          • Correct snGrad on coupled boundaries
                            • -
                          • handling of static null pointers: safe to dereference +
                          • Handling of static null pointers: safe to dereference
                          • LinearUpwind no longer hangs in parallel execution on empty patches
                            • -
                          • mesh update on parallel topo changes: zones before boundaries +
                          • Mesh update on parallel topo changes: zones before boundaries
                          • GGI interpolation updates on topologically changing meshes
                            • -
                          • cell layering issues off complex surfaces +
                          • Cell layering issues off complex surfaces
                            • -
                          • template depth for block matrix support +
                          • Template depth for block matrix support
                            • -
                          • parallel efficiency improvements +
                          • Parallel efficiency improvements
                          +
                        + +
+
-
-

6 Recent sucessful compilations and tests

-
-
    + + -
    -

    7 Reporting bugs

    -
    -

    -To report bugs, please use the MantisBT bugtracker at -http://sourceforge.net/apps/mantisbt/openfoam-extend + +

    +

    7 Reporting bugs

    +
    + +

    To report bugs, please use the MantisBT bugtracker at + http://sourceforge.net/apps/mantisbt/openfoam-extend

    +
    -
    -

    8 How to contribute

    -
    -

    -All your contributions are highly welcome: New solvers, utilities and -models; bug fixes; documentation. The many ways of contributing and the -contribution process are described in detail in the file "HowToContribute" -and at http://sourceforge.net/p/openfoam-extend/wiki/Home/ + +

    +

    8 How to contribute

    +
    + +

    All your contributions are highly welcome: New solvers, utilities and + models; bug fixes; documentation. The many ways of contributing and the + contribution process are described in detail at: + http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/

    +
    -
    -

    9 List of Contributors:

    -
    -

    -See file ListOfContributors -

    + +
    +

    9 List of Contributors:

    +
    + +

    See file ListOfContributors +

    -
    -
    + +

    Date: 8 June 2014

    -

    Created: 2014-06-16 Mon 16:40

    -

    Emacs 24.3.1 (Org mode 8.2.4)

    -

    Validate

    +

    Org version 7.9.3f with Emacs version 24

    +Validate XHTML 1.0 +
    diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt index fbe6c5a78..3ebf6252e 100644 --- a/ReleaseNotes.txt +++ b/ReleaseNotes.txt @@ -1,64 +1,58 @@ - _____________________________________ + *Release notes for foam-extend-3.1* + =================================== - *RELEASE NOTES FOR FOAM-EXTEND-3.1* - _____________________________________ +Date: 8 June 2014 - 8 June 2014 - +################################################################################ Table of Contents -_________________ - +================= 1 Overview 2 Installation 3 Compatibility 4 Main differentiators between foam-extend and OpenFOAM 5 New features in foam-extend-3.1, since foam-extend-3.0 -6 Recent sucessful compilations and tests +6 Recent successful compilations and tests 7 Reporting bugs 8 How to contribute 9 List of Contributors: -################################################################################ - - -1 Overview -========== - - The foam-extend project is a fork of the OpenFOAM® open source library - for Computational Fluid Dynamics (CFD). It is an open project - welcoming and integrating contributions from all users and - developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend, it - contains bug fixes and performance improvements, as well as extensions - and additional features provided by community contributors (see file - ListOfContributors), such as dynamic mesh and topological change - support, turbomachinery extensions including general grid - interpolation (GGI), cyclic GGI and mixing plane, block-coupled matrix - support, implicitly coupled conjugate heat transfer and other pyshics - coupling, finite area method, comprehensive dynamic mesh (motion and - topological changes) capability and GPU support. For a full list, see - below and previous release notes at: +1 Overview +----------- + The foam-extend project is a fork of the OpenFOAM® open source + library for Computational Fluid Dynamics (CFD). It is an open + project welcoming and integrating contributions from all users and + developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend, + it contains bug fixes and performance improvements, as well as + extensions and additional features provided by community + contributors (see file ListOfContributors), such as dynamic mesh and + topological change support, turbomachinery extensions including + general grid interpolation (GGI), cyclic GGI and mixing plane, + block-coupled matrix support, implicitly coupled conjugate heat + transfer and other pyshics coupling, finite area method, + comprehensive dynamic mesh (motion and topological changes) + capability and GPU support. For a full list, see below and previous + release notes at: [http://sourceforge.net/p/openfoam-extend/wiki/Home/] Version 3.1, nicknamed "Zagreb", is the current version of foam-extend. The release continues the tradition and spirit of the original FOAM code developed by prof. Jasak and Mr. Weller during their time at Imperial College and released as the general purpose - CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted 18 - December 2013 to the original numbering scheme (foam-2.3.2, 13 + CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted + 18 December 2013 to the original numbering scheme (foam-2.3.2, 13 December 2004) as release number 3.0. Visit [http://foam-extend.org] for more information. - OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and + OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and foam-extend are a community effort not endorsed by ESI Group. + - -2 Installation -============== - - foam-extend-3.1 can be compiled and runs on any linux system +2 Installation +--------------- + foam-extend-3.1 can be compiled and runs on any linux system * Main supported OSs: - Ubuntu 14.04 @@ -80,7 +74,7 @@ _________________ Binary packages are available for download at [http://sourceforge.net/projects/openfoam-extend/] for the following systems: Ubuntu 14.04, Fedora 20 and Mac OS X. - + * Accompanying ThirdParty software: - gcc compatibility up to 4.8.2 - Paraview 4.0.1 @@ -98,28 +92,26 @@ _________________ - bison 2.7 - hwloc 1.7.2 - libccmio 2.6.1 + - -3 Compatibility -=============== - +3 Compatibility +---------------- Upstream features from the OpenFOAM® code base are merged into - foam-extend on regular basis. The interface format of foam-extend-3.1 - is largely compatible to OpenFOAM-1.6-ext and OpenFOAM-1.7.x. In some - cases, the differences are caused by bug fixes and algorithmic - improvements, considered more important than inter-operability. - - -4 Main differentiators between foam-extend and OpenFOAM -======================================================= + foam-extend on regular basis. The interface format of + foam-extend-3.1 is largely compatible to OpenFOAM-1.6-ext and + OpenFOAM-1.7.x. In some cases, the differences are caused by bug + fixes and algorithmic improvements, considered more important than + inter-operability. +4 Main differentiators between foam-extend and OpenFOAM +-------------------------------------------------------- A large number of features have been lost within the release of - OpenFOAM since version 1.3, the code base has shrunk by more than 40%. - While we understand the lack of technical ability of supporting - advanced CFD features, we feel that existing features and specifically - large-scale contributions should remain active and developed - further. Below is a list of main features of foam-extend which are - lacking, lost, deactivated or unusable in ESI releases: + OpenFOAM since version 1.3, the code base has shrunk by more than + 40%. While we understand the lack of technical ability of + supporting advanced CFD features, we feel that existing features and + specifically large-scale contributions should remain active and + developed further. Below is a list of main features of foam-extend + which are lacking, lost, deactivated or unusable in ESI releases: * Turbomachinery features, including General Grid Interface (GGI), partial overlap GGI, cyclic GGI, with improvements in parallel @@ -139,20 +131,21 @@ _________________ tetrahedral remeshing dynamic mesh support and solid body motion functions. All of the above include parallelisation support - * Library of dynamic meshes with topological changes with full second - order FVM discretisation support on moving meshes with topological - changes + * Library of dynamic meshes with topological changes with full + second order FVM discretisation support on moving meshes with + topological changes * Internal combustion engine-specific dynamic mesh classes such as two-stroke engine and various forms of 4-stroke and multi-valve dynamic mesh classes - * Finite Area Method providing support for FVM-like discretisation on - a curved surface in 3-D, with examples of liquid film modelling + * Finite Area Method providing support for FVM-like discretisation + on a curved surface in 3-D, with examples of liquid film modelling - * Block-coupled matrix support, allowing fully implicit multi-equation - solution of NxN equation sets, with full parallelisation support. - First release of a block-AMG linear equation solver + * Block-coupled matrix support, allowing fully implicit + multi-equation solution of NxN equation sets, with full + parallelisation support. First release of a block-AMG linear + equation solver * Fully implicit conjugate-coupled solution framework, allowing implicit solution fo multiple equations over multiple meshes, with @@ -166,16 +159,17 @@ _________________ * Multi-solver solution framework, allowing multiple field models to be solved in a coupled manner - * A major contribution is solid mechanics modelling, including linear - and non-linear materials, contact, self-contact and friction, with - updated Lagrangian or absolute Lagrangian formulation. Solution of - damage models and crack propagation in complex materials via - topological changes + * A major contribution is solid mechanics modelling, including + linear and non-linear materials, contact, self-contact and + friction, with updated Lagrangian or absolute Lagrangian + formulation. Solution of damage models and crack propagation in + complex materials via topological changes * CUDA solver release, provided in full source and as an example of coupling external linear equation solvers with FOAM - * Library-level support for Immersed Boundary Method and Overset Mesh + * Library-level support for Immersed Boundary Method and Overset + Mesh * Major improvements in accuracy and stability of FVM discretisation with options on convection and diffusion discretisation, deferred @@ -190,35 +184,36 @@ _________________ * Approximately 6000 bug fixes in fundamental level libraries and discretisation techniques - -5 New features in foam-extend-3.1, since foam-extend-3.0 -======================================================== - +5 New features in foam-extend-3.1, since foam-extend-3.0 +--------------------------------------------------------- The list of features is a result of the work of numerous contributors. The maintainers of foam-extend would formally like to thank them all. Get a full log of the updates by (either): - ,---- - | user@machine> git log 3.0.. > commitLog - `---- - ,---- - | user@machine> git log 3.0.. --oneline > commitLog - `---- - ,---- - | user@machine> gitg 3.0.. - `---- + + + user@machine> git log 3.0.. > commitLog + + + + user@machine> git log 3.0.. --oneline > commitLog + + + + user@machine> gitg 3.0.. + * Major new features: - Pressure-based compressible turbo functionalities - Pressure-based coupled solver (block-coupling p and U) - Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam - - major update and validation of mixing plane boundary - - full deploymenr of block matrix, including block-AMG solverse - - further parallel dynamic mesh capability: all topological changes + - Major update and validation of mixing plane boundary + - Full deploymenr of block matrix, including block-AMG solverse + - Further parallel dynamic mesh capability: all topological changes supported in parallel execution - - major upgrade of solid mechanics solvers - - support for CLang-based compilers + - Major upgrade of solid mechanics solvers + - Support for CLang-based compilers * Licence: GPLv3 @@ -229,8 +224,8 @@ _________________ - ThirdParty/Allclean alsoPackage - new option - wcleanAllButLibBinLnInclude - Fixed problem with ParaView reader for Ubuntu 14.04 - - foamToTecplot360: building tecio doesn't require X.org development - files + - foamToTecplot360: building tecio doesn't require X.org + development files * Solvers: - compressible/dbnsFoam @@ -304,38 +299,35 @@ _________________ * Bug fixes: - Correct snGrad on coupled boundaries - - handling of static null pointers: safe to dereference - - LinearUpwind no longer hangs in parallel execution on empty - patches - - mesh update on parallel topo changes: zones before boundaries + - Handling of static null pointers: safe to dereference + - LinearUpwind no longer hangs in parallel execution on empty patches + - Mesh update on parallel topo changes: zones before boundaries - GGI interpolation updates on topologically changing meshes - - cell layering issues off complex surfaces - - template depth for block matrix support - - parallel efficiency improvements + - Cell layering issues off complex surfaces + - Template depth for block matrix support + - Parallel efficiency improvements +6 Recent successful compilations and tests +------------------------------------------- + * Ubuntu 14.04: -6 Recent sucessful compilations and tests -========================================= + [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736] - * Ubuntu 14.04: + * Ubuntu 12.04: - [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736] + [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738] - * Ubuntu 12.04: + * CentOS 6.4: - [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738] + [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734] - * CentOS 6.4: + * Mac OX X 10.9.3 Maverick & CLang (XCode compiler): - [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734] + [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733] - * Mac OX X 10.9.3 Maverick & CLang (XCode compiler): + * Mac OX X & gcc (Macports) - [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733] - - * Mac OX X & gcc (Macports) - - [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737] + [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737] * Linux PPC ppc64 (Blue Gene) @@ -345,25 +337,18 @@ _________________ [http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743] +7 Reporting bugs +----------------- + To report bugs, please use the MantisBT bugtracker at + [http://sourceforge.net/apps/mantisbt/openfoam-extend] -7 Reporting bugs -================ +8 How to contribute +-------------------- + All your contributions are highly welcome: New solvers, utilities and + models; bug fixes; documentation. The many ways of contributing and the + contribution process are described in detail at: + [http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/] - To report bugs, please use the MantisBT bugtracker at - [http://sourceforge.net/apps/mantisbt/openfoam-extend] - - -8 How to contribute -=================== - - All your contributions are highly welcome: New solvers, utilities and - models; bug fixes; documentation. The many ways of contributing and - the contribution process are described in detail in the file - "HowToContribute" and at - [http://sourceforge.net/p/openfoam-extend/wiki/Home/] - - -9 List of Contributors: -======================= - - See file ListOfContributors +9 List of Contributors: +------------------------ + See file ListOfContributors