From fbf4d9ec10b4192258c78d94e5b0271734428799 Mon Sep 17 00:00:00 2001
From: Henry <Henry>
Date: Wed, 29 Sep 2010 22:09:17 +0100
Subject: [PATCH] Reorganised documentation
---
README | 209 ----------------------
ReleaseNotes-1.6 | 374 ---------------------------------------
TODO => doc/changes/TODO | 17 +-
3 files changed, 1 insertion(+), 599 deletions(-)
delete mode 100644 README
delete mode 100644 ReleaseNotes-1.6
rename TODO => doc/changes/TODO (82%)
diff --git a/README b/README
deleted file mode 100644
index d2a992048cf..00000000000
--- a/README
+++ /dev/null
@@ -1,209 +0,0 @@
-# -*- mode: org; -*-
-#
-#+TITLE: OpenFOAM README for version 1.6
-#+AUTHOR: OpenCFD Ltd.
-#+DATE: April 2010
-#+LINK: http://www.opencfd.co.uk
-#+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 3 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.
-
-* System requirements
- OpenFOAM is developed and tested on Linux, but should work with other POSIX
- systems. 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.
-
- 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.7.0 visualisation package requires Qt to be installed on the
- system. ParaView's producers state that ParaView is only officially
- supported on Qt version 4.6.x. However, we have found in limited tests that
- ParaView works satisfactorily with Qt than 4.5.x. To
- check whether Qt4 is installed, and the version, type:
- + qmake --version
-
- Both 32-bit and 64-bit version of ParaView were compiled with Qt-4.4.3 (with
- openSUSE-11.1). 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."
-
- 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
- + ubuntu-9.04: Version 4.5.0
- + openSUSE-10.2: Version 4.2.1 - too old
- + openSUSE-10.3: Version 4.3.1
- + openSUSE-11.0: Version 4.4.0
- + openSUSE-11.1: Version 4.4.3
- + openSUSE-11.2: Version 4.5.3
-
- Compilation and running of ParaView has been successful using the libraries
- downloaded in the "libqt4-dev" package on ubuntu.
-
- If you don't have an appropriate version of Qt installed you can download
- the sources e.g.:
- http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.2.tar.gz
- and compile and install in /usr/local or some other location that does not
- conflict with the pre-installed version.
-
-* Installation
- Download and unpack the files in the $HOME/OpenFOAM directory as described in:
- http://www.OpenFOAM.org/download.html
-
- The environment variable settings are contained in files in an etc/ directory
- in the OpenFOAM release. e.g. in
-
- + $HOME/OpenFOAM/OpenFOAM-1.6/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
- $HOME/.bashrc file:
-
- + . $HOME/OpenFOAM/OpenFOAM-1.6/etc/bashrc
-
- Then update the environment variables by sourcing the $HOME/.bashrc file by
- typing in the terminal:
-
- + . $HOME/.bashrc
-
- 2) OR, if running tcsh or csh, source the etc/cshrc file by adding the
- following line to the end of your $HOME/.cshrc file:
-
- + source $HOME/OpenFOAM/OpenFOAM-1.6/etc/cshrc
-
- Then update the environment variables by sourcing the $HOME/.cshrc file by
- typing in the terminal:
-
- + source $HOME/.cshrc
-
-*** Installation in alternative locations
- OpenFOAM may also be installed in alternative locations. However, the
- installation directory should be network available (e.g., NFS) if parallel
- calculations are planned.
-
- The environment variable 'FOAM_INST_DIR' can be used to find and source the
- appropriate resource file. Here is a bash/ksh/sh example:
-
- + export FOAM_INST_DIR=/data/app/OpenFOAM
- + foamDotFile=$FOAM_INST_DIR/OpenFOAM-1.6/etc/bashrc
- + [ -f $foamDotFile ] && . $foamDotFile
-
- and a csh/tcsh example:
-
- + setenv FOAM_INST_DIR /data/app/OpenFOAM
- + foamDotFile=$FOAM_INST_DIR/OpenFOAM-1.6/etc/cshrc
- + if ( -f $foamDotFile ) source $foamDotFile
-
- The value set in '$FOAM_INST_DIR' will be used to locate the remaining parts
- 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 recommend gcc-4.4.?) for your platform,
- which may be obtained from http://gcc.gnu.org/.
-
- Install the compiler in
- $WM_THIRD_PARTY_DIR/platforms/$WM_ARCH$WM_COMPILER_ARCH/gcc-<GCC_VERSION>
- and change the gcc version number in $WM_PROJECT_DIR/etc/settings.sh and
- $WM_PROJECT_DIR/etc/settings.csh appropriately and finally update the
- environment variables as in section 3.
-
- Now go to the top-level source directory $WM_PROJECT_DIR and execute the
- top-level build script './Allwmake'. In principle this will build everything,
- but if problems occur with the build order it may be necessary to update the
- environment variables and re-execute './Allwmake'.
-
- If you experience difficulties with building the source-pack, or your platform
- is not currently supported, please contact <enquiries@OpenCFD.co.uk> to
- negotiate a support contract and we will do the port and maintain it for
- future releases.
-
-* Testing the installation
- To check your installation setup, execute the 'foamInstallationTest' script
- (in the bin/ directory of the OpenFOAM installation). If no problems are
- reported, proceed to getting started with OpenFOAM; otherwise, go back and
- check you have installed the software correctly and/or contact your system
- administrator.
-
-* Getting Started
- Create a project directory within the $HOME/OpenFOAM directory named
- <USER>-1.6 (e.g. 'chris-1.6' for user chris and OpenFOAM version 1.6)
- and create a directory named 'run' within it, e.g. by typing:
-
- + mkdir -p $FOAM_RUN/run
-
- Copy the 'tutorial' examples directory in the OpenFOAM distribution to the
- 'run' directory. If the OpenFOAM environment variables are set correctly,
- then the following command will be correct:
-
- + cp -r $WM_PROJECT_DIR/tutorials $FOAM_RUN
-
- Run the first example case of incompressible laminar flow in a cavity:
-
- + cd $FOAM_RUN/tutorials/incompressible/icoFoam/cavity
- + blockMesh
- + icoFoam
- + paraFoam
-
- Refer to the OpenFOAM User Guide at http://www.OpenFOAM.org/doc/user.html for
- more information.
-
-* Compiling Paraview 3.7.0 and the PV3FoamReader module
- If there are problems encountered with ParaView, then it may be necessary to
- compile ParaView from sources. The compilation
- is a fairly simple process using the makeParaView script
- (found in ThirdParty directory), which has worked in our tests with other
- packages supplied in the ThirdParty directory, namely cmake-2.8.0 and
- gcc-4.4.3. Execute the following:
- + cd $WM_THIRD_PARTY_DIR
- + rm -rf paraview-3.7.0/platforms
- + rm -rf platforms/*/paraview-3.7.0
- + ./makeParaView
-
- The PV3blockMeshReader and the PV3FoamReader ParaView plugins are compiled
- as usual for OpenFOAM utilities:
- + cd $FOAM_UTILITIES/postProcessing/graphics/PV3Readers/
- + ./Allwclean
- + ./Allwmake
-
-*** Compiling Paraview with a local version of Qt
- If the user still encounters problems with ParaView, it may relate to the
- version of Qt, in which case, it is recommended that the user first
- downloads a supported version of Qt /e.g./ 4.5.3 as described in the section
- on "Qt". The user should unpack the source pack in the $WM_THIRD_PARTY_DIR.
- Then the user can build Qt by executing from within $WM_THIRD_PARTY_DIR:
- + ./makeQt
-
- The user should then compile ParaView using the local version of Qt by
- executing makeParaView with the -qmake option, giving the full path of the
- newly built qmake as an argument:
- + ./makeParaView -qmake <path_to_qmake>
-
- The user must then recompile the PV3blockMeshReader and the
- PV3FoamReader plugins as usual (see above).
-
-* 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
-
-* 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
- is the default mode on a 64-bit machine. To use an installed 32-bit version,
- the user must set the environment variable WM_ARCH_OPTION to 32 before
- sourcing the etc/bashrc (or etc/cshrc) file.
diff --git a/ReleaseNotes-1.6 b/ReleaseNotes-1.6
deleted file mode 100644
index 545021a6b3c..00000000000
--- a/ReleaseNotes-1.6
+++ /dev/null
@@ -1,374 +0,0 @@
-# -*- mode: org; -*-
-#
-#+TITLE: OpenFOAM release notes for version 1.6
-#+AUTHOR: OpenCFD Ltd.
-#+DATE: July 2009
-#+LINK: http://www.opencfd.co.uk
-#+OPTIONS: author:nil ^:{}
-
-* Overview
- OpenFOAM-1.6 is a significant upgrade to version 1.5 in ways that are
- outlined below. This release passes all our standard tests and the
- tutorials have been broadly checked. If there are any bugs, please report
- them using the instructions set out here:
- http://www.OpenFOAM.org/bugs.html.
-
-* GNU/Linux version
- The 32bit and 64bit binary packs of the OpenFOAM release were compiled on
- a machine running openSUSE GNU/Linux version 11.1 and also tested on
- Ubuntu 9. We recommend that users run OpenFOAM on one of these, or on a
- similarly recent version of GNU/Linux. This release has also been
- successfully compiled and tested on older GNU/Linux releases, but this
- requires the installation of Qt 4.3.? (the sources for which are supplied
- with OpenFOAM-1.6, see README) for ParaView-3 to run.
-
-* C++ Compiler version
- + Release compiled with GCC 4.3.3.
- + Built-in support for the Intel C++ 10.? compiler (untested).
- + The choice of the compiler is controlled by the setting of the
- ~$WM_COMPILER~ and ~$WM_COMPILER_ARCH~ environment variables in the
- /OpenFOAM-1.6/etc/bashrc/ (or /cshrc/) file.
- + The location of the compiler installation is controlled by the
- ~$compilerInstall~ environment variable in the
- /OpenFOAM-1.6/etc/settings.sh/ (or /settings.csh/) file.
-
-* Library developments
-
-*** Core library
-
-***** Dictionary improvements/changes
- + Dictionaries can use words (unquoted) or regular expressions (quoted)
- for their keywords. When searching, an exact match has priority over a
- regular expression match. Multiple regular expressions are matched in
- reverse order.
- + The *new* =#includeIfPresent= directive is similar to the =#include=
- directive, but does not generate an error if the file does not exist.
- + The default =#inputMode= is now '=merge=', which corresponds to the most
- general usage. The =#inputMode warn= corresponds to the previous default
- behaviour.
- + The *new* =#inputMode protect= can be used to conditionally merge
- default values into existing dictionaries.
- + *New* =digest()= method to calculate and return the SHA1 message digest.
-
-***** Regular Expressions
- The addition of regular expressions marks a major improvement in
- usability.
- + *New* =regExp= class provides support for accessing POSIX extended
- regular expresssions from within OpenFOAM.
- + *New* =wordRe= class can contain a =word= or a =regExp= .
- + *New* =stringListOps= to search string lists based on regular
- expressions, =wordRe= or =wordReList=.
- + =Istream= and =Ostream= now retain backslashes when reading/writing
- strings.
-
-***** Convenience changes
- + =IOobject= has a *new* constructor for creating an =IOobject= from a
- single-path specification (eg, see =blockMesh -dict= option).
- + =argList= has *new* convenience methods for accessing options more
- directly: =option()=, =optionFound()=, =optionLookup()=, =optionRead()=,
- =optionReadIfPresent()=.
- + The *new* =readList(Istream&)= can read a bracket-delimited list or
- handle a single value as a list of size 1. This can be a useful
- convenience when processing command-line options.
- + Export *new* environment variable =FOAM_CASENAME= that contains the
- name part of the =FOAM_CASE= environment variable.
-
-*** Turbulence modelling
- + Major development of turbulence model libraries to give extra flexibility
- at the solver level. For solvers that can support either RAS/LES
- computations, the selection is made in the
- /constant/turbulenceProperties/, by setting the =simulationType= keyword
- to:
- - =laminar=,
- - =RASModel=,
- - =LESModel=.
- + Depending on the selection, the model is the instantiated from /constant//
- - /RASProperties/,
- - /LESProperties/.
-
-***** RAS wall functions
- Wall functions are now run-time selectable per patch for RAS.
- + Velocity:
- - Apply to turbulent viscosities =nut= or =mut=,
- - Apply to =k=, =Q=, =R=,
- - Apply to =epsilon=, =omega=.
- + Temperature:
- - Apply to turbulent thermal diffusivity, =alphat= (compressible only).
- + To apply wall functions:
- - To recapture the functionality of previous OpenFOAM versions (v1.5 and
- earlier) assign:
- - for velocity:
- - =nut=: =nutWallFunction=,
- - =mut=: =muWallFunction=,
- - =epsilon=: =epsilonWallFunction=,
- - =omega=: =omegaWallFunction=,
- - =k=, =q=, =R=: =kqRWallFunction=.
- - for temperature:
- - =alphat=: =alphatWallFunction=.
- - New =alphaSgsJayatillekeWallFunction= thermal wall function for
- compressible LES.
-
-***** *New* LES turbulence models
- + Spalart-Allmaras DDES.
- + Spalart-Allmaras IDDES.
-
-***** Upgrading:
- + *New* utility - =applyWallFunctionBoundaryConditions=.
- + Solvers will automatically update existing cases.
- - New fields created based on the presence of the =nut/mut= field.
- - Boundary conditions include scoping, i.e compressibility:: for
- compressible solvers.
- - Modified fields will be backed-up to /<field>.old/.
- + NOTE:
- - Fields are only updated for those fields associated with the current
- turbulence model selection, i.e. if fields exist for use with other
- models, they will not be updated.
- - The new specification is not backwards compatible.
-
-*** Thermo-physical Models
- + Old compressibility-based thermo package renamed
- =basicThermo= \rightarrow =basicPsiThermo=.
- + *New* =basicRhoThermo= thermo package.
- - Additional density field stored.
- - General form - can be used for other types of media, e.g. liquids.
- - Additional polynomial-based thermodynamics:
- - Equation of state: =icoPolynomial=,
- - Transport: =polynomialTransport=,
- - Thermo: =hPolynomialThermo=.
- + Removed earlier hard-coding of gas thermophysics for chemistry modelling:
- - =reactingMixture= now templated on thermo package,
- - =chemistryModel= now templated on thermo package,
- - =chemistrySolver= now templated on thermo package.
- + *New* =fvDOM= radition model
- - finite volume, discrete ordinates method.
- + *New* (reinstated) =eThermo= thermodynamics package
- - internal energy-based thermodynamics.
-
-*** Lagrangian
-
-***** Intermediate
- + Overhaul of the underlying framework.
- + Reacting now split into reacting and reacting multiphase.
- + New structure for variable composition.
- + Many new sub-models, including:
- - Injection
- - =PatchInjection= - injection local to patch face cells,
- - =FieldActivatedInjection= - injection based on satisfying external
- criterion,
- - LookupTableInjection - explicity define injection locations and all
- parcel properties.
- - Post-processing
- - patch post-processing - collect data for parcels impacting user,
- defined patches.
- - Patch interaction
- - generalised behaviour for parcel interaction with patch.
- - Phase change
- - liquid evaporation.
-
-***** Coal combustion
- + *New* library - extension of reacting-multiphase functionality.
- - Surface reaction/combustion models.
-
-*** Discrete methods
- + *New* library offering DSMC simulation functionality - see =dsmcFoam=
- below.
- + Significant development of the libraries offering molecular dynamics
- simulation functionality - see =mdFoam= and =mdEquilibrationFoam= below.
-
-*** Numerics
- + *new* polynomial-fit higher-order interpolation schemes:
- - =biLinearFit=
- - =linearFit=
- - =quadraticLinearFit=
- - =quadraticFit=
- - =linearPureUpwindFit=
- - =quadraticLinearPureUpwindFit=
- - =quadraticLinearUpwindFit=
- - =quadraticUpwindFit=
- - =cubicUpwindFit=
- + *new* polynomial-fit higher-order Sn-Grad: =quadraticFitSnGrad=.
-
-*** *New* surfMesh library
- Provides a more efficient storage mechanism than possible with =triSurface=
- without restrictions on the shape of the face (templated parameter).
- + =MeshedSurface= class - with zero or more contiguous =surfZones= .
- + =UnsortedMeshedSurface= class - unordered surface zones (as per
- =triSurface=).
- + =surfMesh= class - for reading/writing in native OpenFOAM format.
-
-* Solvers
-*** Solver restructuring
- The upgrade to the turbulence models means that the simulation type, i.e.
- laminar, RAS or LES can be selected at run time. This has allowed a reduction
- in the number of solvers, simplifying the overall code structure
- + Solvers which support laminar, RAS and LES:
- - =turbFoam=, =oodles= \rightarrow =pisoFoam=.
- - =turbDyMFoam= \rightarrow =pimpleDyMFoam=.
- - =rhoTurbFoam=, =coodles= \rightarrow =rhoPisoFoam=.
- - =xoodles= \rightarrow absorbed into =XiFoam=.
- - =buoyantFoam=, =lesBuoyantFoam= \rightarrow =buoyantPisoFoam=.
- - =interFoam=, =rasInterFoam=, =lesInterFoam= \rightarrow =interFoam=.
- - =lesCavitatingFoam=, =rasCavitatingFoam= \rightarrow =cavitatingFoam=.
- + Solvers which support LES only:
- - =channelOodles= \rightarrow =channelFoam= (LES).
- + =pd= replaced by static pressure =p=. All solvers in which buoyancy affects
- might be strong have been converted from using =pd= to =p= with improved
- numerics to give equally good accuracy and stability. This change is
- prompted by the need to remove the confusion surrounding the meaning and
- purpose of =pd=.
- + =g= (acceleration due to gravity) is now a *new*
- =uniformDimensionedVectorField= which has the behaviour of a field, is
- registered to an =objectRegistry=, but stores only a single value. Thus
- =g= and other =UniformDimensionedFields= can be created and looked-up
- elsewhere in the code, /e.g./ in =fvPatchFields=.
-
-*** Solver control improvements
- Now uses consistent dictionary entries for the solver controls.
- + This Allows dictionary substitutions and regular expressions in
- /system/fvSolution/.
- + The old solver control syntax is still supported (warning emitted), but
- the *new* =foamUpgradeFvSolution= utility can be used to convert
- /system/fvSolution/ to the new format.
-
-*** *New* Solvers
- + =buoyantBoussinesqSimpleFoam= Steady state heat transfer solver using a
- Boussinesq approximation for buoyancy, with laminar, RAS or LES turbulence
- modelling.
- + =buoyantBoussinesqPisoFoam= Transient heat transfer solver using a
- Boussinesq approximation for buoyancy, with laminar, RAS or LES turbulence
- modelling.
- + =coalChemistryFoam= Transient, reacting lagrangian solver, employing a coal
- cloud and a thermo cloud, with chemistry, and laminar, RAS or LES turbulence
- modelling.
- + =porousExplicitSourceReactingParcelFoam= Transient, reacting lagrangian
- solver, employing a single phase reacting cloud, with porous media, explicit
- mass sources, and laminar, RAS or LES turbulence modelling.
- + =rhoReactingFoam= Density-based thermodynamics variant of the reactingFoam
- solver, i.e. now applicable to liquid systems.
- + =dsmcFoam= DSMC (Direct Simulation Monte-Carlo) solver for rarefied gas
- dynamics simulations, able to simulate mixtures of an arbitrary number of
- gas species. The variable hard sphere collision model with Larsen-Borgnakke
- internal energy redistribution (see "Molecular Gas Dynamics and the Direct
- Simulation of Gas Flows" G.A. Bird, 1994) is available; other run-time
- selectable collision models can be easily added.
-
-*** Updated solvers
- + =mdFoam= Molecular Dynamics (MD) solver able to simulate a mixture of an
- arbitrary number of mono-atomic and small, rigid polyatomic (i.e. H2O, N2)
- molecular species, with 6 degree of freedom motion, in complex geometries. A
- molecule of any species can be built by specifying its sites of mass and
- charge. All molecules interact with short-range dispersion forces and
- pairwise electrostatic interactions using methods described in: Fennell and
- Gezelter, J. Chem. Phys. 124, 234104 (2006).
- + =mdEquilibrationFoam= Similar to mdFoam, but employs velocity scaling to
- adjust the simulation temperature to a target value. Useful to equilibrate a
- case before simulation.
- + =chtMultiRegionFoam= New boundary condition allows independent decomposition
- of coupled regions without any constraint on the decomposition.
-
-* Boundary conditions
- + Improved set of direct mapped boundary conditions.
- + =buoyantPressureFvPatchScalarField=, the *new* buoyancy pressure boundary
- condition now supports =p= and =pd= for backward compatibility.
- + =uniformDensityHydrostaticPressure= is an additional pressure boundary
- condition to aid the transition from =pd= to =p= as it behaves similarly to
- specifying a uniform =pd= at an outlet for example.
- + =activeBaffleVelocity= dynamically combines cyclic and wall patches so that
- the flow through the patch can be controlled /e.g./ by pressure drop.
- + =rotatingWallVelocity= specifies a rotating velocity, given the rotational
- speed, origin and axis.
-
-* Utilities
-
-*** Improvements
- + =blockMesh= has a *new* =-dict= option for specifying an alternative
- dictionary for the block mesh description. The '=convertToMeters=' entry
- is now optional, and the alternative '=scale=' entry can be used for
- less typing.
- + =foamToEnsight= has a *new* =-noPatches= option to suppress generation
- of patches.
- + =foamToEnsightParts= has *new* =-noMesh= and =-index= options that can
- be useful when post-processing results incrementally.
- + =snappyHexMesh= has lower memory footprint. New distributed triangulated
- surface type for meshing surfaces with extremely large triangle count.
- Now supports multi-region meshing of arbitrarily complex regions.
-
-*** *New* utilities
- + =particleTracks= - generate particle tracks for lagrangian calculations.
- + =dsmcInitialise= - preprocessing utility to create initial configurations
- of DSMC particles in a geometry.
- + =surfaceRedistributePar= - preprocessing utility to create distributed
- triangulated surface.
-
-*** *New* foamCalc functions
- + =interpolate= performs fvc::interpolate(<field>).
- + =randomise= randomises a <field> by a given perturbation.
- + =addSubtract= provides simple add/subtract field functionality.
-
-*** Usage
- + =timeSelector= can now combine =-time ranges= and =-latestTime= options.
- For example, -time '0.01:0.09' -latestTime vs. -time '0.01:'.
- More reliable behaviour for cases missing /constant// or /0// directories.
- When the =-noZero= option is enabled, =-latestTime= will not select the
- =0/= directory unless the =-zeroTime= option is given.
- This helps avoid ill effects caused by accidentally using the
- /0// directory in certain utilities (eg, =reconstructPar=).
- + =-region= option added to more utilities.
-
-*** Improvements to Paraview reader module
- + =PV3FoamReader= added mesh region handling. The region name is parsed
- from the filename. Eg, /case{region}.OpenFOAM/.
- + =paraFoam= with a *new* =-region= option for specifying an alternative
- region. A *new* =-touch= option to generate the /.OpenFOAM/ file only.
- Only creates (and removes) /.OpenFOAM/ files if they didn't already
- exist, which is useful in connection with the =-touch= option.
-
-* Post-processing
- + Sampling on iso-surfaces, interpolated or non-interpolated.
- + Sampling on surface defined by distance to surface (=distanceSurface=).
- + Cutting planes for arbitrary meshes.
- + Output to any surface geometry format supported by the =surfMesh= library.
-
-*** Function objects
-
-***** Improvements for function objects and time-looping
- + The =functionObjectList= retains the order of the =functionObject=
- order, which allows a chaining of operations. It is thus internally more
- efficient when /system/controlDict/ uses =functions {..}= instead of
- =functions (..)=, but both forms are supported.
- + The =functionObject= now has an additional =end()= method that is called
- when =Time::loop()= or =Time::run()= determine that the time-loop exits.
- Accordingly, one of these two idioms should be used in solver code:
- 1. =while (runTime.loop() { ... }=,
- 2. =while (runTime.run()) { runTime++; ... }=.
- + *New* =functionObjectList= now tracks the SHA1 message digest of the
- sub-directories. This avoids reloading a =functionObject= when
- something unrelated in /system/controlDict/ changed.
-
-***** *New* function objects:
- + =systemCall= - executes a list of system instructions.
- + =fieldMinMax= - computes the min/max of a <field>.
- + =staticPressure= - converts kinematic pressure to static pressure.
- + =dsmcFields= - calculates intensive fields (velocity and temperature)
- from averaged extensive fields (i.e. momentum and energy).
-
-***** Usage
- + Improved output control: =timeStep= or =outputTime=.
-
-* Tutorial restructuring
- to reflect solver application structure.
-
-* Third-party Software
- + =gcc= upgraded to version 4.3.3.
- + =OpenMPI= upgraded to version 1.3.3.
- + =ParaView= upgraded to version 3.6.1.
- + =Scotch= *new* decomposition method: \\
- Scotch (http://gforge.inria.fr/projects/scotch/) is a general multi-level
- decomposition method originating from the ScAlApplix project (Inria). It is
- a framework for general recursive partitioning methods and a such comparable
- to Metis but with a permissive licence.
-
- The corresponding decomposition method (in =decomposeParDict=) is
- =scotch=. An optional =strategy= string can be supplied to change the
- decomposition methods; initial testing shows the default strategy producing
- decompositions comparable in quality to Metis.
diff --git a/TODO b/doc/changes/TODO
similarity index 82%
rename from TODO
rename to doc/changes/TODO
index aab3581489b..01a120bb9ef 100644
--- a/TODO
+++ b/doc/changes/TODO
@@ -1,23 +1,8 @@
-- check
+- check
new fvMesh
new fvMeshSubset
for consistency with createMesh.H
-
-
- Check the following:
doc/changes/inotify.txt
-
-
-
-
-
-
-
-
-
-
-
-
-
--
GitLab