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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/* Copyright 2019 Maxence Thevenet, Remi Lehe, Revathi Jambunathan, Edoardo Zoni
*
*
* This file is part of WarpX.
*
* License: BSD-3-Clause-LBNL
*/
#ifndef WARPX_PSATD_ALGORITHM_H_
#define WARPX_PSATD_ALGORITHM_H_
#include "SpectralBaseAlgorithm.H"
#if WARPX_USE_PSATD
/**
* \brief Class that updates the field in spectral space
* and stores the coefficients of the corresponding update equation.
*/
class PsatdAlgorithm : public SpectralBaseAlgorithm
{
public:
PsatdAlgorithm(const SpectralKSpace& spectral_kspace,
const amrex::DistributionMapping& dm,
const int norder_x, const int norder_y,
const int norder_z, const bool nodal,
const amrex::Real dt);
// Redefine functions from base class
virtual void pushSpectralFields(SpectralFieldData& f) const override final;
virtual int getRequiredNumberOfFields() const override final {
return SpectralFieldIndex::n_fields;
}
void InitializeSpectralCoefficients(const SpectralKSpace& spectral_kspace,
const amrex::DistributionMapping& dm,
const amrex::Real dt);
/**
* \brief Virtual function for current correction in Fourier space
* (equation (19) of https://doi.org/10.1016/j.jcp.2013.03.010).
* This function overrides the virtual function \c CurrentCorrection in the
* base class \c SpectralBaseAlgorithm (qualifier \c override) and cannot be
* overridden by further derived classes (qualifier \c final).
*
* \param[in,out] field_data all fields in Fourier space
* \param[in,out] current three-dimensional array of unique pointers to MultiFab
* storing the three components of the current density
* \param[in] rho unique pointer to MultiFab storing the charge density
*/
virtual void CurrentCorrection ( SpectralFieldData& field_data,
std::array<std::unique_ptr<amrex::MultiFab>,3>& current,
const std::unique_ptr<amrex::MultiFab>& rho ) override final;
private:
SpectralRealCoefficients C_coef, S_ck_coef, X1_coef, X2_coef, X3_coef;
amrex::Real m_dt;
};
#endif // WARPX_USE_PSATD
#endif // WARPX_PSATD_ALGORITHM_H_
|