WarpX
PsatdAlgorithmPmlRZ.H
Go to the documentation of this file.
1 /* Copyright 2021 David Grote
2  *
3  * This file is part of WarpX.
4  *
5  * License: BSD-3-Clause-LBNL
6  */
7 #ifndef WARPX_PSATD_ALGORITHM_PML_RZ_H_
8 #define WARPX_PSATD_ALGORITHM_PML_RZ_H_
9 
11 
12 /* \brief Class that updates the field in spectral space
13  * and stores the coefficients of the corresponding update equation.
14  */
16 {
17 
18  public:
19  PsatdAlgorithmPmlRZ (SpectralKSpaceRZ const & spectral_kspace,
20  amrex::DistributionMapping const & dm,
21  const SpectralFieldIndex& spectral_index,
22  int n_rz_azimuthal_modes, int norder_z,
23  short grid_type, amrex::Real dt_step);
24 
25  // Redefine functions from base class
26  void pushSpectralFields (SpectralFieldDataRZ & f) final;
27 
29 
39  void CurrentCorrection (SpectralFieldDataRZ& field_data) final;
40 
50  void VayDeposition (SpectralFieldDataRZ& field_data) final;
51 
52  private:
53 
55  // Note that dt is saved to use in InitializeSpectralCoefficients
56  amrex::Real m_dt;
58 };
59 
60 #endif // WARPX_PSATD_ALGORITHM_PML_RZ_H_
Definition: PsatdAlgorithmPmlRZ.H:16
void pushSpectralFields(SpectralFieldDataRZ &f) final
Definition: PsatdAlgorithmPmlRZ.cpp:37
void CurrentCorrection(SpectralFieldDataRZ &field_data) final
Virtual function for current correction in Fourier space (Vay et al, 2013). This function overrides t...
Definition: PsatdAlgorithmPmlRZ.cpp:160
SpectralRealCoefficients S_ck_coef
Definition: PsatdAlgorithmPmlRZ.H:57
amrex::Real m_dt
Definition: PsatdAlgorithmPmlRZ.H:56
bool coefficients_initialized
Definition: PsatdAlgorithmPmlRZ.H:54
PsatdAlgorithmPmlRZ(SpectralKSpaceRZ const &spectral_kspace, amrex::DistributionMapping const &dm, const SpectralFieldIndex &spectral_index, int n_rz_azimuthal_modes, int norder_z, short grid_type, amrex::Real dt_step)
Definition: PsatdAlgorithmPmlRZ.cpp:19
void InitializeSpectralCoefficients(SpectralFieldDataRZ const &f)
Definition: PsatdAlgorithmPmlRZ.cpp:113
SpectralRealCoefficients C_coef
Definition: PsatdAlgorithmPmlRZ.H:57
void VayDeposition(SpectralFieldDataRZ &field_data) final
Virtual function for Vay current deposition in Fourier space (Vay et al, 2013). This function overrid...
Definition: PsatdAlgorithmPmlRZ.cpp:167
Definition: SpectralBaseAlgorithmRZ.H:21
Definition: SpectralFieldDataRZ.H:23
Definition: SpectralFieldData.H:34
Definition: SpectralKSpaceRZ.H:21