Skip to content

Commit 2eb0903

Browse files
committed
Document renumberMesh
1 parent 48ce6d7 commit 2eb0903

2 files changed

Lines changed: 10 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@
2525
digit target, roughly equivalent to single-precision relative accuracy in the
2626
root estimate. Users can still set `maxIter`.
2727

28-
- The LIBWALLMODELLEDLES_SKIP_SAMPLING_SETUP=true can be prepended to utilities
28+
- The LIBWMLES_SKIP_SAMPLING_SETUP=true can be prepended to utilities
2929
where the boundary conditions are not used to avoid setting up the samplers.
30-
This is particularly useful for decomposePar.
30+
This is particularly useful for decomposePar. This makes running
31+
`renumberMesh` possible.
3132

3233
### For developers
3334

@@ -36,8 +37,7 @@
3637
- The Newton, Bisection and TOMS748 root finders now use `boost`
3738
implementations behind the scenes.
3839

39-
- Switched CI provider to Github Actions.
40-
40+
- Switched CI provider to Github Actions and bumped tested versions.
4141

4242
## v0.7.0
4343

docs/sampling.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,12 @@ the cell selection worked as expected.
5050
Bypassing Sampling Setup
5151
------------------------
5252

53-
Some OpenFOAM utilities, such as :code:`decomposePar`, construct the wall model
54-
boundary condition without evaluating it. For very large cases the
55-
sampling-cell search can dominate the utility runtime even though the result is
56-
not used. This setup can be skipped by setting the environment variable
57-
:code:`LIBWMLES_SKIP_SAMPLING_SETUP=true` before running the utility.
53+
Some OpenFOAM utilities, such as :code:`decomposePar`, and :code:`renumberMesh`,
54+
construct the wall model boundary condition without evaluating it. For very
55+
large cases the sampling-cell search can dominate the utility runtime even
56+
though the result is not used. This setup can be skipped by setting the
57+
environment variable :code:`LIBWMLES_SKIP_SAMPLING_SETUP=true` before running
58+
the utility. **For renumberMesh setting this is mandatory**.
5859

5960
This switch must not be used for solver runs. If a wall model tries to sample
6061
while the switch is enabled, the library exits with an error instead of using

0 commit comments

Comments
 (0)