aboutsummaryrefslogtreecommitdiff
path: root/Source/FieldSolver/SpectralSolver/SpectralAlgorithms/SpectralBaseAlgorithm.H
blob: 18d26e0c87afd14869d46cd3b6a4a40b5618ca66 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#ifndef WARPX_SPECTRAL_BASE_ALGORITHM_H_
#define WARPX_SPECTRAL_BASE_ALGORITHM_H_

#include <SpectralKSpace.H>
#include <SpectralFieldData.H>

/* \brief Class that updates the field in spectral space
 * and stores the coefficients of the corresponding update equation.
 * TODO: Mention base class
 */
class SpectralBaseAlgorithm
{
    public:
        // Member function that updates the fields in spectral space ;
        // meant to be overridden in subclasses
        virtual void pushSpectralFields(SpectralFieldData& f) const = 0;

    protected: // Meant to be used in the subclasses

        using SpectralCoefficients = amrex::FabArray< amrex::BaseFab <amrex::Real> >;

        // Constructor
        SpectralBaseAlgorithm(const SpectralKSpace& spectral_kspace,
                              const amrex::DistributionMapping& dm,
                              const int norder_x, const int norder_y,
                              const int norder_z, const bool nodal)
          // Compute and assign the modified k vectors
          : modified_kx_vec(spectral_kspace.getModifiedKComponent(dm,0,norder_x,nodal)),
#if (AMREX_SPACEDIM==3)
            modified_ky_vec(spectral_kspace.getModifiedKComponent(dm,1,norder_y,nodal)),
            modified_kz_vec(spectral_kspace.getModifiedKComponent(dm,2,norder_z,nodal))
#else
            modified_kz_vec(spectral_kspace.getModifiedKComponent(dm,1,norder_z,nodal))
#endif
          {};

        // Modified finite-order vectors
        KVectorComponent modified_kx_vec, modified_kz_vec;
#if (AMREX_SPACEDIM==3)
        KVectorComponent modified_ky_vec;
#endif
};

#endif // WARPX_SPECTRAL_BASE_ALGORITHM_H_