From b0fee458879d56d4d51f51966c92ec035c45dd0b Mon Sep 17 00:00:00 2001 From: archithiyer Date: Fri, 13 Dec 2024 15:56:44 -0800 Subject: [PATCH] add documentation --- README.md | 4 ++++ docs/documentation/getting-started.md | 1 + 2 files changed, 5 insertions(+) diff --git a/README.md b/README.md index 6f89bbb731..3389102491 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,10 @@ then you can build MFC and run the test suite! ``` And... you're done! +If you want to build MFC in single precision to ensure calculations are done in fp32 instead of fp64 +then build with the --single flag +./mfc.sh build -j $(nproc) --single + 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))! The shock-droplet interaction case above was run via diff --git a/docs/documentation/getting-started.md b/docs/documentation/getting-started.md index 5227ec77e2..3245df892d 100644 --- a/docs/documentation/getting-started.md +++ b/docs/documentation/getting-started.md @@ -126,6 +126,7 @@ MFC can be built with support for various (compile-time) features: | **Debug** | `--debug` | `--no-debug` | Off | Requests the compiler build MFC in debug mode. | | **GCov** | `--gcov` | `--no-gcov` | Off | Builds MFC with coverage flags on. | | **Unified Memory** | `--unified` | `--no-unified` | Off | Builds MFC with unified CPU/GPU memory (GH-200 superchip only) | +| **Single** | `--single` | `--no-single` | Off | Builds MFC in single precision _⚠️ The `--gpu` option requires that your compiler supports OpenACC for Fortran for your target GPU architecture._