songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SUBMODULE: update all the submodules

Browse Source
This commit is contained in:
Kutalmis Bercin 2023-12-18 11:39:20 +00:00
parent 88b3fb7c2d
commit 80d7227c3a
8 changed files with 65 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/OpenQBMM

@ -1 +1 @@
Subproject commit 253d099ee945426a2e827711f8e66452f159aeb9 Subproject commit cbbd69ae348161c4fe5296a61e1f637bfec72b67

108
modules/README.md
View File

@ -7,6 +7,64 @@ tools to placed and have them built as part of the normal OpenFOAM
build process. It is assumed that each subdirectory contain an build process. It is assumed that each subdirectory contain an
appropriate `Allwmake` (or `Allwmake.override`) file. appropriate `Allwmake` (or `Allwmake.override`) file.
### How to use
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`:
```bash
cd $WM_PROJECT_DIR
git submodule update --init --recursive
```
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:
```bash
git submodule update --init --recursive modules/turbulence-community
```
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
```
Which will reveal content resembling the following:
```
[submodule "avalanche"]
path = modules/avalanche
url = https://develop.openfoam.com/Community/avalanche.git
[submodule "cfmesh"]
path = modules/cfmesh
url = https://develop.openfoam.com/Community/integration-cfmesh.git
...
```
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 ### Build locations
@ -27,62 +85,12 @@ command.
| ./Allwmake -prefix=openfoam | `$FOAM_APPBIN`, `$FOAM_LIBBIN` | | ./Allwmake -prefix=openfoam | `$FOAM_APPBIN`, `$FOAM_LIBBIN` |
| ./Allwmake -prefix=/some/pathname | `/some/pathname/bin`, `/some/pathname/lib` | | ./Allwmake -prefix=/some/pathname | `/some/pathname/bin`, `/some/pathname/lib` |
### Adding additional components
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
```
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*][blog git-submodule] with full details in the
[*manpage*][man git-submodule].
An easy way to see which submodules are actually in use:
```
cat .gitmodules
```
Which will reveal content resembling the following:
```
[submodule "avalanche"]
path = modules/avalanche
url = https://develop.openfoam.com/Community/avalanche.git
[submodule "cfmesh"]
path = modules/cfmesh
url = https://develop.openfoam.com/Community/integration-cfmesh.git
...
```
### Documentation (doxygen) ### Documentation (doxygen)
To build the doxygen information for the components, it is also To build the doxygen information for the components, it is also
necessary to link the directories to the doc/ subdirectory. necessary to link the directories to the doc/ subdirectory.
This is a purely manual operation. This is a purely manual operation.
### Developer Information ### Developer Information
#### Build locations #### Build locations

2
modules/adios

@ -1 +1 @@
Subproject commit b13298ef3b8b7fe88535c7c4053146f82f5af760 Subproject commit 311f99a2e123f28c6c1f2a639366fe3edce612d0

2
modules/avalanche

@ -1 +1 @@
Subproject commit 858fff2b2a55aae6755eb216a28cdeeb67743fc6 Subproject commit 1a789a710c5421398ff6296e3950fac374893803

2
modules/cfmesh

@ -1 +1 @@
Subproject commit c0af2297837358e6a45b050a08da81c5e3722e7e Subproject commit 423540be95918c7f47377f8910347aeadefe2dfc

2
modules/external-solver

@ -1 +1 @@
Subproject commit 5841a4a0e8a71546cca929ffaf441661c6b773d4 Subproject commit 60323b8a06af9442040b446e6cca8d7f8a7cb0c2

2
modules/turbulence-community

@ -1 +1 @@
Subproject commit 1986462f269067ce7f4e87e4597f73051e2a1f1e Subproject commit ea14fa5f53af3db89b0a53a286a8df7a374346bc

2
modules/visualization

@ -1 +1 @@
Subproject commit ae57b7c438e884f671e04f7558b9dc47fc64cadd Subproject commit 1e788ad6b3afb75a5c605dab0c6b6f94c806e7e2