Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
Extend `numberOfCells.rst`
  - add condition about the absorber
  - mention the parameter `autoAdjustGrid`
  • Loading branch information
psychocoderHPC committed Dec 19, 2018
1 parent 6ff7f2d commit 8de499e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/TBG_macros.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ TBG_gridSize="128 256 128"
# Number of simulation steps/iterations as "N"
TBG_steps="100"

# disable grid size auto adjustment
TBG_disableGridAutoAdjustment="--autoAdjustGrid off"

################################################################################
## Section: Optional Variables
Expand Down
6 changes: 5 additions & 1 deletion docs/source/usage/workflows/numberOfCells.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ Setting the Number of Cells
Together with the grid resolution in :ref:`grid.param <usage-params-core>`, the number of cells in our :ref:`.cfg files <usage-tbg>` determine the overall size of a simulation (box).
The following rules need to be applied when setting the number of cells:

Each GPU needs to:
Each device needs to:

#. contain an integer *multiple* of supercells
#. at least *three* supercells
#. for non periodic boundary conditions, the number of absorbing boundary cells for devices at the simulation boundary (see :ref:`grid.param <usage-params-core>`) must fit into the local volume

The grid size will be automatically adjusted if the conditions above are not fulfilled.
This behavior can be disabled by using the command line option ``--autoAdjustGrid off``

Supercell sizes in terms of number of cells are set in :ref:`memory.param <usage-params-memory>` and are by default ``8x8x4`` for 3D3V simulations on GPUs.
For 2D3V simulations, ``16x16`` is usually a good supercell size, however the default is simply cropped to ``8x8``, so make sure to change it to get more performance.

0 comments on commit 8de499e

Please sign in to comment.