Skip to content

Commit

Permalink
[mini-PR] Add particle tiling documentation (#1665)
Browse files Browse the repository at this point in the history
* tiling wip

* do_tiling documentation

* Update Docs/source/running_cpp/parameters.rst

Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>

Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
  • Loading branch information
mrowan137 and lucafedeli88 authored Jan 31, 2021
1 parent db1f840 commit d1f961e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Docs/source/running_cpp/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,10 @@ Particle initialization
particles are pushed in a standard way, using the specified pusher.
(see the parameter ``<species_name>.zinject_plane`` below)

* ``particles.do_tiling`` (`bool`) optional (default `true` if WarpX is compiled for GPUs, `false` otherwise)
Controls whether tiling ('cache blocking') transformation is used for particles.
Tiling should be on when using OpenMP and off when using GPUs.

* ``<species_name>.species_type`` (`string`) optional (default `unspecified`)
Type of physical species, ``"electron"``, ``"positron"``, ``"photon"``, ``"hydrogen"``.
Either this or both ``mass`` and ``charge`` have to be specified.
Expand Down

0 comments on commit d1f961e

Please sign in to comment.