Skip to content

Commit

Permalink
✨ Init commit for separate wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
haykh committed Apr 3, 2024
0 parents commit 5d82886
Show file tree
Hide file tree
Showing 61 changed files with 6,452 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#name: github pages
#on:
#push:
#branches:
#- wiki

#jobs:
#build:
#name: Deploy docs
#runs-on: ubuntu-latest
#steps:
#- name: Checkout main
#uses: actions/checkout@v2

#- name: Deploy docs
#uses: mhausenblas/mkdocs-deploy-gh-pages@master
#env:
#GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
#CONFIG_FILE: mkdocs.yml
#EXTRA_PACKAGES: build-base
#REQUIREMENTS: requirements.txt
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.DS_Store
.venv
site
package-lock.json
package.json

node_modules
29 changes: 29 additions & 0 deletions docs/API/ranges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
hide:
- footer
---

`Kokkos` loops accept `Kokkos::RangePolicy` or `Kokkos::MDRangePolicy` objects that specify the n-dimensional range of the loop. `Entity` embeds around these range objects and provides convenient aliases to the most common use cases.

=== "`.rangeAllCells()`"

| dimension | return object | ranges |
|-----------|---------------|-------------|
| 1D | `Kokkos::RangePolicy<>` | $i_1\in [0,N_1)$ |
| 2D | `Kokkos::MDRangePolicy<Rank<2>>` | $i_1\in [0,N_1)$, $i_2\in [0,N_2)$ |
| 3D | `Kokkos::MDRangePolicy<Rank<3>>` | $i_1\in [0,N_1)$, $i_2\in [0,N_2)$, $i_3\in [0,N_3)$ |

=== "`.rangeActiveCells()`"

| dimension | return object | ranges |
|-----------|---------------|-------------|
| 1D | `Kokkos::RangePolicy<>` | $i_1\in [N_G,N_1-N_G)$ |
| 2D | `Kokkos::MDRangePolicy<Rank<2>>` | $i_1\in [N_G,N_1-N_G)$, $i_2\in [N_G,N_2-N_G)$ |
| 3D | `Kokkos::MDRangePolicy<Rank<3>>` | $i_1\in [N_G,N_1-N_G)$, $i_2\in [N_G,N_2-N_G)$, $i_3\in [N_G,N_3-N_G)$ |

=== "`.rangeCells(const boxRegion<D>&)`"

`boxRegion<D>` is an auxiliary object (basically a tuple of size `D`) to specify a custom region of cells. It contains `CellLayer` objects by the number of dimensions. For example:
```c++
boxRegion<2> left{CellLayer::minActiveLayer, CellLayer::allActiveLayer};
```
Empty file added docs/API/testing.md
Empty file.
Binary file added docs/assets/construction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/cover_dark.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/cover_dark.gif.REMOVED.git-id
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
4128e50199276845e65d481f321c53fd9cedfb06
Binary file added docs/assets/cover_light.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/cover_light.gif.REMOVED.git-id
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ece58f5f573fb426c71cd103d9ac98da945cc4dc
1 change: 1 addition & 0 deletions docs/assets/icons/engine-icon-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/icons/engine-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/icons/framework-icon-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/icons/framework-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/icons/vis-icon-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/icons/vis-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/404-gandalf-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/404-gandalf-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/howto/nt2-demo-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/howto/nt2-demo-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/howto/nt2-demo-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/howto/nt2-demo-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5d82886

Please sign in to comment.