diff options
author | 2022-12-19 08:55:30 -0800 | |
---|---|---|
committer | 2022-12-19 17:55:30 +0100 | |
commit | a080c13de54b94ad24f606f94075a6ac4176ea06 (patch) | |
tree | c597ebd45796770e2e8c673e4cf07d11fff3932d | |
parent | c3eb6ea1efeff3910e8520d94e260d94367d68f7 (diff) | |
download | WarpX-a080c13de54b94ad24f606f94075a6ac4176ea06.tar.gz WarpX-a080c13de54b94ad24f606f94075a6ac4176ea06.tar.zst WarpX-a080c13de54b94ad24f606f94075a6ac4176ea06.zip |
Docs: Profiler Sync (Debug) (#3571)
Document the `amrex.use_profiler_syncs` option in our debugging
section.
-rw-r--r-- | Docs/source/usage/parameters.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 22f01196a..b654eb4ae 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -2777,6 +2777,10 @@ When developing, testing and :ref:`debugging WarpX <debugging_warpx>`, the follo When set to ``1``, this option causes simulation to fail *after* its completion if there were unused parameters. It is mainly intended for continuous integration and automated testing to check that all tests and inputs are adapted to API changes. +* ``amrex.use_profiler_syncs`` (``0`` or ``1``; default is ``0`` for false) + Adds a synchronization at the start of communication, so any load balance will be caught there (the timer is called ``SyncBeforeComms``), then the comm operation will run. + This will slow down the run. + * ``warpx.serialize_initial_conditions`` (`0` or `1`) optional (default `0`) Serialize the initial conditions for reproducible testing, e.g, in our continuous integration tests. Mainly whether or not to use OpenMP threading for particle initialization. |