diff options
Diffstat (limited to 'Docs/source/running_cpp/parameters.rst')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 36 |
1 files changed, 24 insertions, 12 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index a6f6756ad..30687244e 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -70,6 +70,16 @@ Setting up the field mesh This patch is rectangular, and thus its extent is given here by the coordinates of the lower corner (``warpx.fine_tag_lo``) and upper corner (``warpx.fine_tag_hi``). +* ``warpx.n_current_deposition_buffer`` (`integer`) + When using mesh refinement: the particles that are located inside + a refinement patch, but within ``n_current_deposition_buffer`` cells of + the edge of this patch, will deposit their charge and current to the + lower refinement level, instead of depositing to the refinement patch + itself. See the section :doc:`../../theory/amr` for more details. + If this variable is not explicitly set in the input script, + ``n_current_deposition_buffer`` is automatically set so as to be large + enough to hold the particle shape, on the fine grid + * ``warpx.n_field_gather_buffer`` (`integer`; 0 by default) When using mesh refinement: the particles that are located inside a refinement patch, but within ``n_field_gather_buffer`` cells of @@ -77,14 +87,10 @@ Setting up the field mesh level, instead of gathering the fields from the refinement patch itself. This avoids some of the spurious effects that can occur inside the refinement patch, close to its edge. See the section - :doc:`../../theory/amr` for more details. - -* ``warpx.n_current_deposition_buffer`` (`integer`) - When using mesh refinement: the particles that are located inside - a refinement patch, but within ``n_current_deposition_buffer`` cells of - the edge of this patch, will deposit their charge and current to the - lower refinement level, instead of depositing to the refinement patch - itself. See the section :doc:`../../theory/amr` for more details. + :doc:`../../theory/amr` for more details. If this variable is not + explicitly set in the input script, ``n_field_gather_buffer`` is + automatically set so that it is one cell larger than + ``n_current_deposition_buffer``, on the fine grid. * ``particles.deposit_on_main_grid`` (`list of strings`) When using mesh refinement: the particle species whose name are included @@ -285,8 +291,9 @@ Particle initialization * ``species_name.predefined_profile_name`` (`string`) Only read of ``<species_name>.electrons.profile`` is `predefined`. - * If ``parabolic_channel``, the plasma profile is a parabolic profile with linear ramps - at the beginning and the end of the profile. The density is given by + * If ``parabolic_channel``, the plasma profile is a parabolic profile with + cosine-like ramps at the beginning and the end of the profile. + The density is given by .. math:: @@ -299,9 +306,9 @@ Particle initialization n(x,y) = 1 + 4\frac{x^2+y^2}{k_p^2 R_c^4} where :math:`k_p` is the plasma wavenumber associated with density :math:`n_0`. - Here, :math:`n(z)` is a linear up-ramp from :math:`0` to :math:`L_{ramp,up}`, + Here, :math:`n(z)` is a cosine-like up-ramp from :math:`0` to :math:`L_{ramp,up}`, constant to :math:`1` from :math:`L_{ramp,up}` to :math:`L_{ramp,up} + L_{plateau}` - and a linear down-ramp from :math:`L_{ramp,up} + L_{plateau}` to + and a cosine-like down-ramp from :math:`L_{ramp,up} + L_{plateau}` to :math:`L_{ramp,up} + L_{plateau}+L_{ramp,down}`. All parameters are given in ``predefined_profile_params``. @@ -528,6 +535,11 @@ Laser initialization moving window and laser propagation directions to be the same (`x`, `y` or `z`) +* ``<laser_name>.min_particles_per_mode`` (`int`) optional (default `4`) + When using the RZ version, this specifies the minimum number of particles + per angular mode. The laser particles are loaded into radial spokes, with + the number of spokes given by min_particles_per_mode*(warpx.n_rz_azimuthal_modes-1). + * ``warpx.num_mirrors`` (`int`) optional (default `0`) Users can input perfect mirror condition inside the simulation domain. The number of mirrors is given by ``warpx.num_mirrors``. The mirrors are |