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
|
/* Copyright 2019 David Grote
*
* This file is part of WarpX.
*
* License: BSD-3-Clause-LBNL
*/
#ifndef WARPX_SPECTRAL_BASE_ALGORITHM_RZ_H_
#define WARPX_SPECTRAL_BASE_ALGORITHM_RZ_H_
#include "FieldSolver/SpectralSolver/SpectralKSpaceRZ.H"
#include "FieldSolver/SpectralSolver/SpectralFieldDataRZ.H"
/* \brief Class that updates the field in spectral space
* and stores the coefficients of the corresponding update equation.
*
* `SpectralBaseAlgorithmRZ` is only a base class and cannot be used directly.
* Instead use its subclasses, which implement the specific field update
* equations for a given spectral algorithm.
*/
class SpectralBaseAlgorithmRZ
{
public:
// Virtual member function ; meant to be overridden in subclasses
virtual void pushSpectralFields(SpectralFieldDataRZ & f) = 0;
virtual int getRequiredNumberOfFields() const = 0;
// The destructor should also be a virtual function, so that
// a pointer to subclass of `SpectraBaseAlgorithm` actually
// calls the subclass's destructor.
virtual ~SpectralBaseAlgorithmRZ() {};
/**
* \brief Virtual function for current correction in Fourier space
* (equation (19) of https://doi.org/10.1016/j.jcp.2013.03.010).
* This virtual function is not pure: it can be overridden in derived
* classes (e.g. PsatdAlgorithmRZ), but a base-class
* implementation is provided (empty implementation in this case).
*
* \param[in,out] field_data all fields in Fourier space
* \param[in,out] current two-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 ( SpectralFieldDataRZ& field_data,
std::array<std::unique_ptr<amrex::MultiFab>,3>& current,
const std::unique_ptr<amrex::MultiFab>& rho ) {};
/**
* \brief Compute spectral divergence of E
*/
void ComputeSpectralDivE ( SpectralFieldDataRZ& field_data,
const std::array<std::unique_ptr<amrex::MultiFab>,3>& Efield,
amrex::MultiFab& divE );
protected: // Meant to be used in the subclasses
using SpectralCoefficients = amrex::FabArray< amrex::BaseFab <amrex::Real> >;
// Constructor
SpectralBaseAlgorithmRZ(SpectralKSpaceRZ const & spectral_kspace,
amrex::DistributionMapping const & dm,
int const norder_z, bool const nodal)
// Compute and assign the modified k vectors
: modified_kz_vec(spectral_kspace.getModifiedKComponent(dm, 1, norder_z, nodal))
{};
// Modified finite-order vectors
KVectorComponent modified_kz_vec;
};
#endif // WARPX_SPECTRAL_BASE_ALGORITHM_RZ_H_
|
