upgrade

General
Repository migration
- Post-process utility

Version	User	Developer	Release notes
v2012 (current)	User	Developer	Release notes
v2006	User	Developer	Release notes
v1912	User	Developer	Release notes
v1906	User	Developer	Release notes
v1812	User	Developer	Release notes
v1806	User	Developer	Release notes
v1712	User	Developer	Release notes
v1706	User	Developer	Release notes
v1612	User	Developer	Release notes
v1606	User	Developer	Release notes
v3.0+	User	Developer	Release notes
v2106(develop)	User	Developer	-

General

To ease migration and enhance compatibility, OpenFOAM provides a number of macro definitions and dictionary compatibility lookups.

API-level

The OpenFOAM wmake rules provide an API-level definition that can be used within the code. For example,

#if (OPENFOAM >= 1912)
...
#endif

Compatibility with .org

when porting some existing code from the openfoam.org variant, the COMPAT_OPENFOAM_ORG define can be used to provide some assistance. It primarily handles deviations in dictionary methods and the names of some constants (eg, GREAT vs great).

Deprecations

Changing the meaning of methods and their parameters is avoided wherever possible. When a method is replaced with a new method, or uses a different preferred type of parameters, a FOAM_DEPRECATED_FOR deprecation macro is used to create a compile-time warning message. This allows ample time to migrate methods, generally with a suggested replacement. At some point in the future, these deprecated methods may be removed entirely.

There may also be various methods where we would wish to deprecate them, but they are still used too heavily. For some of these, we have defines within the header to track or selectively enable/disable them.

A non-exhaustive list (check the corresponding files for more detail):

File	Defines
argList.H	Foam_argList_1712
autoPtr.H	Foam_autoPtr_castOperator
autoPtr.H	Foam_autoPtr_copyConstruct
autoPtr.H	Foam_autoPtr_deprecate_setMethod
doubleScalar.H	Foam_no_besselFunc
floatScalar.H	Foam_no_besselFunc
IOstream.H	Foam_IOstream_extras
surfaceWriter.H	Foam_surfaceWriter_directAccess

Repository migration

As of December 2019, the OpenFOAM repository is named openfoam. If you have an older version using OpenFOAM-plus as a repository, you should read information about repository migration.

Post-process utility

The postProcess upgrade; utility and solver option.