diff options
author | 2019-08-30 13:44:58 -0700 | |
---|---|---|
committer | 2019-08-30 13:44:58 -0700 | |
commit | be92ecd49cac666c05d1b9e73fb2ac74bb75a1c6 (patch) | |
tree | 30aa9fae9591af00ef280d87d77bdb1b3da83c9f /Docs/source/running_cpp/parameters.rst | |
parent | 7e5d673cf801949c647b9890b9af278f097e8e72 (diff) | |
parent | a7105f2e97c79de807e1ff57a2f7d9df6d471cb8 (diff) | |
download | WarpX-be92ecd49cac666c05d1b9e73fb2ac74bb75a1c6.tar.gz WarpX-be92ecd49cac666c05d1b9e73fb2ac74bb75a1c6.tar.zst WarpX-be92ecd49cac666c05d1b9e73fb2ac74bb75a1c6.zip |
Merge branch 'dev' into picsar_cleanup
Diffstat (limited to 'Docs/source/running_cpp/parameters.rst')
-rw-r--r-- | Docs/source/running_cpp/parameters.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index da148fde6..9beb234ae 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -663,6 +663,18 @@ Boundary conditions The characteristic depth, in number of cells, over which the absorption coefficients of the PML increases. +* ``warpx.do_pml_in_domain`` (`int`; default: 0) + Whether to create the PML inside the simulation area or outside. If inside, + it allows the user to propagate particles in PML and to use extended PML + +* ``warpx.do_pml_has_particles`` (`int`; default: 0) + Whether to propagate particles in PML or not. Can only be done if PML are in simulation domain, + i.e. if `warpx.do_pml_in_domain = 1`. + +* ``warpx.do_pml_j_damping`` (`int`; default: 0) + Whether to damp current in PML. Can only be used if particles are propagated in PML, + i.e. if `warpx.do_pml_has_particles = 1`. + * ``warpx.do_pml_Lo`` (`2 ints in 2D`, `3 ints in 3D`; default: `1 1 1`) The directions along which one wants a pml boundary condition for lower boundaries on mother grid. |