Skip to content

Commit b0fee45

Browse files
committed
add documentation
1 parent 92addab commit b0fee45

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ then you can build MFC and run the test suite!
8585
```
8686
And... you're done!
8787

88+
If you want to build MFC in single precision to ensure calculations are done in fp32 instead of fp64
89+
then build with the --single flag
90+
./mfc.sh build -j $(nproc) --single
91+
8892
You can learn more about MFC's capabilities [via its documentation](https://mflowcode.github.io/documentation/index.html) or play with the examples located in the `examples/` directory (some are [shown here](https://mflowcode.github.io/documentation/md_examples.html))!
8993

9094
The shock-droplet interaction case above was run via

docs/documentation/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ MFC can be built with support for various (compile-time) features:
126126
| **Debug** | `--debug` | `--no-debug` | Off | Requests the compiler build MFC in debug mode. |
127127
| **GCov** | `--gcov` | `--no-gcov` | Off | Builds MFC with coverage flags on. |
128128
| **Unified Memory** | `--unified` | `--no-unified` | Off | Builds MFC with unified CPU/GPU memory (GH-200 superchip only) |
129+
| **Single** | `--single` | `--no-single` | Off | Builds MFC in single precision
129130

130131
_⚠️ The `--gpu` option requires that your compiler supports OpenACC for Fortran for your target GPU architecture._
131132

0 commit comments

Comments
 (0)