Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Mini] Docs info for blocking_factor #1096

Merged
merged 22 commits into from
Jun 20, 2020
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
f02d842
Added description of singleparticle particle injection style
LDAmorim Apr 4, 2020
a6901c1
Revert "Added description of singleparticle particle injection style"
LDAmorim Apr 6, 2020
2a5adb2
Merge remote-tracking branch 'upstream/master'
LDAmorim Apr 8, 2020
6c47279
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 20, 2020
24a131b
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 22, 2020
2c243e1
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 23, 2020
bbfbcf2
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 27, 2020
06a7810
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 27, 2020
2180838
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 28, 2020
374671e
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Apr 30, 2020
75af55e
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim May 12, 2020
e15473d
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim May 13, 2020
2ed1c93
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim May 14, 2020
0d0d346
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim May 22, 2020
b84453a
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Jun 1, 2020
6bc431a
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Jun 12, 2020
b0d861c
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX
LDAmorim Jun 16, 2020
84d9aa6
More info on blocking factor
LDAmorim Jun 16, 2020
5fcfcf0
Merge branch 'master' of https://github.com/ECP-WarpX/WarpX into doc_…
LDAmorim Jun 17, 2020
0aae219
Merge remote-tracking branch 'upstream/development' into doc_block
LDAmorim Jun 18, 2020
8cc6417
Update Docs/source/running_cpp/parallelization.rst
LDAmorim Jun 19, 2020
6d6a82c
Update Docs/source/running_cpp/parameters.rst
LDAmorim Jun 19, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions Docs/source/running_cpp/parallelization.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _parallelization_warpx:

Parallelization in WarpX
=========================

Expand All @@ -17,13 +19,23 @@ the parallelization. The main user-defined parameters are
AMReX ``max_grid_size`` and ``blocking_factor``
-----------------------------------------------

* ``amr.max_grid_size`` is the maximum number of points per **grid** along each
* ``amr.max_grid_size`` is the maximum number of cells per **grid** along each
direction (default ``amr.max_grid_size=32`` in 3D).

* ``amr.blocking_factor``: The size of each **grid** must be divisible by the
`blocking_factor` along all dimensions (default ``amr.blocking_factor=8``).
* ``amr.blocking_factor``: is the minimum number of cells per **grid** along each
direction (default ``amr.blocking_factor=8``).
Note that the ``max_grid_size`` also has to be divisible by ``blocking_factor``.

.. note::

You can use the parameters above if you want the same number of cells in all directions.
Or you can set ``amr.max_grid_size_x``, ``amr.max_grid_size_y`` and ``amr.max_grid_size_z``;
 ``amr.blocking_factor_x``, ``amr.blocking_factor_x`` and ``amr.blocking_factor_x`` to different numbers of cells.

The total number of **grids** is determined using those two restrictions and the number of
ranks used to run the simulation. You can visit `AMReX <https://amrex-codes.github.io/amrex/docs_html/GridCreation.html?highlight=blocking_factor>`_
documentation for more information on the two parameters.

These parameters can have a dramatic impact on the code performance. Each
**grid** in the decomposition is surrounded by guard cells, thus increasing the
amount of data, computation and communication. Hence having a too small
Expand Down
2 changes: 1 addition & 1 deletion Docs/source/running_cpp/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1252,7 +1252,7 @@ In-situ capabilities can be used by turning on Sensei or Ascent (provided they a
* ``<diag_name>.coarsening_ratio`` (list of `int`) optional (default `1 1 1`)
Reduce size of the field output by this ratio in each dimension.
(This is done by averaging the field over 1 or 2 points along each direction, depending on the staggering).
``plot_coarsening_ratio`` should be an integer divisor of ``blocking_factor``.
``plot_coarsening_ratio`` should be an integer divisor of ``blocking_factor``, deined in the :ref:`parallelization <parallelization_warpx>` section.

* ``<diag_name>.file_prefix`` (`string`) optional (default `diags/plotfiles/plt`)
Root for output file names. Supports sub-directories.
Expand Down