PsatdAlgorithmPml.H

Go to the documentation of this file.

/* Copyright 2019 Axel Huebl, Remi Lehe
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PSATD_ALGORITHM_PML_H_
#define WARPX_PSATD_ALGORITHM_PML_H_
 
#include "SpectralBaseAlgorithm.H"
 
#include "FieldSolver/SpectralSolver/SpectralFieldData_fwd.H"
#include "FieldSolver/SpectralSolver/SpectralKSpace_fwd.H"
 
#include <ablastr/utils/Enums.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 PsatdAlgorithmPml : public SpectralBaseAlgorithm
{
    public:

        PsatdAlgorithmPml(
            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 dive_cleaning,
            bool divb_cleaning);

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

        void pushSpectralFields(SpectralFieldData& f) const final;

        void CurrentCorrection (SpectralFieldData& field_data) final;

        void VayDeposition (SpectralFieldData& field_data) final;
 
    private:
 
        SpectralRealCoefficients C_coef, S_ck_coef, inv_k2_coef;
        SpectralComplexCoefficients T2_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;
        amrex::Vector<amrex::Real> m_v_galilean;
        amrex::Real m_dt;
        bool m_dive_cleaning;
        bool m_divb_cleaning;
        bool m_is_galilean;
};
 
#endif // WARPX_USE_FFT
#endif // WARPX_PSATD_ALGORITHM_PML_H_