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

SUBMODULE: add data-community plugin (fixes #3146)

Browse Source 
SUBMODULE: update turbulence-community plugin

ENH: README: add info to differentiate the modules from the plugins
This commit is contained in:
Kutalmis Bercin 2024-06-06 09:25:03 +01:00
parent eea442e209
commit f7291c4550
5 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitmodules vendored
View File

@ -20,3 +20,6 @@
[submodule "turbulence-community"] [submodule "turbulence-community"]
path = plugins/turbulence-community path = plugins/turbulence-community
url = https://gitlab.com/openfoam/community/tc-turbulence/turbulence-community.git url = https://gitlab.com/openfoam/community/tc-turbulence/turbulence-community.git
[submodule "plugins/data-community"]
path = plugins/data-community
url = https://gitlab.com/openfoam/community/sig-data-modelling/data-community.git

9
modules/README.md
View File

@ -1,12 +1,17 @@
[[_TOC_]] [[_TOC_]]
## OpenFOAM Modules ## OpenFOAM modules
This directory is a location for additional OpenFOAM components or This directory is a location for additional OpenFOAM components or
tools to placed and have them built as part of the normal OpenFOAM 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.
The primary distinction between `modules` and `plugins` is that `modules` are
mainly maintained and released by OpenFOAM developers, whereas `plugins` are an
open and welcoming area for add-ons, predominantly maintained and driven by
OpenFOAM community members and groups.
### How to use ### How to use
On the first use, you need to register the submodules, and then update them. On the first use, you need to register the submodules, and then update them.
@ -91,7 +96,7 @@ 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

9
plugins/README.md
View File

@ -1,12 +1,17 @@
[[_TOC_]] [[_TOC_]]
## OpenFOAM Plugins ## OpenFOAM plugins
This directory is a location for additional OpenFOAM components or This directory is a location for additional OpenFOAM components or
tools to placed and have them built as part of the normal OpenFOAM 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.
The primary distinction between `modules` and `plugins` is that `modules` are
mainly maintained and released by OpenFOAM developers, whereas `plugins` are an
open and welcoming area for add-ons, predominantly maintained and driven by
OpenFOAM community members and groups.
### How to use ### How to use
On the first use, you need to register the submodules, and then update them. On the first use, you need to register the submodules, and then update them.
@ -88,7 +93,7 @@ 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

1
plugins/data-community Submodule

@ -0,0 +1 @@
Subproject commit cfb50e6b1a182bda5f25d5690f26a23fc8d22c8f

2
plugins/turbulence-community

@ -1 +1 @@
Subproject commit 06b391bb475f0386342b6f9b7fe5496ae87e464f Subproject commit 4dbaff2c56cacd3b5170cfd2899f003b1dc5832a