PsatdAlgorithmRZ.H

Go to the documentation of this file.

/* Copyright 2019 David Grote
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PSATD_ALGORITHM_RZ_H_
#define WARPX_PSATD_ALGORITHM_RZ_H_

#include "SpectralBaseAlgorithmRZ.H"

/* \brief Class that updates the field in spectral space
 * and stores the coefficients of the corresponding update equation.
 */
class PsatdAlgorithmRZ : public SpectralBaseAlgorithmRZ
{

    public:
        PsatdAlgorithmRZ(SpectralKSpaceRZ const & spectral_kspace,
                         amrex::DistributionMapping const & dm,
                         const SpectralFieldIndex& spectral_index,
                         int const n_rz_azimuthal_modes, int const norder_z,
                         bool const nodal, amrex::Real const dt_step,
                         bool const update_with_rho,
                         const bool time_averaging,
                         const bool J_linear_in_time,
                         const bool dive_cleaning,
                         const bool divb_cleaning);
        // Redefine functions from base class
        virtual void pushSpectralFields(SpectralFieldDataRZ & f) override final;

        void InitializeSpectralCoefficients(SpectralFieldDataRZ const & f);

        virtual void CurrentCorrection (const int lev,
                                        SpectralFieldDataRZ& 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,
                                    SpectralFieldDataRZ& field_data,
                                    std::array<std::unique_ptr<amrex::MultiFab>,3>& current) override final;

    private:

        SpectralFieldIndex m_spectral_index;

        bool coefficients_initialized;
        // Note that dt is saved to use in InitializeSpectralCoefficients
        amrex::Real m_dt;
        bool m_update_with_rho;
        bool m_time_averaging;
        bool m_J_linear_in_time;
        bool m_dive_cleaning;
        bool m_divb_cleaning;
        SpectralRealCoefficients C_coef, S_ck_coef, X1_coef, X2_coef, X3_coef;
        SpectralRealCoefficients X5_coef, X6_coef;
};

#endif // WARPX_PSATD_ALGORITHM_RZ_H_