Merge pull request #4 from timofeymukha/develop

Merge develop in prep for 0.7.0

.cirrus.yml

@@ -0,0 +1,33 @@
+latest_task:
+  container:
+    image: opencfd/openfoam-dev:latest
+    cpu: 4
+    memory: 10G
+  test_script:
+    - apt-get update
+    - apt-get install -y python3 python-is-python3
+    - /usr/bin/openfoam ./Allwmake -j
+v2206_task:
+  container:
+    image: opencfd/openfoam-dev:2206
+    cpu: 1
+  test_script:
+    - apt-get update
+    - apt-get install -y python3 python-is-python3
+    - /usr/bin/openfoam ./Allwmake
+v2112_task:
+  container:
+    cpu: 1
+    image: opencfd/openfoam-dev:2112
+  test_script: 
+    - apt-get update
+    - apt-get install -y python3 python-is-python3
+    - /usr/bin/openfoam ./Allwmake
+v2106_task:
+  container:
+    cpu: 1
+    image: opencfd/openfoam-dev:2106
+  test_script: 
+    - apt-get update
+    - apt-get install -y python3 python-is-python3
+    - /usr/bin/openfoam ./Allwmake

AUTHORS.md

@@ -0,0 +1,3 @@
+* Timofey Mukha is the main developer of the library and the current maintainer
+* Saleh Rezaeiravesh contributed code during the initial development phase in 2017
+* Jan Gärtner contributed a patch that enables using compressible solvers in 2021

Allwmake

@@ -1,4 +1,5 @@
 #! /bin/bash
+. "${WM_PROJECT_DIR:?}"/wmake/scripts/AllwmakeParseArguments
 
 echo "Current OpenFOAM version is $WM_PROJECT_VERSION."
 if [ -e foamVersionThisIsCompiledFor ]; then

CHANGELOG.md

@@ -1,5 +1,41 @@
 # CHANGELOG
 
+## v0.7.0
+
+### For users
+- The main repository is now on Github. Use Github issues instead of Bitbucket to get help!
+
+- The library works with up to release v2212 from OpenCFD.
+
+- Ambition to support Foundation version is dropped. Pull requests are much welcome though.
+
+- The field for the sampling distance height is now called `hSampler` to avoid name collisions with enthalpy.
+  However, if `hSampler` is not found, `h` will be picked up.
+
+- It is now possible to use the library with compressible solvers.
+
+- Intracell interpolation should work properly now.
+
+- New parameter "silent", which suppresses time consumption output.
+
+- Messages like "Sampling field ... for patch ..." are now only printed in debug mode.
+  Use `DebugSwitches` in the `controlDict` to enable debug.
+
+- A new law of the wall is added, the `RoughLogLaw`, suitable for rough surfaces.
+
+- As a beta release, multi-cell sampling is implemented.
+  No simulations have been run using it as of yet.
+
+- The online documentation is improved.
+
+### For developers
+- The SampledField classes now have `TypeName`.
+
+- 'excludeWallAdjacent' is now in the base Sampler class.
+
+- Slightly different methods to get the viscosity internal field and patch field in the base wall model class (to accommodate compressible solvers).
+
+
 ## v0.6.1
 ### For users
 

Make/files

@@ -19,12 +19,14 @@ lawsOfTheWall/WernerWengleLawOfTheWall/WernerWengleLawOfTheWall.C
 lawsOfTheWall/IntegratedWernerWengleLawOfTheWall/IntegratedWernerWengleLawOfTheWall.C
 lawsOfTheWall/IntegratedReichardtLawOfTheWall/IntegratedReichardtLawOfTheWall.C
 lawsOfTheWall/ReichardtLawOfTheWall/ReichardtLawOfTheWall.C
+lawsOfTheWall/RoughLogLawOfTheWall/RoughLogLawOfTheWall.C
 eddyViscosities/EddyViscosity/EddyViscosity.C
 eddyViscosities/VanDriest/VanDriestEddyViscosity.C
 eddyViscosities/Duprat/DupratEddyViscosity.C
 wallModels/wallModelFvPatchScalarField.C
 wallModels/KnownWallShearStressWallModelFvPatchScalarField.C
 wallModels/LOTWWallModelFvPatchScalarField.C
+wallModels/MulticellLOTWWallModelFvPatchScalarField.C
 wallModels/EquilibriumODEWallModelFvPatchScalarField.C
 wallModels/ODEWallModelFvPatchScalarField.C
 wallModels/PGradODEWallModelFvPatchScalarField.C

README.md

@@ -1,19 +1,17 @@
 # README #
 
-libWallModelledLES is a library based on OpenFOAM® technology, extending the capabilities of OpenFOAM in the area of
-wall-modelled LES (WMLES).
-This is a turbulence modelling methodology, which allows to make LES cheaper by not resolving the inner region of
-turbulent boundary layers.
+libWallModelledLES is a library based on OpenFOAM® technology, extending the capabilities of OpenFOAM in the area of wall-modelled LES (WMLES).
+This is a turbulence modelling methodology, which allows to make LES cheaper by not resolving the inner region of turbulent boundary layers.
 
-If you use the library, please cite the following publication. This is also a good source for understanding the theory
-behind the models.
+If you use the library, please cite the following publication. This is also a good source for understanding the theory behind the models.
 
 https://doi.org/10.1016/j.cpc.2019.01.016
 
 **This offering is not approved or endorsed by OpenCFD Limited, producer and distributor of the OpenFOAM software via www.openfoam.com, and owner of the OPENFOAM(R) and OpenCFD(R) trademarks.**
 
 ## News ##
 
+- **2023-04-25** Development moves to [Github](https://github.com/timofeymukha/libWallModelledLES/), Bitbucket remains as a mirror.
 - **2023-01-05** Version 0.6.1 released.
 - **2021-08-30** Version 0.6.0 released.
 - **2019-10-28** Version 0.5.1 released.
@@ -26,22 +24,23 @@ https://doi.org/10.1016/j.cpc.2019.01.016
 
 ## Compatibility ##
 
-See "Installation" section on the documentation portal. In short: the latest ESI and Foundation releases should work.
+See "Installation" section on the documentation portal. In short: the latest ESI versions should work, Foundation version 7  and below should work.
 
 ## Getting help
 
-Please open [an issue on Bitbucket](https://bitbucket.org/lesituu/libwallmodelledles/issues?status=new&status=open)!
+Please first read the troubleshooting section in the documentation.
+If that does not help, please open [an issue on Github](https://github.com/timofeymukha/libWallModelledLES/issues)!
 
 ## Where this code lives
 This code is available on several public repositories:
-- [Bitbucket](https://bitbucket.org/lesituu/libwallmodelledles/) --- the main repository, where all the development happens, and where you should open issues to get help.
+- [Github](https://github.com/timofeymukha/libWallModelledLES) --- the main repository, where all the development happens, and where you should open issues to get help.
+- [Bitbucket](https://bitbucket.org/lesituu/libwallmodelledles/) --- mirror, which only gets update upon new releases.
+
 - [Gitlab](https://gitlab.com/chalmers-marine-technology/libwallmodelledles) --- mirror, which only gets updated upon new releases.
-- [Github](https://github.com/timofeymukha/libWallModelledLES) --- mirror, which only gets updated upon releases.
-
-
 
 ## Published works using the library
-If your works is missing from this glorious list and you want it here, [open an issue](https://bitbucket.org/lesituu/libwallmodelledles/issues?status=new&status=open)!
+
+If your works is missing from this glorious list and you want it here, [open an issue](https://github.com/timofeymukha/libWallModelledLES/issues)!
 
 
 - Mukha, T., Rezaeiravesh, S., & Liefvendahl, M. (2017). An OpenFOAM library for wall-modelled Large-Eddy Simulation. In proceedings of the 12th OpenFOAM Workshop, Exeter, UK.

cellFinders/CellFinder/CellFinder.H

@@ -19,7 +19,7 @@ License
 Class
     Foam::CellFinder
 
-Description
+@brief
     Class for searching for sampling cells.
 
 Contributors/Copyright:

cellFinders/CrawlingCellFinder/CrawlingCellFinder.H

@@ -19,7 +19,7 @@ License
 Class
     Foam::CrawlingCellFinder
 
-Description
+@brief
     Class for searching for sampling cells by crawling through opposite faces.
 
 Contributors/Copyright:

cellFinders/TreeCellFinder/TreeCellFinder.C

@@ -512,8 +512,21 @@ Foam::TreeCellFinder::findCandidateCellLabels
 Foam::tmp<Foam::volScalarField> Foam::TreeCellFinder::distanceField() const
 {
 
+
+    word hName;
+
     // Grab h for the current patch
-    const volScalarField & h = mesh_.lookupObject<volScalarField> ("h");
+    if (mesh_.foundObject<volScalarField>("hSampler"))
+    {
+        hName = "hSampler";
+    }
+    else
+    {
+        hName = "h";
+    }
+    const volScalarField & h = mesh_.lookupObject<volScalarField>(hName);
+
+
     if (debug)
     {
         Info<< "CellFinder: Creating dist field" << nl;

cellFinders/TreeCellFinder/TreeCellFinder.H

@@ -19,7 +19,7 @@ License
 Class
     Foam::TreeCellFinder
 
-Description
+@brief
     Class for searching for sampling cells using.
 
 Contributors/Copyright:

docs/.readthedocs.yaml

@@ -0,0 +1,9 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: miniconda3-4.7
+
+conda:
+  environment: docs/environment.yaml