openfoam/modules
Mark Olesen 48d654cf19 ENH: avoid memory leaks for HashPtrTable, PtrMap insertion (issue #749)
- disallow insert() of raw pointers, since a failed insertion
  (ie, entry already existed) results in an unmanaged pointer.

  Either insert using an autoPtr, or set() with raw pointers or autoPtr.

- IOobjectList::add() now takes an autoPtr instead of an object reference

- IOobjectList::remove() now returns an autoPtr instead of a raw pointer
2018-05-17 09:56:36 +01:00
..
avalanche@6e6e105844 SUBMODULE: updates for avalanche, catalyst, cfmesh 2018-05-11 15:29:00 +02:00
catalyst@d31e13e12b ENH: avoid memory leaks for HashPtrTable, PtrMap insertion (issue #749) 2018-05-17 09:56:36 +01:00
cfmesh@288f05e08f SUBMODULE: updates for avalanche, catalyst, cfmesh 2018-05-11 15:29:00 +02:00
doc CONFIG: add additional modules/ directory and Module namespace 2017-12-13 17:36:35 +01:00
README.md STYLE: update BuildIssues with CGAL mpfr-none problem (issue #674) 2017-12-21 10:38:57 +01:00

OpenFOAM Modules

This directory is a location for additional OpenFOAM components or tools to placed and have them built as part of the normal OpenFOAM build process. It is assumed that each subdirectory contain an appropriate Allwmake file, and that they in all likelihood also build into $FOAM_APPBIN and $FOAM_LIBBIN instead of $FOAM_USER_APPBIN and $FOAM_USER_LIBBIN.

These additional components may be added as git submodules, by script or by hand.

git

On the first use, it will be necessary to register the submodules:

git submodule init

This will clone the relevant submodules from their respective repositories.

The following will indicate the current state:

git submodule status

On the first use, or after merging upstream changes in the OpenFOAM repository, it will be necessary to update the submodules:

git submodule update

A quick overview of git submodule can be in this blog with full details in the manpage.

An easy way to see which submodules are actually in use:

`cat .gitmodules`

Which will reveal content resembling the following:

[submodule "cfmesh"]
    path = modules/cfmesh
    url = https://develop.openfoam.com/Community/integration-cfmesh.git

doxygen

To build the doxygen information for the components, it is also necessary to link the directories to the doc/ subdirectory. This is a purely manual operation.