diff options
author | 2020-07-27 09:19:47 -0700 | |
---|---|---|
committer | 2020-07-27 09:19:47 -0700 | |
commit | df0ec5715c081e71f7f4bcd13a1a895fcd942436 (patch) | |
tree | 70e203bd6a8e06a0eda68695ca0eb1d7687c5f6b /Docs/source/running_cpp/parameters.rst | |
parent | f68983f03ff24d6207c76a6a0ca30ed87ce1adad (diff) | |
download | WarpX-df0ec5715c081e71f7f4bcd13a1a895fcd942436.tar.gz WarpX-df0ec5715c081e71f7f4bcd13a1a895fcd942436.tar.zst WarpX-df0ec5715c081e71f7f4bcd13a1a895fcd942436.zip |
Added k-space filter for RZ spectral solver (#1006)
* Added k-space filter for RZ spectral solver
* Added SpectralBinomialFilter files for RZ spectral solver
* Added RZspectral binomial filter to CMakeLists.txt
* Update Docs/source/running_cpp/parameters.rst
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Update Docs/source/running_cpp/parameters.rst
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Update Source/FieldSolver/SpectralSolver/SpectralBinomialFilter.H
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Update Source/FieldSolver/SpectralSolver/SpectralBinomialFilter.cpp
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Update Source/FieldSolver/SpectralSolver/SpectralFieldDataRZ.H
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* Fixed literals in SpectralBinomialFilter.cpp
* For RZ spectral, apply filter to rho old and new
* Added SpectralBinomialFilter::InitFilterArray
* For SpectralBinomialFilter, combine R and Z into one routine
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* For SpectralBinomialFilter, combine R and Z into one routine, part 2
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
* For SpectralBinomialFilter, combine R and Z into one routine, part 3
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
Co-authored-by: Edoardo Zoni <59625522+EZoni@users.noreply.github.com>
Diffstat (limited to 'Docs/source/running_cpp/parameters.rst')
-rw-r--r-- | Docs/source/running_cpp/parameters.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index f28b88a1c..7e72ee1c7 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -950,10 +950,21 @@ Numerics and algorithms them from the macroparticles. This uses a bilinear filter (see the sub-section **Filtering** in :doc:`../theory/theory`). +* ``warpx.use_kspace_filter`` (`0` or `1`; default: `0`) + Whether to smooth the charge and currents on the mesh, after depositing + them from the macroparticles. This uses a bilinear filter, applying the + filter in k-space. It is only supported with the RZ spectral solver. + (see the sub-section **Filtering** in :doc:`../theory/theory`). + * ``warpx.filter_npass_each_dir`` (`3 int`) optional (default `1 1 1`) Number of passes along each direction for the bilinear filter. In 2D simulations, only the first two values are read. +* ``warpx.use_filter_compensation`` (`0` or `1`; default: `0`) + Whether to add compensation when applying k-space filtering. + This requires `warpx.use_kspace_filter=1` and is only supported + with the RZ spectral solver. + * ``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 |