WarpX
SpectralBaseAlgorithm.H
Go to the documentation of this file.
1 /* Copyright 2019 Remi Lehe, Edoardo Zoni
2  *
3  * This file is part of WarpX.
4  *
5  * License: BSD-3-Clause-LBNL
6  */
7 #ifndef WARPX_SPECTRAL_BASE_ALGORITHM_H_
8 #define WARPX_SPECTRAL_BASE_ALGORITHM_H_
9 
11 #include "Utils/WarpX_Complex.H"
12 
15 
16 #include <AMReX_BaseFab.H>
17 #include <AMReX_Config.H>
18 #include <AMReX_FabArray.H>
19 #include <AMReX_REAL.H>
20 
21 #include <AMReX_BaseFwd.H>
22 
23 #include <array>
24 #include <memory>
25 
26 #if WARPX_USE_PSATD
27 
28 /* \brief Class that updates the field in spectral space
29  * and stores the coefficients of the corresponding update equation.
30  *
31  * `SpectralBaseAlgorithm` is only a base class and cannot be used directly.
32  * Instead use its subclasses, which implement the specific field update
33  * equations for a given spectral algorithm.
34  */
36 {
37  public:
38  // Virtual member function ; meant to be overridden in subclasses
39  virtual void pushSpectralFields(SpectralFieldData& f) const = 0;
40 
41  // The destructor should also be a virtual function, so that
42  // a pointer to subclass of `SpectraBaseAlgorithm` actually
43  // calls the subclass's destructor.
44  virtual ~SpectralBaseAlgorithm() = default;
45 
46  // Default move and copy operations
51 
59  virtual void CurrentCorrection (SpectralFieldData& field_data) = 0;
60 
68  virtual void VayDeposition (SpectralFieldData& field_data) = 0;
69 
73  void ComputeSpectralDivE ( int lev,
74  SpectralFieldData& field_data,
75  const std::array<std::unique_ptr<amrex::MultiFab>,3>& Efield,
76  amrex::MultiFab& divE );
77 
78  protected: // Meant to be used in the subclasses
79 
81  amrex::FabArray< amrex::BaseFab <amrex::Real> >;
83  amrex::FabArray< amrex::BaseFab <Complex> >;
84 
88  SpectralBaseAlgorithm(const SpectralKSpace& spectral_kspace,
90  const SpectralFieldIndex& spectral_index,
91  int norder_x, int norder_y,
92  int norder_z, short grid_type);
93 
95 
96  // Modified finite-order vectors
98 #if defined(WARPX_DIM_3D)
99  KVectorComponent modified_ky_vec;
100 #endif
102 };
103 
104 #endif // WARPX_USE_PSATD
105 #endif // WARPX_SPECTRAL_BASE_ALGORITHM_H_
Definition: SpectralBaseAlgorithm.H:36
KVectorComponent modified_kz_vec
Definition: SpectralBaseAlgorithm.H:101
virtual void pushSpectralFields(SpectralFieldData &f) const =0
SpectralFieldIndex m_spectral_index
Definition: SpectralBaseAlgorithm.H:94
SpectralBaseAlgorithm(SpectralBaseAlgorithm &&)=default
KVectorComponent modified_kx_vec
Definition: SpectralBaseAlgorithm.H:97
SpectralBaseAlgorithm & operator=(const SpectralBaseAlgorithm &)=default
virtual void VayDeposition(SpectralFieldData &field_data)=0
Virtual function for Vay current deposition in Fourier space (Vay et al, 2013). This virtual function...
void ComputeSpectralDivE(int lev, SpectralFieldData &field_data, const std::array< std::unique_ptr< amrex::MultiFab >, 3 > &Efield, amrex::MultiFab &divE)
Compute spectral divergence of E.
Definition: SpectralBaseAlgorithm.cpp:54
SpectralBaseAlgorithm & operator=(SpectralBaseAlgorithm &&)=default
virtual void CurrentCorrection(SpectralFieldData &field_data)=0
Virtual function for current correction in Fourier space (Vay et al, 2013). This virtual function is ...
virtual ~SpectralBaseAlgorithm()=default
SpectralBaseAlgorithm(const SpectralBaseAlgorithm &)=default
Class that stores the fields in spectral space, and performs the Fourier transforms between real spac...
Definition: SpectralFieldData.H:143
Definition: SpectralFieldData.H:34
Class that represents the spectral space.
Definition: SpectralKSpace.H:48