exaFOAM/foam-extend4.1-coherent-io
Archived
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Removed obsolete and incomplete HowToContribute, and reference to that file in ReleaseNotes. Also some typo fixes in ReleaseNotes.

Browse source
This commit is contained in:
Hakan Nilsson 2014-06-16 18:49:40 +02:00 committed by Henrik Rusche
parent 6c0c77dee2
commit 811bd0048a
4 changed files with 446 additions and 501 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
HowToContribute
View file

@ -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

26
ReleaseNotes
View file

@ -195,12 +195,12 @@ user@machine> git log 3.0.. > commitLog
- Pressure-based compressible turbo functionalities - Pressure-based compressible turbo functionalities
- Pressure-based coupled solver (block-coupling p and U) - Pressure-based coupled solver (block-coupling p and U)
- Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam - 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 - Further parallel dynamic mesh capability: all topological changes
supported in parallel execution 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 * Licence: GPLv3
@ -286,15 +286,15 @@ user@machine> git log 3.0.. > commitLog
* Bug fixes: * Bug fixes:
- Correct snGrad on coupled boundaries - 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 - 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 - 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
** Recent sucessful compilations and tests ** Recent successful compilations and tests
* Ubuntu 14.04: * Ubuntu 14.04:
http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736 http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736
@ -330,8 +330,8 @@ user@machine> git log 3.0.. > commitLog
** How to contribute ** How to contribute
All your contributions are highly welcome: New solvers, utilities and All your contributions are highly welcome: New solvers, utilities and
models; bug fixes; documentation. The many ways of contributing and the models; bug fixes; documentation. The many ways of contributing and the
contribution process are described in detail in the file "HowToContribute" contribution process are described in detail at:
and at http://sourceforge.net/p/openfoam-extend/wiki/Home/ http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/
** List of Contributors: ** List of Contributors:
See file ListOfContributors See file ListOfContributors

633
ReleaseNotes.html
View file

@ -1,88 +1,63 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<title><b>Release notes for foam-extend-3.1</b></title> <title><b>Release notes for foam-extend-3.1</b></title>
<!-- 2014-06-16 Mon 16:40 --> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="title" content="<b>Release notes for foam-extend-3.1</b>"/>
<meta name="generator" content="Org-mode" /> <meta name="generator" content="Org-mode"/>
<meta name="generated" content="8 June 2014"/>
<meta name="author" content="Bernhard Gschaider"/>
<meta name="description" content=""/>
<meta name="keywords" content=""/>
<style type="text/css"> <style type="text/css">
<!--/*--><![CDATA[/*><!--*/ <!--/*--><![CDATA[/*><!--*/
html { font-family: Times, serif; font-size: 12pt; }
.title { text-align: center; } .title { text-align: center; }
.todo { font-family: monospace; color: red; } .todo { color: red; }
.done { color: green; } .done { color: green; }
.tag { background-color: #eee; font-family: monospace; .tag { background-color: #add8e6; font-weight:normal }
padding: 2px; font-size: 80%; font-weight: normal; } .target { }
.timestamp { color: #bebebe; } .timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; } .timestamp-kwd { color: #5f9ea0; }
.right { margin-left: auto; margin-right: 0px; text-align: right; } .right {margin-left:auto; margin-right:0px; text-align:right;}
.left { margin-left: 0px; margin-right: auto; text-align: left; } .left {margin-left:0px; margin-right:auto; text-align:left;}
.center { margin-left: auto; margin-right: auto; text-align: center; } .center {margin-left:auto; margin-right:auto; text-align:center;}
.underline { text-decoration: underline; } p.verse { margin-left: 3% }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre { pre {
border: 1px solid #ccc; border: 1pt solid #AEBDCC;
box-shadow: 3px 3px 3px #eee; background-color: #F3F5F7;
padding: 8pt; padding: 5pt;
font-family: monospace; font-family: courier, monospace;
overflow: auto; font-size: 90%;
margin: 1.2em; overflow:auto;
} }
pre.src { table { border-collapse: collapse; }
position: relative; td, th { vertical-align: top; }
overflow: visible; th.right { text-align:center; }
padding-top: 1.2em; th.left { text-align:center; }
} th.center { text-align:center; }
pre.src:before { td.right { text-align:right; }
display: none; td.left { text-align:left; }
position: absolute; td.center { text-align:center; }
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
pre.src-sh:before { content: 'sh'; }
pre.src-bash:before { content: 'sh'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-R:before { content: 'R'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-java:before { content: 'Java'; }
pre.src-sql:before { content: 'SQL'; }
table { border-collapse:collapse; }
td, th { vertical-align:top; }
th.right { text-align: center; }
th.left { text-align: center; }
th.center { text-align: center; }
td.right { text-align: right; }
td.left { text-align: left; }
td.center { text-align: center; }
dt { font-weight: bold; } dt { font-weight: bold; }
.footpara:nth-child(2) { display: inline; } div.figure { padding: 0.5em; }
.footpara { display: block; } div.figure p { text-align: center; }
.footdef { margin-bottom: 1em; } div.inlinetask {
.figure { padding: 1em; } padding:10px;
.figure p { text-align: center; } border:2px solid gray;
.inlinetask { margin:10px;
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc; background: #ffffcc;
} }
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; } textarea { overflow-x: auto; }
.linenr { font-size: smaller } .linenr { font-size:smaller }
.code-highlighted { background-color: #ffff00; } .code-highlighted {background-color:#ffff00;}
.org-info-js_info-navigation { border-style: none; } .org-info-js_info-navigation { border-style:none; }
#org-info-js_console-label #org-info-js_console-label { font-size:10px; font-weight:bold;
{ font-size: 10px; font-weight: bold; white-space: nowrap; } white-space:nowrap; }
.org-info-js_search-highlight .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
{ background-color: #ffff00; color: #000000; font-weight: bold; } font-weight:bold; }
/*]]>*/--> /*]]>*/-->
</style> </style>
<script type="text/javascript"> <script type="text/javascript">
@ -131,111 +106,116 @@ for the JavaScript code in this tag.
} }
/*]]>*///--> /*]]>*///-->
</script> </script>
</head> </head>
<body> <body>
<div id="preamble">
</div>
<div id="content"> <div id="content">
<h1 class="title"><b>Release notes for foam-extend-3.1</b></h1> <h1 class="title"><b>Release notes for foam-extend-3.1</b></h1>
<p>################################################################################
</p>
<div id="table-of-contents"> <div id="table-of-contents">
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#sec-1">1. Overview</a></li> <li><a href="#sec-1">1 Overview</a></li>
<li><a href="#sec-2">2. Installation</a></li> <li><a href="#sec-2">2 Installation</a></li>
<li><a href="#sec-3">3. Compatibility</a></li> <li><a href="#sec-3">3 Compatibility</a></li>
<li><a href="#sec-4">4. Main differentiators between foam-extend and OpenFOAM</a></li> <li><a href="#sec-4">4 Main differentiators between foam-extend and OpenFOAM</a></li>
<li><a href="#sec-5">5. New features in foam-extend-3.1, since foam-extend-3.0</a></li> <li><a href="#sec-5">5 New features in foam-extend-3.1, since foam-extend-3.0</a></li>
<li><a href="#sec-6">6. Recent sucessful compilations and tests</a></li> <li><a href="#sec-6">6 Recent successful compilations and tests</a></li>
<li><a href="#sec-7">7. Reporting bugs</a></li> <li><a href="#sec-7">7 Reporting bugs</a></li>
<li><a href="#sec-8">8. How to contribute</a></li> <li><a href="#sec-8">8 How to contribute</a></li>
<li><a href="#sec-9">9. List of Contributors:</a></li> <li><a href="#sec-9">9 List of Contributors:</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<p>
################################################################################
</p>
<div id="outline-container-sec-1" class="outline-2"> <div id="outline-container-1" class="outline-3">
<h2 id="sec-1"><span class="section-number-2">1</span> Overview</h2> <h3 id="sec-1"><span class="section-number-3">1</span> Overview</h3>
<div class="outline-text-2" id="text-1"> <div class="outline-text-3" id="text-1">
<p>
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:
<a href="http://sourceforge.net/p/openfoam-extend/wiki/Home/">http://sourceforge.net/p/openfoam-extend/wiki/Home/</a>
</p>
<p> <p> The foam-extend project is a fork of the OpenFOAM® open source
Version 3.1, nicknamed "Zagreb", is the current version of library for Computational Fluid Dynamics (CFD). It is an open
foam-extend. The release continues the tradition and spirit of the project welcoming and integrating contributions from all users and
original FOAM code developed by prof. Jasak and Mr. Weller during developers. Previously known as OpenFOAM®-dev and OpenFOAM®-extend,
their time at Imperial College and released as the general purpose it contains bug fixes and performance improvements, as well as
CFD/CCM package by Nabla Ltd. in 2000. In this spirit, we reverted extensions and additional features provided by community
18 December 2013 to the original numbering scheme (foam-2.3.2, 13 contributors (see file ListOfContributors), such as dynamic mesh and
December 2004) as release number 3.0. Visit <a href="http://foam-extend.org">http://foam-extend.org</a> topological change support, turbomachinery extensions including
for more information. 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:
<a href="http://sourceforge.net/p/openfoam-extend/wiki/Home/">http://sourceforge.net/p/openfoam-extend/wiki/Home/</a>
</p> </p>
<p> <p>
OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and Version 3.1, nicknamed "Zagreb", is the current version of
foam-extend are a community effort not endorsed by ESI Group. 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 <a href="http://foam-extend.org">http://foam-extend.org</a>
for more information.
</p>
<p>
OPENFOAM® is a registered trademark of ESI Group. OpenFOAM-extend and
foam-extend are a community effort not endorsed by ESI Group.
</p> </p>
</div> </div>
</div>
<div id="outline-container-sec-2" class="outline-2">
<h2 id="sec-2"><span class="section-number-2">2</span> Installation</h2>
<div class="outline-text-2" id="text-2">
<p>
foam-extend-3.1 can be compiled and runs on any linux system
</p>
<ul class="org-ul"> </div>
<div id="outline-container-2" class="outline-3">
<h3 id="sec-2"><span class="section-number-3">2</span> Installation</h3>
<div class="outline-text-3" id="text-2">
<p> foam-extend-3.1 can be compiled and runs on any linux system
</p>
<ul>
<li>Main supported OSs: <li>Main supported OSs:
<ul class="org-ul"> <ul>
<li>Ubuntu 14.04 <li>Ubuntu 14.04
</li> </li>
<li>Fedora 20 <li>Fedora 20
</li> </li>
<li>Mac OS X <li>Mac OS X
</li> </li>
</ul> </ul>
</li>
</li>
<li>Compile from source: <li>Compile from source:
<p> <p>
Please refer to doc/buildInstructions/ for details. Further Please refer to doc/buildInstructions/ for details. Further
installation instruction are available on the unofficial OpenFOAM installation instruction are available on the unofficial OpenFOAM
Wiki: Wiki:
<a href="http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0">http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0</a> <a href="http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0">http://openfoamwiki.net/index.php/Installation/Linux/foam-extend-3.0</a>
If you have improvements or build instructions for a new system, If you have improvements or build instructions for a new system,
please share them with the community (see section "How to please share them with the community (see section "How to
contribute", below). contribute", below).
</p> </p>
</li> </li>
<li>Download binary packages: <li>Download binary packages:
<p> <p>
Binary packages are available for download at Binary packages are available for download at
<a href="http://sourceforge.net/projects/openfoam-extend/">http://sourceforge.net/projects/openfoam-extend/</a> for the following <a href="http://sourceforge.net/projects/openfoam-extend/">http://sourceforge.net/projects/openfoam-extend/</a> for the following
systems: Ubuntu 14.04, Fedora 20 and Mac OS X. systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
</p> </p>
</li> </li>
<li>Accompanying ThirdParty software: <li>Accompanying ThirdParty software:
<ul class="org-ul"> <ul>
<li>gcc compatibility up to 4.8.2 <li>gcc compatibility up to 4.8.2
</li> </li>
<li>Paraview 4.0.1 <li>Paraview 4.0.1
@ -269,208 +249,218 @@ systems: Ubuntu 14.04, Fedora 20 and Mac OS X.
<li>libccmio 2.6.1 <li>libccmio 2.6.1
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div>
</div>
<div id="outline-container-sec-3" class="outline-2">
<h2 id="sec-3"><span class="section-number-2">3</span> Compatibility</h2>
<div class="outline-text-2" id="text-3">
<p>
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.
</p>
</div>
</div>
<div id="outline-container-sec-4" class="outline-2">
<h2 id="sec-4"><span class="section-number-2">4</span> Main differentiators between foam-extend and OpenFOAM</h2>
<div class="outline-text-2" id="text-4">
<p>
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:
</p>
<ul class="org-ul">
</div>
</div>
<div id="outline-container-3" class="outline-3">
<h3 id="sec-3"><span class="section-number-3">3</span> Compatibility</h3>
<div class="outline-text-3" id="text-3">
<p> 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.
</p>
</div>
</div>
<div id="outline-container-4" class="outline-3">
<h3 id="sec-4"><span class="section-number-3">4</span> Main differentiators between foam-extend and OpenFOAM</h3>
<div class="outline-text-3" id="text-4">
<p> 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:
</p>
<ul>
<li>Turbomachinery features, including General Grid Interface (GGI), <li>Turbomachinery features, including General Grid Interface (GGI),
partial overlap GGI, cyclic GGI, with improvements in parallel partial overlap GGI, cyclic GGI, with improvements in parallel
scaling. First release of a mixing plane stage interface scaling. First release of a mixing plane stage interface
</li>
</li>
<li>Dynamic mesh with topological changes Sliding interfaces, mesh <li>Dynamic mesh with topological changes Sliding interfaces, mesh
layering, attach-detach boundaries etc. In foam-extend, full layering, attach-detach boundaries etc. In foam-extend, full
parallel support for topological changes is released for the first parallel support for topological changes is released for the first
time time
</li>
</li>
<li>Finite Element Method with support for polyhedral meshes This is <li>Finite Element Method with support for polyhedral meshes This is
mainly used in mesh deformation and over the last 15 years it has mainly used in mesh deformation and over the last 15 years it has
proven vastly superior to all other dynamic mesh methods. proven vastly superior to all other dynamic mesh methods.
</li>
</li>
<li>Advanced mesh deformation technology Including tet FEM mesh <li>Advanced mesh deformation technology Including tet FEM mesh
deformation, Radial Basis Function (RBF) mesh deformation, deformation, Radial Basis Function (RBF) mesh deformation,
tetrahedral remeshing dynamic mesh support and solid body motion tetrahedral remeshing dynamic mesh support and solid body motion
functions. All of the above include parallelisation support functions. All of the above include parallelisation support
</li>
</li>
<li>Library of dynamic meshes with topological changes with full <li>Library of dynamic meshes with topological changes with full
second order FVM discretisation support on moving meshes with second order FVM discretisation support on moving meshes with
topological changes topological changes
</li>
</li>
<li>Internal combustion engine-specific dynamic mesh classes such as <li>Internal combustion engine-specific dynamic mesh classes such as
two-stroke engine and various forms of 4-stroke and multi-valve two-stroke engine and various forms of 4-stroke and multi-valve
dynamic mesh classes dynamic mesh classes
</li>
</li>
<li>Finite Area Method providing support for FVM-like discretisation <li>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
</li>
</li>
<li>Block-coupled matrix support, allowing fully implicit <li>Block-coupled matrix support, allowing fully implicit
multi-equation solution of NxN equation sets, with full multi-equation solution of NxN equation sets, with full
parallelisation support. First release of a block-AMG linear parallelisation support. First release of a block-AMG linear
equation solver equation solver
</li>
</li>
<li>Fully implicit conjugate-coupled solution framework, allowing <li>Fully implicit conjugate-coupled solution framework, allowing
implicit solution fo multiple equations over multiple meshes, with implicit solution fo multiple equations over multiple meshes, with
parallelism parallelism
</li>
</li>
<li>Proper Orthogonal Decomposition data analysis tools, with <li>Proper Orthogonal Decomposition data analysis tools, with
applications to FOAM field classes applications to FOAM field classes
</li>
</li>
<li>Equation reader classes and tutorials <li>Equation reader classes and tutorials
</li>
</li>
<li>Multi-solver solution framework, allowing multiple field models to <li>Multi-solver solution framework, allowing multiple field models to
be solved in a coupled manner be solved in a coupled manner
</li>
</li>
<li>A major contribution is solid mechanics modelling, including <li>A major contribution is solid mechanics modelling, including
linear and non-linear materials, contact, self-contact and linear and non-linear materials, contact, self-contact and
friction, with updated Lagrangian or absolute Lagrangian friction, with updated Lagrangian or absolute Lagrangian
formulation. Solution of damage models and crack propagation in formulation. Solution of damage models and crack propagation in
complex materials via topological changes complex materials via topological changes
</li>
</li>
<li>CUDA solver release, provided in full source and as an example of <li>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
</li>
</li>
<li>Library-level support for Immersed Boundary Method and Overset <li>Library-level support for Immersed Boundary Method and Overset
Mesh Mesh
</li>
</li>
<li>Major improvements in accuracy and stability of FVM discretisation <li>Major improvements in accuracy and stability of FVM discretisation
with options on convection and diffusion discretisation, deferred with options on convection and diffusion discretisation, deferred
correction or explicit schemes correction or explicit schemes
</li>
</li>
<li>Algebraic multigrid solver framework <li>Algebraic multigrid solver framework
</li>
</li>
<li>210 tutorials with automated run scripts <li>210 tutorials with automated run scripts
</li>
</li>
<li>Automatic test harness <li>Automatic test harness
</li>
</li>
<li>Approximately 6000 bug fixes in fundamental level libraries and <li>Approximately 6000 bug fixes in fundamental level libraries and
discretisation techniques discretisation techniques
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-sec-5" class="outline-2">
<h2 id="sec-5"><span class="section-number-2">5</span> New features in foam-extend-3.1, since foam-extend-3.0</h2> <div id="outline-container-5" class="outline-3">
<div class="outline-text-2" id="text-5"> <h3 id="sec-5"><span class="section-number-3">5</span> New features in foam-extend-3.1, since foam-extend-3.0</h3>
<div class="outline-text-3" id="text-5">
<p> 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.
</p>
<p> <p>
The list of features is a result of the work of numerous Get a full log of the updates by (either):
contributors. The maintainers of foam-extend would formally like to
thank them all.
</p> </p>
<p>
Get a full log of the updates by (either):
</p>
<div class="org-src-container">
<pre class="src src-bash">user@machine&gt; git log 3.0.. &gt; commitLog <pre class="example">user@machine&gt; git log 3.0.. &gt; commitLog
</pre> </pre>
</div>
<div class="org-src-container">
<pre class="src src-bash">user@machine&gt; git log 3.0.. --oneline &gt; commitLog
<pre class="example">user@machine&gt; git log 3.0.. --oneline &gt; commitLog
</pre> </pre>
</div>
<div class="org-src-container">
<pre class="src src-bash">user@machine&gt; gitg 3.0..
<pre class="example">user@machine&gt; gitg 3.0..
</pre> </pre>
</div>
<ul class="org-ul">
<ul>
<li>Major new features: <li>Major new features:
<ul class="org-ul"> <ul>
<li>Pressure-based compressible turbo functionalities <li>Pressure-based compressible turbo functionalities
</li> </li>
<li>Pressure-based coupled solver (block-coupling p and U) <li>Pressure-based coupled solver (block-coupling p and U)
</li> </li>
<li>Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam <li>Density-based coupled Roe flux solver dbnsFoam and dbnsTurbFoam
</li> </li>
<li>major update and validation of mixing plane boundary <li>Major update and validation of mixing plane boundary
</li> </li>
<li>full deploymenr of block matrix, including block-AMG solverse <li>Full deploymenr of block matrix, including block-AMG solverse
</li> </li>
<li>further parallel dynamic mesh capability: all topological changes <li>Further parallel dynamic mesh capability: all topological changes
supported in parallel execution supported in parallel execution
</li> </li>
<li>major upgrade of solid mechanics solvers <li>Major upgrade of solid mechanics solvers
</li> </li>
<li>support for CLang-based compilers <li>Support for CLang-based compilers
</li> </li>
</ul> </ul>
</li>
</li>
<li>Licence: GPLv3 <li>Licence: GPLv3
</li>
</li>
<li>Installation: <li>Installation:
<ul class="org-ul"> <ul>
<li>Updated and bug-fixed installation procedures <li>Updated and bug-fixed installation procedures
</li> </li>
<li>Removed need for gmake link in Ubuntu <li>Removed need for gmake link in Ubuntu
</li> </li>
<li>Scripts for minimizing installation after compilation <li>Scripts for minimizing installation after compilation
<ul class="org-ul"> <ul>
<li>ThirdParty/Allclean alsoPackage - new option <li>ThirdParty/Allclean alsoPackage - new option
</li> </li>
<li>wcleanAllButLibBinLnInclude <li>wcleanAllButLibBinLnInclude
</li> </li>
</ul> </ul>
</li> </li>
<li>Fixed problem with ParaView reader for Ubuntu 14.04 <li>Fixed problem with ParaView reader for Ubuntu 14.04
</li> </li>
<li>foamToTecplot360: building tecio doesn't require X.org <li>foamToTecplot360: building tecio doesn't require X.org
development files development files
</li> </li>
</ul> </ul>
</li>
</li>
<li>Solvers: <li>Solvers:
<ul class="org-ul"> <ul>
<li>compressible/dbnsFoam <li>compressible/dbnsFoam
</li> </li>
<li>compressible/dbnsTurbFoam <li>compressible/dbnsTurbFoam
@ -482,18 +472,19 @@ development files
<li>compressible/steadyCompressibleSRFFoam <li>compressible/steadyCompressibleSRFFoam
</li> </li>
<li>coupled/pUCoupledFoam (incl. core library changes) <li>coupled/pUCoupledFoam (incl. core library changes)
</li>
</li>
<li>Update and cleanup of solvers/solidMechanics <li>Update and cleanup of solvers/solidMechanics
</li> </li>
<li>Update for segregated FEM matrix, <li>Update for segregated FEM matrix,
solvers/solidMechanics/stressFemFoam solvers/solidMechanics/stressFemFoam
</li> </li>
</ul> </ul>
</li>
</li>
<li>Utilities: <li>Utilities:
<ul class="org-ul"> <ul>
<li>convertPhi (for steadyCompressible solvers) <li>convertPhi (for steadyCompressible solvers)
</li> </li>
<li>foamMeshToElmer, fluent3DMeshToElmer <li>foamMeshToElmer, fluent3DMeshToElmer
@ -501,14 +492,15 @@ solvers/solidMechanics/stressFemFoam
<li>transformPoints -cylToCart "origin axis direction" - new option <li>transformPoints -cylToCart "origin axis direction" - new option
</li> </li>
<li>blockMesh syntax update (see commit a78b12074) <li>blockMesh syntax update (see commit a78b12074)
</li> </li>
</ul> </ul>
</li>
</li>
<li>Libraries: <li>Libraries:
<ul class="org-ul"> <ul>
<li>General: <li>General:
<ul class="org-ul"> <ul>
<li>Added Gauss-Seidel as asymmetric solver <li>Added Gauss-Seidel as asymmetric solver
</li> </li>
<li>Block matrix agglomeration (for pUCoupledFoam) <li>Block matrix agglomeration (for pUCoupledFoam)
@ -518,9 +510,10 @@ solvers/solidMechanics/stressFemFoam
<li>dbns library (src/dbns) <li>dbns library (src/dbns)
</li> </li>
</ul> </ul>
</li> </li>
<li>Boundary conditions: <li>Boundary conditions:
<ul class="org-ul"> <ul>
<li>cfdTools/general/SRF/derivedFvPatchFields/SRFFlowRateInletVelocity <li>cfdTools/general/SRF/derivedFvPatchFields/SRFFlowRateInletVelocity
</li> </li>
<li>cfdTools/general/SRF/derivedFvPatchFields/SRFSurfaceNormalVelocity <li>cfdTools/general/SRF/derivedFvPatchFields/SRFSurfaceNormalVelocity
@ -540,18 +533,21 @@ solvers/solidMechanics/stressFemFoam
<li>fvMesh/fvPatches/constraint/mixingPlane <li>fvMesh/fvPatches/constraint/mixingPlane
</li> </li>
</ul> </ul>
</li> </li>
<li>Turbulence modeling: <li>Turbulence modeling:
<ul class="org-ul"> <ul>
<li>Removed kOmegaSST_lowRe - use standard kOmegaSST <li>Removed kOmegaSST_lowRe - use standard kOmegaSST
</li>
</ul>
</li>
</ul>
</li>
</li>
</ul>
</li>
</ul>
</li>
<li>Tutorial updates (settings, initial conditions, bug fixes etc.): <li>Tutorial updates (settings, initial conditions, bug fixes etc.):
<ul class="org-ul"> <ul>
<li>incompressible/icoDyMFoam/mixerGgi <li>incompressible/icoDyMFoam/mixerGgi
</li> </li>
<li>incompressible/icoDyMFoam/movingConeMotion <li>incompressible/icoDyMFoam/movingConeMotion
@ -569,12 +565,13 @@ solvers/solidMechanics/stressFemFoam
<li>solidMechanics/stressFemFoam/plateHole <li>solidMechanics/stressFemFoam/plateHole
</li> </li>
<li>Many other updates due to blockMesh syntax update <li>Many other updates due to blockMesh syntax update
</li> </li>
</ul> </ul>
</li>
</li>
<li>New tutorials: <li>New tutorials:
<ul class="org-ul"> <ul>
<li>compressible/dbnsFoam/forwardStep <li>compressible/dbnsFoam/forwardStep
</li> </li>
<li>compressible/dbnsFoam/shockTube <li>compressible/dbnsFoam/shockTube
@ -614,122 +611,130 @@ solvers/solidMechanics/stressFemFoam
<li>incompressible/simpleSRFFoam/axialTurbine <li>incompressible/simpleSRFFoam/axialTurbine
</li> </li>
<li>mesh/moveDynamicMesh/movingCylinders <li>mesh/moveDynamicMesh/movingCylinders
</li> </li>
</ul> </ul>
</li>
</li>
<li>Bug fixes: <li>Bug fixes:
<ul class="org-ul"> <ul>
<li>Correct snGrad on coupled boundaries <li>Correct snGrad on coupled boundaries
</li> </li>
<li>handling of static null pointers: safe to dereference <li>Handling of static null pointers: safe to dereference
</li> </li>
<li>LinearUpwind no longer hangs in parallel execution on empty patches <li>LinearUpwind no longer hangs in parallel execution on empty patches
</li> </li>
<li>mesh update on parallel topo changes: zones before boundaries <li>Mesh update on parallel topo changes: zones before boundaries
</li> </li>
<li>GGI interpolation updates on topologically changing meshes <li>GGI interpolation updates on topologically changing meshes
</li> </li>
<li>cell layering issues off complex surfaces <li>Cell layering issues off complex surfaces
</li> </li>
<li>template depth for block matrix support <li>Template depth for block matrix support
</li> </li>
<li>parallel efficiency improvements <li>Parallel efficiency improvements
</li> </li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-sec-6" class="outline-2">
<h2 id="sec-6"><span class="section-number-2">6</span> Recent sucessful compilations and tests</h2> <div id="outline-container-6" class="outline-3">
<div class="outline-text-2" id="text-6"> <h3 id="sec-6"><span class="section-number-3">6</span> Recent successful compilations and tests</h3>
<ul class="org-ul"> <div class="outline-text-3" id="text-6">
<ul>
<li>Ubuntu 14.04: <li>Ubuntu 14.04:
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=736</a>
</p> </p>
</li> </li>
<li>Ubuntu 12.04: <li>Ubuntu 12.04:
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=738</a>
</p> </p>
</li> </li>
<li>CentOS 6.4: <li>CentOS 6.4:
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=734</a>
</p> </p>
</li> </li>
<li>Mac OX X 10.9.3 Maverick &amp; CLang (XCode compiler): <li>Mac OX X 10.9.3 Maverick &amp; CLang (XCode compiler):
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=733</a>
</p> </p>
</li> </li>
<li>Mac OX X &amp; gcc (Macports) <li>Mac OX X &amp; gcc (Macports)
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=737</a>
</p> </p>
</li> </li>
<li>Linux PPC ppc64 (Blue Gene) <li>Linux PPC ppc64 (Blue Gene)
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=742">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=742</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=742">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=742</a>
</p> </p>
</li> </li>
<li>Red Hat Enterprise Linux Server release 5.2 (Tikanga), Intel CC 11.1 <li>Red Hat Enterprise Linux Server release 5.2 (Tikanga), Intel CC 11.1
<p> <p>
<a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743</a> <a href="http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743">http://openfoam-extend.sourceforge.net/CDash/viewTest.php?buildid=743</a>
</p> </p></li>
</li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-sec-7" class="outline-2">
<h2 id="sec-7"><span class="section-number-2">7</span> Reporting bugs</h2> <div id="outline-container-7" class="outline-3">
<div class="outline-text-2" id="text-7"> <h3 id="sec-7"><span class="section-number-3">7</span> Reporting bugs</h3>
<p> <div class="outline-text-3" id="text-7">
To report bugs, please use the MantisBT bugtracker at
<a href="http://sourceforge.net/apps/mantisbt/openfoam-extend">http://sourceforge.net/apps/mantisbt/openfoam-extend</a> <p> To report bugs, please use the MantisBT bugtracker at
<a href="http://sourceforge.net/apps/mantisbt/openfoam-extend">http://sourceforge.net/apps/mantisbt/openfoam-extend</a>
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-sec-8" class="outline-2">
<h2 id="sec-8"><span class="section-number-2">8</span> How to contribute</h2> <div id="outline-container-8" class="outline-3">
<div class="outline-text-2" id="text-8"> <h3 id="sec-8"><span class="section-number-3">8</span> How to contribute</h3>
<p> <div class="outline-text-3" id="text-8">
All your contributions are highly welcome: New solvers, utilities and
models; bug fixes; documentation. The many ways of contributing and the <p> All your contributions are highly welcome: New solvers, utilities and
contribution process are described in detail in the file "HowToContribute" models; bug fixes; documentation. The many ways of contributing and the
and at <a href="http://sourceforge.net/p/openfoam-extend/wiki/Home/">http://sourceforge.net/p/openfoam-extend/wiki/Home/</a> contribution process are described in detail at:
<a href="http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/">http://sourceforge.net/p/openfoam-extend/wiki/HowToContribute/</a>
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-sec-9" class="outline-2">
<h2 id="sec-9"><span class="section-number-2">9</span> List of Contributors:</h2> <div id="outline-container-9" class="outline-3">
<div class="outline-text-2" id="text-9"> <h3 id="sec-9"><span class="section-number-3">9</span> List of Contributors:</h3>
<p> <div class="outline-text-3" id="text-9">
See file ListOfContributors
</p> <p> See file ListOfContributors
</p></div>
</div> </div>
</div> </div>
</div>
<div id="postamble" class="status"> <div id="postamble">
<p class="date">Date: 8 June 2014</p> <p class="date">Date: 8 June 2014</p>
<p class="date">Created: 2014-06-16 Mon 16:40</p> <p class="creator"><a href="http://orgmode.org">Org</a> version 7.9.3f with <a href="http://www.gnu.org/software/emacs/">Emacs</a> version 24</p>
<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.3.1 (<a href="http://orgmode.org">Org</a> mode 8.2.4)</p> <a href="http://validator.w3.org/check?uri=referer">Validate XHTML 1.0</a>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>
</html> </html>

243
ReleaseNotes.txt
View file

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