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

Fixed formatting in the API specification file

Browse Source
This commit is contained in:
jpekkila
2020-03-04 15:09:23 +02:00
parent 13b9b39c0d
commit 37d6ad18d3
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md
View File

@@ -82,23 +82,23 @@ The API is divided into layers which differ in the level of control provided ove
There are two primary layers: There are two primary layers:
* Device layer * Device layer
> Functions start with acDevice*. * Functions start with acDevice.
> Provides control over a single GPU. * Provides control over a single GPU.
> All functions are asynchronous. * All functions are asynchronous.
* Node layer * Node layer
> Functions start with acNode*. * Functions start with acNode.
> Provides control over multiple devices in a single node. * Provides control over multiple devices in a single node.
> All functions are asynchronous and executed concurrently on all devices in the node. * All functions are asynchronous and executed concurrently on all devices in the node.
> Subsequent functions called in the same stream (see Section #Streams and synchronization) are guaranteed to be synchronous. * Subsequent functions called in the same stream (see Section #Streams and synchronization) are guaranteed to be synchronous.
Finally, a third layer is provided for convenience and backwards compatibility. Finally, a third layer is provided for convenience and backwards compatibility.
* Astaroth layer (deprecated) * Astaroth layer (deprecated)
> Functions start with ac* without Node or Device, f.ex. acInit(). * Functions start with `ac` only, f.ex. acInit().
> Provided for backwards compatibility. * Provided for backwards compatibility.
> Essentially a wrapper for the Node layer. * Essentially a wrapper for the Node layer.
> All functions are guaranteed to be synchronous. * All functions are guaranteed to be synchronous.
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. 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.
@@ -452,7 +452,7 @@ it for performing three-dimensional stencil computations cache efficiently. The
comprises of three closely related languages, which correspond to distinct stages in the stencil comprises of three closely related languages, which correspond to distinct stages in the stencil
pipeline shown in the following figure. pipeline shown in the following figure.
![Figure: Stencil pipeline.](./doc/Astaroth_API_specification_and_user_manual/stencil_pipeline.svg "Stencil Pipeline") ![Figure: Stencil pipeline.](../../Astaroth_API_specification_and_user_manual/stencilpipeline.svg "Stencil Pipeline")
| Stage | File ending | Description | | Stage | File ending | Description |
|--------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|