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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/* Copyright 2019 Axel Huebl, Remi Lehe
*
* This file is part of WarpX.
*
* License: BSD-3-Clause-LBNL
*/
#ifndef WARPX_PML_PSATD_ALGORITHM_H_
#define WARPX_PML_PSATD_ALGORITHM_H_
#include "SpectralBaseAlgorithm.H"
#include "FieldSolver/SpectralSolver/SpectralFieldData_fwd.H"
#include "FieldSolver/SpectralSolver/SpectralKSpace_fwd.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.
*/
class PMLPsatdAlgorithm : public SpectralBaseAlgorithm
{
public:
PMLPsatdAlgorithm(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,
const bool dive_cleaning,
const bool divb_cleaning);
void InitializeSpectralCoefficients(
const SpectralKSpace& spectral_kspace,
const amrex::DistributionMapping& dm,
const amrex::Real dt);
// Redefine functions from base class
virtual void pushSpectralFields(SpectralFieldData& f) const override final;
virtual int getRequiredNumberOfFields() const override final;
/**
* \brief Virtual function for current correction in Fourier space
* (<a href="https://doi.org/10.1016/j.jcp.2013.03.010"> Vay et al, 2013</a>).
* This function overrides the virtual function \c CurrentCorrection in the
* base class \c SpectralBaseAlgorithm and cannot be overridden by further
* derived classes.
*
* \param[in,out] field_data All fields in Fourier space
* \param[in,out] current Array of unique pointers to \c MultiFab storing
* the three components of the current density
* \param[in] rho Unique pointer to \c MultiFab storing the charge density
*/
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;
/**
* \brief Virtual function for Vay current deposition in Fourier space
* (<a href="https://doi.org/10.1016/j.jcp.2013.03.010"> Vay et al, 2013</a>).
* This function overrides the virtual function \c VayDeposition in the
* base class \c SpectralBaseAlgorithm and cannot be overridden by further
* derived classes.
*
* \param[in,out] field_data All fields in Fourier space
* \param[in,out] current Array of unique pointers to \c MultiFab storing
* the three components of the current density
*/
virtual void VayDeposition (const int lev,
SpectralFieldData& field_data,
std::array<std::unique_ptr<amrex::MultiFab>,3>& current) override final;
private:
SpectralRealCoefficients C_coef, S_ck_coef, inv_k2_coef;
amrex::Real m_dt;
bool m_dive_cleaning;
bool m_divb_cleaning;
};
#endif // WARPX_USE_PSATD
#endif // WARPX_PML_PSATD_ALGORITHM_H_
|
