diff --git a/modules/OpenQBMM b/modules/OpenQBMM index 253d099ee945426a2e827711f8e66452f159aeb9..cbbd69ae348161c4fe5296a61e1f637bfec72b67 160000 --- a/modules/OpenQBMM +++ b/modules/OpenQBMM @@ -1 +1 @@ -Subproject commit 253d099ee945426a2e827711f8e66452f159aeb9 +Subproject commit cbbd69ae348161c4fe5296a61e1f637bfec72b67 diff --git a/modules/README.md b/modules/README.md index 219d1c1f7d0c6e7f870a5b9642e5a8da070d88df..0dc15e01dfae2cd09ad973042340dc9f1a9df908 100644 --- a/modules/README.md +++ b/modules/README.md @@ -7,61 +7,37 @@ 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` (or `Allwmake.override`) file. +### How to use -### Build locations - -Any individual _module_ will normally also be able to exist outside of -the module directory structure and will typically build into user -locations (`$FOAM_USER_APPBIN`, `$FOAM_USER_LIBBIN`). - -When compiled from the top-level OpenFOAM `Allwmake` or the -`modules/Allwmake`, they should build into OpenFOAM project locations -(`$FOAM_APPBIN`, `$FOAM_LIBBIN`). This can be adjusted by -supplying an alternative `-prefix=` to the corresponding Allwmake -command. - -| Command | Install location | -|------------|------------------| -| ./Allwmake -prefix=user | `$FOAM_USER_APPBIN`, `$FOAM_USER_LIBBIN` | -| ./Allwmake -prefix=group | `$FOAM_SITE_APPBIN`, `$FOAM_SITE_LIBBIN` | -| ./Allwmake -prefix=openfoam | `$FOAM_APPBIN`, `$FOAM_LIBBIN` | -| ./Allwmake -prefix=/some/pathname | `/some/pathname/bin`, `/some/pathname/lib` | - +On the first use, you need to register the submodules, and then update them. +You can execute both steps for all the available submodules (including the +nested ones) as follows while you are at `$WM_PROJECT_DIR`: -### Adding additional components +```bash +cd $WM_PROJECT_DIR -These additional components may be added as [git submodules][man git-submodule], -by script or by hand. - - -#### git - -On the first use, it will be necessary to register the submodules: -``` -git submodule init +git submodule update --init --recursive ``` -This will clone the relevant submodules from their respective -repositories. +Executing this single-line command clones all the submodules from their +respective repositories and prepares them for compilation. Note that you can +also make only a certain group of submodules ready by explicitly specifying the +requested submodules' names at the end of the command above. For example, if +you would like to use only the `turbulence-community` submodule, you specify: -The following will indicate the current state: -``` -git submodule status +```bash +git submodule update --init --recursive modules/turbulence-community ``` -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*][blog git-submodule] with full details in the -[*manpage*][man git-submodule]. +You can display information about the status of submodules as follows: +```bash +git submodule status --recursive +``` An easy way to see which submodules are actually in use: -``` + +```bash cat .gitmodules ``` @@ -76,13 +52,45 @@ Which will reveal content resembling the following: ... ``` +If you need to remove a specific submodule or wish to restart the process, +you can simply carry out the task as follows: + +```bash +git submodule deinit modules/turbulence-community +``` + +This command deregisters the specified submodule and clears the +`modules/turbulence-community` directory. + +A quick overview of `git submodules` can be found in this +[*blog*][blog git-submodule] with full details in the +[*manpage*][man git-submodule]. + +### Build locations + +Any individual _module_ will normally also be able to exist outside of +the module directory structure and will typically build into user +locations (`$FOAM_USER_APPBIN`, `$FOAM_USER_LIBBIN`). + +When compiled from the top-level OpenFOAM `Allwmake` or the +`modules/Allwmake`, they should build into OpenFOAM project locations +(`$FOAM_APPBIN`, `$FOAM_LIBBIN`). This can be adjusted by +supplying an alternative `-prefix=` to the corresponding Allwmake +command. + +| Command | Install location | +|------------|------------------| +| ./Allwmake -prefix=user | `$FOAM_USER_APPBIN`, `$FOAM_USER_LIBBIN` | +| ./Allwmake -prefix=group | `$FOAM_SITE_APPBIN`, `$FOAM_SITE_LIBBIN` | +| ./Allwmake -prefix=openfoam | `$FOAM_APPBIN`, `$FOAM_LIBBIN` | +| ./Allwmake -prefix=/some/pathname | `/some/pathname/bin`, `/some/pathname/lib` | + ### Documentation (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. - ### Developer Information #### Build locations diff --git a/modules/adios b/modules/adios index b13298ef3b8b7fe88535c7c4053146f82f5af760..311f99a2e123f28c6c1f2a639366fe3edce612d0 160000 --- a/modules/adios +++ b/modules/adios @@ -1 +1 @@ -Subproject commit b13298ef3b8b7fe88535c7c4053146f82f5af760 +Subproject commit 311f99a2e123f28c6c1f2a639366fe3edce612d0 diff --git a/modules/avalanche b/modules/avalanche index 858fff2b2a55aae6755eb216a28cdeeb67743fc6..1a789a710c5421398ff6296e3950fac374893803 160000 --- a/modules/avalanche +++ b/modules/avalanche @@ -1 +1 @@ -Subproject commit 858fff2b2a55aae6755eb216a28cdeeb67743fc6 +Subproject commit 1a789a710c5421398ff6296e3950fac374893803 diff --git a/modules/cfmesh b/modules/cfmesh index c0af2297837358e6a45b050a08da81c5e3722e7e..423540be95918c7f47377f8910347aeadefe2dfc 160000 --- a/modules/cfmesh +++ b/modules/cfmesh @@ -1 +1 @@ -Subproject commit c0af2297837358e6a45b050a08da81c5e3722e7e +Subproject commit 423540be95918c7f47377f8910347aeadefe2dfc diff --git a/modules/external-solver b/modules/external-solver index 5841a4a0e8a71546cca929ffaf441661c6b773d4..60323b8a06af9442040b446e6cca8d7f8a7cb0c2 160000 --- a/modules/external-solver +++ b/modules/external-solver @@ -1 +1 @@ -Subproject commit 5841a4a0e8a71546cca929ffaf441661c6b773d4 +Subproject commit 60323b8a06af9442040b446e6cca8d7f8a7cb0c2 diff --git a/modules/turbulence-community b/modules/turbulence-community index 1986462f269067ce7f4e87e4597f73051e2a1f1e..ea14fa5f53af3db89b0a53a286a8df7a374346bc 160000 --- a/modules/turbulence-community +++ b/modules/turbulence-community @@ -1 +1 @@ -Subproject commit 1986462f269067ce7f4e87e4597f73051e2a1f1e +Subproject commit ea14fa5f53af3db89b0a53a286a8df7a374346bc diff --git a/modules/visualization b/modules/visualization index ae57b7c438e884f671e04f7558b9dc47fc64cadd..1e788ad6b3afb75a5c605dab0c6b6f94c806e7e2 160000 --- a/modules/visualization +++ b/modules/visualization @@ -1 +1 @@ -Subproject commit ae57b7c438e884f671e04f7558b9dc47fc64cadd +Subproject commit 1e788ad6b3afb75a5c605dab0c6b6f94c806e7e2