diff options
Diffstat (limited to 'Docs/source')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 7 | ||||
| -rw-r--r-- | Docs/source/theory/picsar_theory.rst | 16 |
2 files changed, 19 insertions, 4 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index d0d490875..d2b18c628 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -1078,9 +1078,8 @@ Numerics and algorithms * ``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 - is ``esirkepov`` if WarpX is compiled with the FDTD solver (that is, with - ``USE_PSATD=FALSE``) and ``direct`` if WarpX is compiled with the standard or - Galilean PSATD solver (that is, with ``USE_PSATD=TRUE``). + is ``esirkepov`` for FDTD maxwell solvers and ``direct`` for standard or + Galilean PSATD solver (that is, with ``algo.maxwell_solver = psatd``). 1. ``direct`` @@ -1136,9 +1135,9 @@ Numerics and algorithms - ``yee``: Yee FDTD solver. - ``ckc``: (not available in ``RZ`` geometry) Cole-Karkkainen solver with Cowan coefficients (see `Cowan, PRSTAB 16 (2013) <https://journals.aps.org/prab/abstract/10.1103/PhysRevSTAB.16.041303>`__) + - ``psatd``: Pseudo-spectral solver (see :ref:`theory <theory-pic-mwsolve-psatd>`) If ``algo.maxwell_solver`` is not specified, ``yee`` is the default. - Note: this option is currently ignored with PSATD. * ``algo.em_solver_medium`` (`string`, optional) The medium for evaluating the Maxwell solver. Available options are : diff --git a/Docs/source/theory/picsar_theory.rst b/Docs/source/theory/picsar_theory.rst index 0519778f3..b4b18e1a4 100644 --- a/Docs/source/theory/picsar_theory.rst +++ b/Docs/source/theory/picsar_theory.rst @@ -10,6 +10,8 @@ \linenumbers +.. _theory-pic: + The electromagnetic Particle-In-Cell method =========================================== @@ -49,6 +51,8 @@ on the grid from the particles’ positions and velocities, while the electric and magnetic field components are interpolated from the grid to the particles’ positions for the velocity update. +.. _theory-pic-push: + Particle push ------------- @@ -64,6 +68,8 @@ equations of motion is given by In order to close the system, :math:`\bar{\mathbf{v}}^{i}` must be expressed as a function of the other quantities. The two implementations that have become the most popular are presented below. +.. _theory-pic-push-boris: + Boris relativistic velocity rotation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -94,6 +100,8 @@ where :math:`\mathbf{t}=\left(q\Delta t/2m\right)\mathbf{B}^{i}/\bar{\gamma}^{i} The Boris implementation is second-order accurate, time-reversible and fast. Its implementation is very widespread and used in the vast majority of PIC codes. +.. _theory-pic-push-vay: + Vay Lorentz-invariant formulation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -125,6 +133,8 @@ charged particle beams, where the accurate account of the cancellation of the self-generated electric and magnetic fields is essential, as shown in (Vay 2008). +.. _theory-pic-mwsolve: + Field solve ----------- @@ -139,6 +149,8 @@ analytical time-domain (PSATD) and pseudo-spectral time-domain (PSTD) algorithms. Extension to multiresolution (or mesh refinement) PIC is described in, e.g. (Vay et al. 2012; Vay, Adam, and Heron 2004). +.. _theory-pic-mwsolve-fdtd: + Finite-Difference Time-Domain (FDTD) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -179,6 +191,8 @@ center of the cell faces. Knowing the current densities at half-integer steps, the electric field components are updated alternately with the magnetic field components at integer and half-integer steps respectively. +.. _theory-pic-mwsolve-nsfdtd: + Non-Standard Finite-Difference Time-Domain (NSFDTD) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -236,6 +250,8 @@ the same paper that removing the Nyquist component in all the source terms using a bilinear filter (see description of the filter below) suppresses this instability. +.. _theory-pic-mwsolve-psatd: + Pseudo Spectral Analytical Time Domain (PSATD) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |