aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Weiqun Zhang <weiqunzhang@lbl.gov> 2019-10-04 16:02:08 -0700
committerGravatar Weiqun Zhang <weiqunzhang@lbl.gov> 2019-10-04 16:02:08 -0700
commit4371d39fadb9667dc16ef5292691002eddbb7726 (patch)
tree370de433cc148a9ee69cf53ed05f3b4bab59c1ec /Docs/source/running_cpp
parent4e31df96d3e73ddc8d9e876c84a5bdb3989dceb0 (diff)
parent43c72306e540885d0e089de448fee23687f16504 (diff)
downloadWarpX-4371d39fadb9667dc16ef5292691002eddbb7726.tar.gz
WarpX-4371d39fadb9667dc16ef5292691002eddbb7726.tar.zst
WarpX-4371d39fadb9667dc16ef5292691002eddbb7726.zip
Merge branch 'dev' into nodal_aux_3
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst22
1 files changed, 14 insertions, 8 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index ad532023f..c45891531 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