aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar David Grote <grote1@llnl.gov> 2020-09-22 20:05:55 -0700
committerGravatar GitHub <noreply@github.com> 2020-09-22 20:05:55 -0700
commit8610be2dfb6d37fa2caa3c93afa01b666caedc2d (patch)
tree1f2c8adeeeba9b2acb17527e50afddf524678d2b /Docs/source/running_cpp
parent6e847c4b0ae54e20a1aac6445a25f75a1e6cb7bc (diff)
downloadWarpX-8610be2dfb6d37fa2caa3c93afa01b666caedc2d.tar.gz
WarpX-8610be2dfb6d37fa2caa3c93afa01b666caedc2d.tar.zst
WarpX-8610be2dfb6d37fa2caa3c93afa01b666caedc2d.zip
Initial version of use_damp_fields_in_z_guard option (#1304)
* Initial version of use_damp_in_z_guard option * Fix typo in WarpX.H Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com> * Changed use_damp_in_z_guard to use_damp_fields_in_z_guard * Added documentatin for use_damp_fields_in_z_guard * Clean up for use_damp_fields_in_z_guard * Added use_damp_fields_in_z_guard to picmi interface, and moved it to the psatd input group * For RZ spectral, damping of the fields is on by default when not periodic * Updated documentation for use_damp_fields_in_z_guard Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 4b1bdad57..a2911b9a5 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -974,6 +974,17 @@ Numerics and algorithms
This requires `warpx.use_kspace_filter=1` and is only supported
with the RZ spectral solver.
+* ``warpx.use_damp_fields_in_z_guard`` (`0` or `1`)
+ When using the RZ spectrol solver, specifies whether to apply a
+ damping factor to the E and B fields in the guard cells
+ along z that extend beyond the edge of the domain.
+ When the boundary conditions along z are not periodic, this defaults to
+ true, otherwise false. The damping profile is
+ a sine squared and is applied to the fields on the outer half of the guards.
+ This damping is useful for damping high frequency numerical artifacts that
+ occur when there is parallel decomposition along z with non-periodic boundary
+ conditions.
+
* ``algo.current_deposition`` (`string`, optional)
This parameter selects the algorithm for the deposition of the current density.
Available options are: ``direct``, ``esirkepov``, and ``vay``. The default choice