ComovingPsatdAlgorithm.H

Go to the documentation of this file.

#ifndef WARPX_COMOVING_PSATD_ALGORITHM_H_
#define WARPX_COMOVING_PSATD_ALGORITHM_H_

#include "FieldSolver/SpectralSolver/SpectralFieldData.H"
#include "FieldSolver/SpectralSolver/SpectralKSpace.H"
#include "SpectralBaseAlgorithm.H"

#include <AMReX_Array.H>
#include <AMReX_Config.H>
#include <AMReX_REAL.H>

#include <AMReX_BaseFwd.H>

#include <array>
#include <memory>

#if WARPX_USE_PSATD

/* \brief Class that updates the field in spectral space and stores the coefficients
 * of the corresponding update equation, according to the comoving spectral scheme.
 */
class ComovingPsatdAlgorithm : public SpectralBaseAlgorithm
{
    public:

        ComovingPsatdAlgorithm (const SpectralKSpace& spectral_kspace,
                                const amrex::DistributionMapping& dm,
                                const SpectralFieldIndex& spectral_index,
                                const int norder_x,
                                const int norder_y,
                                const int norder_z,
                                const bool nodal,
                                const amrex::IntVect& fill_guards,
                                const amrex::Array<amrex::Real,3>& v_comoving,
                                const amrex::Real dt,
                                const bool update_with_rho);

        virtual void pushSpectralFields (SpectralFieldData& f) const override final;

        /* \brief Initialize the coefficients needed in the update equations
         */
        void InitializeSpectralCoefficients (const SpectralKSpace& spectral_kspace,
                                             const amrex::DistributionMapping& dm,
                                             const amrex::Real dt);

        virtual void CurrentCorrection (const int lev,
                                        SpectralFieldData& field_data,
                                        std::array<std::unique_ptr<amrex::MultiFab>,3>& current,
                                        const std::unique_ptr<amrex::MultiFab>& rho) override final;

        virtual void VayDeposition (const int lev,
                                    SpectralFieldData& field_data,
                                    std::array<std::unique_ptr<amrex::MultiFab>,3>& current) override final;

    private:

        // Real and complex spectral coefficients
        SpectralRealCoefficients C_coef, S_ck_coef;
        SpectralComplexCoefficients Theta2_coef, X1_coef, X2_coef, X3_coef, X4_coef;

        SpectralFieldIndex m_spectral_index;

        // k vectors
        KVectorComponent kx_vec;
#if (AMREX_SPACEDIM==3)
        KVectorComponent ky_vec;
#endif
        KVectorComponent kz_vec;

        // Additional member variables
        amrex::Array<amrex::Real,3> m_v_comoving;
        amrex::Real m_dt;
};

#endif // WARPX_USE_PSATD
#endif // WARPX_COMOVING_PSATD_ALGORITHM_H_