incorrect comment
[OpenFOAM-1.5.x.git] / ReleaseNotes-1.5
blob7a36d0fa3c252c79744a1afcae9af75fdb5f2c99
1 #                            -*- mode: org; -*-
3 #+TITLE:          *OpenFOAM release notes for version 1.5*
4 #+AUTHOR:                      OpenCFD Ltd.
5 #+DATE:                        14 July 2008
6 #+LINK:                  http://www.opencfd.co.uk
7 #+OPTIONS: author:nil
9 * Overview
10   OpenFOAM-1.5 is is a significant upgrade to version 1.4 in ways which are
11   outlined below.  This release passes all our standard tests and the tutorials
12   have been broadly checked.  If there are any bugs, please report them using
13   the instructions set out in: http://www.openfoam.org/bugs.html.
15   Most of the developments for this release are in: new applications, e.g. for
16   multiphase flow and cavitation, buoyancy-flow and heat transfer, high speed
17   flows and even molecular dynamics; new utilities, e.g. for meshing and case
18   monitoring; and, new modelling, e.g. in Lagrangian particle tracking,
19   radiation and rotating frames of reference.  With these new applications come
20   numerous new example cases.
22 * GNU/Linux version
23   The 64bit binary packs of the OpenFOAM release were compiled on a machine
24   running SuSE GNU/Linux version 10.3 and the 32bit on a machine running Ubuntu
25   GNU/Linux version 7.1 and also tested on Ubuntu 8.04.  We recommend that
26   users run OpenFOAM on one of these or a similar recent version of GNU/Linux.
27   This release has also been successfully compiled and tested on older GNU/Linux
28   releases but this requires the installation of Qt 4.3.? for ParaView-3 to run.
30 * C++ Compiler version
31   + Released compiled with GCC 4.3.1, the latest version.
32   + Built in support for the Intel C++ 10.? compiler (untested).
33   + The choice of the compiler is controlled by the setting of the $WM_COMPILER
34     and $WM_COMPILER_ARCH environment variables in the OpenFOAM-1.5/etc/bashrc
35     (or cshrc) file.
36   + The location of the installation of the compiler is controlled by the
37     $WM_COMPILER_INST environment variable in the OpenFOAM-1.5/etc/settings.sh
38     (or settings.csh) file.
40 * Developments to solvers (applications)
41   + New rhoCentralFoam solver for high-speed, viscous, compressible flows using
42     non-oscillatory, central-upwind schemes.
43   + New interDyMFoam solver for 2 incompressible, isothermal, immiscible fluids
44     using a VoF phase-fraction based interface capturing approach, with optional
45     mesh motion and mesh topology changes including adaptive mesh
46     (un)refinement.  Useful for simulations such as tank filling, sloshing ---
47     using solid body motion e.g. SDA or SKA (6DoF) --- and slamming (using the
48     mesh motion solver) and other large-scale applications that benefit from the
49     efficiency gain of adaptive mesh (un)refinement of the interface.
50   + New compressibleInterFoam solver for 2 compressible, isothermal, immiscible
51     fluids using a volume of fluid (VoF) phase-fraction approach for
52     interface-capturing.  The momentum and other fluid properties are of the
53     "mixture" and a single momentum equation is solved.  Turbulence is modelled
54     using a run-time selectable incompressible LES model.
55   + New interPhaseChangeFoam solver for 2 incompressible, isothermal, immiscible
56     fluids with phase-change, e.g. cavitation.  Uses VoF interface capturing,
57     with momentum and other fluid properties described for the ``mixture'' and a
58     single momentum equation is solved.  The set of phase-change models provided
59     are designed to simulate cavitation but other mechanisms of phase-change are
60     supported within this solver framework.
61   + New rasCavitatingFoam solver for transient cavitation using a barotropic
62     compressibility model, with RAS turbulence.
63   + New lesCavitatingFoam solver for transient cavitation using a barotropic
64     compressibility model, with LES turbulence.
65   + New chtMultiRegionFoam solver that couples conjugate heat transfer in a
66     solid to a buoyancy-driven flow simulation.
67   + New PDRFoam solver for compressible premixed/partially-premixed turbulent
68     combustion that includes porosity/distributed resistance (PDR) modelling to
69     handle regions containing solid blockages which cannot be resolved by the
70     mesh.  Requires the PDR fields.
71   + New lesBuoyantFoam solver for transient, buoyant, turbulent flow of
72     compressible fluids for ventilation and heat-transfer. Turbulence is
73     modelled using a run-time selectable compressible LES model.
74   + New rhoPimpleFoam solver for transient, turbulent flow of compressible
75     fluids for ventilation and heat-transfer. Uses the flexible PIMPLE
76     (PISO-SIMPLE) solution for time-resolved and pseudo-transient simulations.
77   + New buoyantSimpleRadiationFoam solver for steady-state, buoyant, turbulent
78     flow of compressible fluids with radiation, for ventilation and
79     heat-transfer.
80   + New rhoTurbTwinParcelFoam solver for transient for compressible, turbulent
81     flow with two thermo-clouds.
82   + New gnemdFOAM solver for general purpose molecular dynamics that simulates
83     atoms in arbitrary shaped domains and average atomic/molecular quantities to
84     the mesh to create field data.
85   + New mdEqulibrationFoam solver to equilibrates and/or preconditions molecular
86     dynamics systems.
87   + Demonstration SRFSimpleFoam solver based on simpleFoam that incorporates the
88     SRF extensions (see below) for rotating flows.
90 * Automatic mesher
91   New snappyHexMesh utility that generates split-hex meshes automatically from
92   triangulated (STL) surface geometries.  The mesh approximately conforms to
93   the surface by iteratively refining a starting mesh and morphing the
94   resulting split-hex mesh to the surface.  An optional phase will shrink back
95   the resulting mesh and insert cell layers.  It has a flexible specification
96   of mesh refinement level and robust surface handling with a pre-specified
97   final mesh quality.  It runs in parallel with a load balancing step every
98   iteration.
100 * Developments to utilities
101   + New extrude2DMesh utility that extrudes 2D meshes into a 3D mesh.  2D meshes
102     are described by faces with 2 points, so can be used in combination with 2D
103     meshes converted with ccm26ToFoam.
104   + New couplePatches functionality integrated into createPatch, which
105     optionally synchronises ("couples") points and faces of coupled (cyclic,
106     processor) patches.
107   + New applyBoundaryLayer pre-processing utility to apply 1/7th power-law
108     boundary layers at walls, starting from uniform or potential flow solutions.
109   + New execFlowFunctionObjects utility executes functionObjects as a
110     post-processing activity, e.g. probes, sampling, force calculation.
111   + New changeDictionary utility makes batch changes to OpenFOAM input files,
112     e.g. to change boundary conditions of field files.
113   + New foamCalc utility, a generic post-processing field calculator tool
114   + New molConfig pre-processing utility for molecular dynamics cases.  Fills
115     zones of a mesh with single crystal lattices of specified structure,
116     density, orientation, alignment and temperature.
117   + Extended splitMeshRegions utility to split multi-zone meshes, e.g. defined
118     through cellZones, into separate meshes.
119   + Extended the foamToVTK, decomposePar, reconstructPar and mapFields utilities
120     to include support for multiple particle clouds in parallel processing.
122 * Migration from ParaView 2.4 to ParaView 3.x
123   + Rewritten OpenFOAM Reader Module for version 3, a major redesign of
124     ParaView.
125   + New features include viewing patch names, reading of Lagrangian data,
126     handling of cell, face and point sets, multiple views.
128 * Model development
129   + Overhauled the lagrangian library to support multiple clouds.
130   + New lagrangianIntermediate library incorporating a hierarchy of parcel and
131     cloud types, accommodating kinematic, thermodynamic and reacting
132     applications, including coupling to the new radiation library. Sub-models
133     are added at the relevant level of physics, e.g.:
134     - kinematic: injection, wall interaction, drag, dispersion;
135     - thermo: heat transfer;
136     - reacting: reacting composition, mass transfer, surface reactions.
137   + New single rotating frame of reference (SRF) library for rotating flow
138     applications, e.g. turbo-machinery.
139   + New radiation library including the P1 model and associated Marshak boundary
140     conditions for incident radiation.
141   + New displacementInterpolation motion solver for flexible mesh scaling.
142   + New molecularDynamics Lagrangian library to calculate intermolecular forces
143     between spherically symmetrical monatomic species in arbitrary geometries.
145 * New functionObjects
146   To aid common monitoring and post-processing activities.
147   + forces: calculate the force and moment on a patch or set of patches, e.g. to
148     calculate the lift, drag and moment of an object in the flow.
149   + forceCoeffs: calculate the normalised force and moment on a patch or set of
150     patches, e.g. to calculate the lift, drag and moment coefficients of an
151     object in the flow.
152   + fieldAverage: calculate field arithmetic mean and prime-squared averages for
153     a list of fields.
154   + foamCalcFunctions: calculate field components, div, mag, magGrad or magSqr.
156 * Improvements to boundary conditions
157   + Generalised jumpCyclic type: cyclic condition with an additional prescribed
158     jump in value.
159   + fan type: specialisation of jumpCyclic, applying a prescribed jump in
160     pressure to simulate a fan within a mesh.
161   + Generalised advective outflow boundary condition based on solving D/Dt(psi,
162     U) = 0 at the boundary.
163   + Additional turbulent flow inlet to specify mixing length and frequency.
164   + Generalisation of time varying set of boundary conditions.
166 * Other
167   + New argument-free command execution, e.g typing "icoFoam" without root and
168     case directory arguments.
169   + Extended time command line options.
170   + Many enhancements to dictionary including macro substitution, optional
171     merging and default/overwrite behaviour, enhanced "#include" file handling
172     and the framework to support function evaluation.
173   + Cross-links between applications and Doxygen documentation with the "-doc"
174     argument.
175   + Non-blocking, non-buffered, parallel transfers with potential scaling
176     benefits for larger number of processors.