From e8e782f91500b7d36bc0c09e67b29d54a6192a65 Mon Sep 17 00:00:00 2001 From: ablelly Date: Thu, 29 Aug 2019 20:18:50 +0200 Subject: Added input parameters `do_pml_in_domain`, `do_pml_has_particle`, `do_pml_j_damping` in the documentation --- Docs/source/running_cpp/parameters.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'Docs/source/running_cpp') diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index d411cc0a1..4e7ae6678 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -661,6 +661,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. -- cgit v1.2.3