From 8a4cca0d9688cda9b9c634b8b0270d2d7a7540a3 Mon Sep 17 00:00:00 2001 From: Hrvoje Jasak Date: Wed, 17 Nov 2010 12:13:34 +0000 Subject: [PATCH] Release notes --- COPYING | 8 +-- ExtendProjectPreamble | 111 ++++++++++++++++++++++++++++++++++++++++++ README | 104 +++++++++++++++++---------------------- ReleaseNotes-1.6-ext | 83 +++++++++++++++++++++++++++++++ 4 files changed, 243 insertions(+), 63 deletions(-) create mode 100644 ExtendProjectPreamble create mode 100644 ReleaseNotes-1.6-ext diff --git a/COPYING b/COPYING index e9358e936..18314ff77 100644 --- a/COPYING +++ b/COPYING @@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions: License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) - + These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in @@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. - + 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is @@ -225,7 +225,7 @@ impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. - + 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License @@ -278,7 +278,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS - + How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest diff --git a/ExtendProjectPreamble b/ExtendProjectPreamble new file mode 100644 index 000000000..2ac304435 --- /dev/null +++ b/ExtendProjectPreamble @@ -0,0 +1,111 @@ +The OpenFOAM-Extend Project + +Web site: http://www.extend-project.de/ + +The goal of the OpenFOAM -Extend Project is to open the OpenFOAM CFD toolbox +to community contributed extensions in the spirit of the Open Source +development model. + +Software under the name OpenFOAM has been developed by a large group of +volunteers starting in 1991 and has spread through scientific and engineering +community in the late 1990s and early 2000s. Its main strength was the spirit +of open collaboration in the community: the aim of the OpenFOAM-Extend Project +is to formalize this spirit. + + * Trademark notice + Currently, the word "OpenFOAM" is held as a trademark by a commercial + company, not associated with the Open Source development effort of this + software. While the author acknowledges the existence of Trademark, + association of trademarked phrase with the the code developed by third + parties and including the author is misleading in terms of authorship, + ownership of intellectual property of the source code. + + In the absence of a legal resolution, we shall refer to the project as the + -Extend project and software as "OpenFOAM", as per agreement between + Prof. Hrvoje Jasak and Mr. Henry G. Weller of 30 September 2004 + + 09/30/2004 01:45 PM + + Dear Dr. Jasak, + + I propose that we make FOAM open-source and shutdown Nabla, that way we + are free to pursue whatever future we wish independently. + + Henry G. Weller + Managing Director + Nabla Ltd + + The first release of the OpenFOAM source code of 10 December 2004 + and subsequent clarification of 16 February 2005. + + Hi Henry, + + ... + + Regarding the new setup, I would like to thank you for your effort i + n making FOAM public domain, with crucial comments regarding some + important details. + + - in the header files for the open version of foam there exists a line + which claims copyright for OpenCFD Ltd: + + Copyright (C) 1991-2004 OpenCFD Ltd. + + I am not sure whether it is possible to claim copyright over a GPL piece + of software, but this is at least misleading. In order for this + statement to be true, OpenCFD Ltd. would need to purchase the copyright + from Nabla Ltd. and from you and me personally (due to unresolved + ownership and the remaining payments Nabla Ltd. needs to make to us + regarding the original transfer of copyright). I can offer a number + of solutions acceptable to me as follows: + + 1) no Copyright statement apart from the required GPL statement + 2) Copyright OpenFOAM.org + 3) Copyright Henry Weller, Hrvoje Jasak et al + 4) Copyright OpenCFD and Hrvoje Jasak + 5) List of authors instead of the copyright statement + + I am also prepared to consider any other reasonable ideas along the same + lines (including the sale of copyright, which would be a bit pointless + at this stage) - please advise. + + + 02/17/2005 11:09 PM + + Under the GPL there has to be an organization in place to enforce the GPL + if there are violation, these are part of the rules. OpenCFD undertakes + that responsibility hence the copyright. + + Henry G. Weller + Managing Director + + + 12 November 2010 + + From the above it is clear that OpenCFD does not own the rights or + authorship of the source code, which is currently concealed in public. + For further details, I have been attempting to get a formal response by + this company for 6 years now, without success. It is time to move on. + + The current Copyright notice does not fairly describe the authorship of + the software. In the spirit of the open source development model, the + -Extend project wishes to formally acknowledge all contributors and + developers of OpenFOAM from its inception to today. + + As this issue still remains unresolved, and the list of contributors + has been illegally removed from the source code by Mr. Weller in 2006, + we shall re-base OpenFOAM as an Open Source community-based project + and associate the authorship and Copyright in each case with the + original author. + + Hrvoje Jasak + + +This offering is not affiliated with OpenCFD Limited, owner of the OpenFOAM +trade mark. + + +Please find the official website of OpenCFD Limited at http://www.openfoam.org +In particular, OpenCFD Limited hosts the following legal statements: +- licensing and intellectual property: http://www.openfoam.com/legal/index.php +- trademark policy: http://www.openfoam.com/legal/trademark-policy.php diff --git a/README b/README index fd3bde993..b24bbb009 100644 --- a/README +++ b/README @@ -1,21 +1,25 @@ # -*- mode: org; -*- # -#+TITLE: *OpenFOAM README for version 1.5* +#+TITLE: *OpenFOAM README for version 1.6-ext* #+AUTHOR: Hrvoje Jasak. -#+DATE: 19 August 2008 -#+LINK: http://www.wikki.co.uk +#+DATE: 12 November 2010 +#+LINK: http://www.extend-project.de #+OPTIONS: author:nil * Copyright OpenFOAM is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later - version. See the file COPYING in this directory, for a description of the GNU - General Public License terms under which you can copy the files. + version. See the file COPYING in this directory, for a description of + the GNU General Public License terms under which you can copy the files. * System requirements - OpenFOAM is developed and tested on Linux, but should work with other Unix - style systems. To check your system setup, execute the foamSystemCheck script + OpenFOAM is developed and tested on Linux and Mac OS X. + Experimental Microsoft Windows port is currently not released - please follow + the user forum and annoucements + + * Linux + To check your system setup, execute the foamSystemCheck script in the bin/ directory of the OpenFOAM installation. If no problems are reported, proceed to "3. Installation"; otherwise contact your system administrator. @@ -23,44 +27,28 @@ If the user wishes to run OpenFOAM in 32/64-bit mode they should consult the section "Running OpenFOAM in 32-bit mode". -*** Qt (from http://trolltech.com/products/qt) - The ParaView 3.3 visualisation package requires that Qt version 4.3.x MUST - be installed on the system. Earlier or more recent versions (4.2.x or - 4.4.x) will NOT work. To check whether Qt4 is installed, and the version, - type: - + qmake --version + * Apple Mac OS X + The recommended way of running OpenFOAM on the Mac is to download sparse disk + images, mount them on your system and link them into - The ParaView binary executables in the ThirdParty distribution will only - work with PRECISELY the same version of Qt with which it was compiled. The - 64-bit version of ParaView was compiled with Qt-4.3.1 (with openSuSE-10.3) - and the 32-bit version of ParaView was compiled with Qt-4.3.2 (with - ubuntu-7.10). If the user finds that a ParaView binary fails to run, then - it is almost certainly due to a conflict in compiled and installed Qt - versions and they will need to consult the section below on "Compiling - ParaView and the PV3FoamReader module." + ~/OpenFOAM/OpenFOAM- + ~/OpenFOAM/ThirdParty- - The default versions of Qt used by some GNU/Linux releases are as follows. - + ubuntu-7.10: Version 4.3.2 - + ubuntu-8.04: Version 4.3.4 - + openSuSE-10.2: Version 4.2.1 - too old - + openSuSE-10.3: Version 4.3.1 - + openSuSE-11.0: Version 4.4.0 - too new - - For openSuSE 10.2, 10.3 and 11.0, Qt version 4.3.5 can be downloaded from: - http://download.opensuse.org/repositories/KDE:/Qt43 - - Compilation and running of ParaView has been successful using the libraries - downloaded in the "libqt4-dev" package on ubuntu. + Both disk images support case-sensitive file names. If you wish to compile + OpenFOAM and Third Party packs from scratch, please create a case-sensitive + disk image using the Disk Utility, mount them as above and unpack the sources + at appropriate places. The remainder of build instructions is identical + to Linux. * Installation Download and unpack the files in the $HOME/OpenFOAM directory as described in: - http://www.OpenFOAM.org/download.html + http://www.extend-project.de/ The environment variable settings are contained in files in an etc/ directory in the OpenFOAM release. e.g. in + $HOME/OpenFOAM/OpenFOAM-/etc/ - + where corresponds to the version 1.4, 1.5, ... + + where corresponds to the version 1.6-ext etc 1) EITHER, if running bash or ksh (if in doubt type 'echo $SHELL'), source the etc/bashrc file by adding the following line to the end of your @@ -105,9 +93,10 @@ of the OpenFOAM installation. * Building from Sources (Optional) - If you cannot find an appropriate binary pack for your platform, you can build - the complete OpenFOAM from the source-pack. You will first need to compile or - obtain a recent version of gcc (we recomend gcc-4.3.?) for your platform, + If you cannot find an appropriate binary pack for your platform, you can + build the complete OpenFOAM from the source-pack. You will first need to + compile or obtain a recent version of gcc (we recomend native gcc, + coming with your operating system) for your platform, which may be obtained from http://gcc.gnu.org/. Install the compiler in @@ -133,7 +122,8 @@ * Getting Started Create a project directory within the $HOME/OpenFOAM directory named - - (e.g. 'chris-1.5' for user chris and OpenFOAM version 1.5) + - (e.g. 'jasak-1.6-ext' for user jasak and OpenFOAM + version 1.6-ext) and create a directory named 'run' within it, e.g. by typing: + mkdir -p $HOME/OpenFOAM/${USER}-${WM_PROJECT_VERSION}/run @@ -152,29 +142,18 @@ + icoFoam + paraFoam -* Compiling Paraview 3.3 and the PV3FoamReader module - A version of Qt 4.3.x must be installed to compile ParaView. The compilation - is a fairly simple process using the supplied buildParaView3.3-cvs script that - has worked is our tests with other packages supplied in the ThirdParty - directory, namely cmake-2.4.6 and gcc-4.3.1. Execute the following: - + cd $FOAM_INST_DIR/ThirdParty - + rm -rf ParaView3.3-cvs/platforms - + buildParaView3.3-cvs +* Documentation and Community resources + http://www.extend-project.de/ + http://openfoamwiki.net/ + http://www.cfd-online.com/ Software->OpenFOAM - The PV3FoamReader module is an OpenFOAM utility that can be compiled in the - usual manner as follows: - + cd $FOAM_UTILITIES/postProcessing/graphics/PV3FoamReader - + ./Allwclean - + ./Allwmake - -* Documentation - http://www.OpenFOAM.org/doc - -* Help - http://www.OpenFOAM.org http://www.OpenFOAM.org/discussion.html * Reporting Bugs in OpenFOAM - http://www.OpenFOAM.org/bugs.html + Please report all bugs and feature requests using our bug tracking system: + http://sourceforge.net/apps/mantisbt/openfoam-extend/main_page.php or + http://www.extend-project.de/project-final/openfoam-extend-bug-tracker + Please also report bugs at the CFD-Online User Forum. + * Running OpenFOAM in 32-bit mode on 64-bit machines Linux users with a 64-bit machine may install either the OpenFOAM 32-bit version (linux) or the OpenFOAM 64-bit version (linux64), or both. The 64-bit @@ -182,17 +161,24 @@ the user must set the environment variable $WM_32 (to anything, e.g. "on") before sourcing the etc/bashrc (or etc/cshrc) file. +* Instructions on how to contribute + http://www.extend-project.de/project-final/how-to-contribute + * List of Contributors Henry Weller Hrvoje Jasak Mattijs Janssens Zeljko Tukovic Tommaso Lucchini + Sandeep Menon Niklas Nordin Martin Beaudoin Eugene De Villiers Henrik Rusche Bernhard Gschaider + Ivor Clifford + Oliver Borm + Philiposse Rajan Chris Greenshields Mark Olesen Gavin Tabor diff --git a/ReleaseNotes-1.6-ext b/ReleaseNotes-1.6-ext new file mode 100644 index 000000000..d638e17d4 --- /dev/null +++ b/ReleaseNotes-1.6-ext @@ -0,0 +1,83 @@ +# -*- mode: org; -*- +# +#+TITLE: *OpenFOAM release notes for version 1.6-ext* +#+AUTHOR: Hrvoje Jasak. +#+DATE: 12 November 2010 +#+LINK: http://www.extend-project.de +#+OPTIONS: author:nil + +* Overview + OpenFOAM-1.6-ext is a formal release of the community developments in the + OpenFOAM software library, following the establishment of the -Extend Project + and web portal. + + This release includes an automatic test harness, which passes our standard + tests and tutorials. + +* Compatibility + OpenFOAM-1.6-ext is compatible with the OpenFOAM-1.6.x and 1.7.1 versions + of the code and incorporate most developments and changes from above versions + and ensure top-level compatibility. In some cases, the differences are + caused by bug fixes and algorithmic improvements, considered more important + than inter-operability. + + The list of developments is a result of the work of numerous contributors. + The Extend Project Admins would formally like to thank all contributors; + the list will be updated with further code development + +* Fundamental developments + Improvements in accuracy and stability on tetrahedral and tet-dominant meshes + Implicit coupled multi-domain solver + Block-implicit multi-equation matrix support + Proper Orthogonal Decomposition (POD) data analyss tools + Rewrite of Ordinary Differential Equation (ODE) and ODE solver classes + Dynamic remeshing classes, based on tetrahedral edge swapping + Radial Basis Function interpolation and mesh motion classes + Turbomachinery features: GGI interface, cyclic GGI, partial overlap GGI + Parallelisation of topological change engine + Support for parallelisation and topological changes in the Finite Area Method + Library preparation for Python/Swig interface for OpenFOAM: VulaSHAKA project + (http://sourceforge.net/projects/vulashaka/) + Basic implementation of OpenMP wrapping for multi-core support + +* Ongoing developments + This section lists the applications that existed in versions of OpenFOAM + but were abandoned by OpenCFD due to lack of expertise. In some cases, code + may still be present but it is buggy or unusable. The -Extend project line + maintains, validates and develops the features in contact with original + authors and contributes new features and bug fixes. + + Working parallel point mesh and field tools, shared between interpolation + and FEM discretisation solvers + FEM-based automatic mesh motion solver, with working parallelisation + Dynamic mesh features and topological mesh changes + The Finite Area Method: parallelisation, volume-to-surface mapping + New generation of linear equation solvers, including accelerated AMG + +* Developments to solvers (applications) + Basic 6-degree-of-freedom (6-DOF) solver + POD solver tools: prototype + Demonstration solver for fully implicit block-matrix coupling + +* Developments to utilities + New parallel decomposition and reconstruction formulation, with support + for topologically changing meshes + Level-set support tools + +* Model development + Transport models and top-level solver for visco-elasto-plastic flows + Updates to internal combustion engine simulation tools + Updated version of free surface tracking tools for free surface flows + Updated fluid-structure interaction solver with parallelisation support + Updated stress analysis tools, new large deformation solver formulation + +* Validation + Integrated automatic and publicly available test harness with ~150 cases + http://openfoam-extend.sourceforge.net/CDash/index.php + Community-driven test-case base to enhance code quality and integrity. + Contributions under + http://www.extend-project.de/project-final/openfoam-extend-test-harness + +* Other + The number of cumulative bug fixes compared to OpenFOAM-1.6.x is over + 5000; we will stop counting.