PsatdAlgorithmGalilean.H

Go to the documentation of this file.

/* Copyright 2019
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PSATD_ALGORITHM_GALILEAN_H_
#define WARPX_PSATD_ALGORITHM_GALILEAN_H_
 
#include "FieldSolver/SpectralSolver/SpectralFieldData.H"
#include "FieldSolver/SpectralSolver/SpectralKSpace.H"
#include "SpectralBaseAlgorithm.H"
 
#include <ablastr/utils/Enums.H>
 
#include <AMReX_Array.H>
#include <AMReX_Config.H>
#include <AMReX_REAL.H>
 
#include <AMReX_BaseFwd.H>
 
#include <array>
#include <memory>
 
#if WARPX_USE_FFT
/* \brief Class that updates the field in spectral space
 * and stores the coefficients of the corresponding update equation.
 */
class PsatdAlgorithmGalilean : public SpectralBaseAlgorithm
{
    public:

        PsatdAlgorithmGalilean (
            const SpectralKSpace& spectral_kspace,
            const amrex::DistributionMapping& dm,
            const SpectralFieldIndex& spectral_index,
            int norder_x,
            int norder_y,
            int norder_z,
            ablastr::utils::enums::GridType grid_type,
            const amrex::Vector<amrex::Real>& v_galilean,
            amrex::Real dt,
            bool update_with_rho,
            bool time_averaging,
            bool dive_cleaning,
            bool divb_cleaning);

        void pushSpectralFields (SpectralFieldData& f) const final;

        void InitializeSpectralCoefficients (
            const SpectralKSpace& spectral_kspace,
            const amrex::DistributionMapping& dm,
            amrex::Real dt);

        void InitializeSpectralCoefficientsAveraging (
            const SpectralKSpace& spectral_kspace,
            const amrex::DistributionMapping& dm,
            amrex::Real dt);

        void CurrentCorrection (SpectralFieldData& field_data) final;

        void VayDeposition (SpectralFieldData& field_data) final;
 
    private:
 
        // These real and complex coefficients are always allocated
        SpectralRealCoefficients C_coef, S_ck_coef;
        SpectralComplexCoefficients T2_coef, X1_coef, X2_coef, X3_coef, X4_coef;
 
        // These real and complex coefficients are allocated only with averaged Galilean PSATD
        SpectralComplexCoefficients Psi1_coef, Psi2_coef, Y1_coef, Y2_coef, Y3_coef, Y4_coef;
 
        // Centered modified finite-order k vectors
        KVectorComponent modified_kx_vec_centered;
#if defined(WARPX_DIM_3D)
        KVectorComponent modified_ky_vec_centered;
#endif
        KVectorComponent modified_kz_vec_centered;
 
        // Other member variables
        amrex::Vector<amrex::Real> m_v_galilean;
        amrex::Real m_dt;
        bool m_update_with_rho;
        bool m_time_averaging;
};
#endif // WARPX_USE_FFT
#endif // WARPX_PSATD_ALGORITHM_GALILEAN_H_