cwpearson/astaroth
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation with the changes made for Astaroth 2.2

Browse Source
This commit is contained in:
jpekkila
2020-01-28 13:36:51 +02:00
parent 5444c84cff
commit 07dd9ff024
3 changed files with 13 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -39,15 +39,13 @@ In the base directory, run
| Option | Description | Default |
|--------|-------------|---------|
| BUILD_DEBUG | Builds Astaroth with extensive error checking | OFF |
| BUILD_STANDALONE | Builds a standalone library for testing, benchmarking and simulation | ON |
| BUILD_UTILS | Builds a generic utility library (WIP replacement for BUILD_STANDALONE) | ON |
| BUILD_RT_VISUALIZATION | Builds the real-time visualization module | OFF |
| BUILD_SAMPLES | Builds projects in samples subdirectory | OFF |
| DOUBLE_PRECISION | Generates double precision code | OFF |
| MULTIGPU_ENABLED | Enables Astaroth to use multiple GPUs on a single node | ON |
| MPI_ENABLED | Enables additional functions for MPI communciation | OFF |
| DSL_MODULE_DIR | Defines the directory to be scanned when looking for DSL files | `astaroth/acc/mhd_solver` |
| CMAKE_BUILD_TYPE | Selects the build type. Possible values: Debug, Release, RelWithDebInfo, MinSizeRel. See (CMake documentation)[https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html] for more details. | Release |
| DOUBLE_PRECISION | Generates double precision code. | OFF |
| BUILD_SAMPLES | Builds projects in samples subdirectory. | OFF |
| BUILD_STANDALONE | Builds a standalone library for testing, benchmarking and simulation. | ON |
| MPI_ENABLED | Enables multi-GPU on a single node. Uses peer-to-peer communication instead of MPI. Affects Legacy & Node layers only. | OFF |
| MULTIGPU_ENABLED | Enables Astaroth to use multiple GPUs on a single node. | ON |
| DSL_MODULE_DIR | Defines the directory to be scanned when looking for DSL files. | `astaroth/acc/mhd_solver` |
## Standalone Module
@@ -67,10 +65,8 @@ See `analysis/python/` directory of existing data visualization and analysis scr
## Interface
* `astaroth/include/astaroth.h`: Legacy interface for backwards compatibility and quick testing.
* `astaroth/include/astaroth_node.h`: Multi-GPU interface (single node).
* `astaroth/include/astaroth_device.h`: Single-GPU interface.
* `astaroth/src/utils/`: Utility library for host-side memory allocations, verification and other tasks.
* `astaroth/include/astaroth.h`: Astaroth main header. Contains the interface for accessing single- and multi-GPU layers.
* `astaroth/include/astaroth_utils.h`: Utility library header. Provides functions for performing common tasks on host, such as allocating and verifying meshes.
## FAQ

7
doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md
View File

@@ -100,14 +100,12 @@ Finally, a third layer is provided for convenience and backwards compatibility.
> Essentially a wrapper for the Node layer.
> All functions are guaranteed to be synchronous.
There are also several helper functions defined in `include/astaroth_defines.h`, which can be used for, say, determining the size or performing index calculations within the simulation domain.
There are also several helper functions defined in `include/astaroth.h`, which can be used for, say, determining the size or performing index calculations within the simulation domain.
## List of Astaroth API Functions
Here's a non-exhaustive list of astaroth API functions. For more info and an up-to-date list, see
the corresponding header files in `include/astaroth_defines.h`, `include/astaroth.h`, `include/
astaroth_node.h`, `include/astaroth_device.h`.
Here's a non-exhaustive list of astaroth API functions. For more info and an up-to-date list, see headers `include/astaroth.h` and `include/astaroth_utils.h`.
### Initialization, Quitting and Helper Functions
@@ -531,6 +529,7 @@ AcResult acDeviceKernel_##identifier(const Device device, const Stream stream,
, where ##identifier is the name of the kernel function.
The following built-in variables are available in `Kernel`s.
| Built-in variable | Description |
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| vertexIdx | Holds the local index of the currently processed vertex. |

2
doxyfile
View File

@@ -38,7 +38,7 @@ PROJECT_NAME = "Astaroth"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 2.1
PROJECT_NUMBER = 2.2
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a