Skip to content

Commit c9463b1

Browse files
committed
docs: add docs for functionObject tutorial
1 parent 1ca6370 commit c9463b1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

tutorials/functionObject/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Computing the SVD of OpenFOAM fields
2+
3+
Running `openfoam-svd.py` will perform an SVD on OpenFOAM fields that results off
4+
of a `pitzDaily` case. The case runs with `simpleFoam` and communicates its fields
5+
to the `smartRedis` database through a `fieldsToSmartRedis` function object.
6+
7+
## Usage of the Function Object with SmartSim ensembles
8+
9+
The same function object is used in an ensemble setting to showcase a dummy parameter
10+
variation. The only requirement is that the solver has access to an environment variable:
11+
```bash
12+
export SSKEYIN=${SSKEYOUT}
13+
```
14+
This ensures each ensemble member reads and writes fields to a prefixed datasets to prevent
15+
race conditions and members reading data from each other.

0 commit comments

Comments
 (0)