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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/* Copyright 2019-2020 Maxence Thevenet, Remi Lehe, Edoardo Zoni
*
* This file is part of WarpX.
*
* License: BSD-3-Clause-LBNL
*/
#ifndef WARPX_SPECTRAL_SOLVER_H_
#define WARPX_SPECTRAL_SOLVER_H_
#include "SpectralAlgorithms/SpectralBaseAlgorithm.H"
#include "SpectralFieldData.H"
#ifdef WARPX_USE_PSATD
/**
* \brief Top-level class for the electromagnetic spectral solver
*
* Stores the field in spectral space, and has member functions
* to Fourier-transform the fields between real space and spectral space
* and to update fields in spectral space over one time step.
*/
class SpectralSolver
{
public:
// Inline definition of the member functions of `SpectralSolver`,
// except the constructor (see `SpectralSolver.cpp`)
// The body of these functions is short, since the work is done in the
// underlying classes `SpectralFieldData` and `PsatdAlgorithm`
// Constructor
SpectralSolver( const amrex::BoxArray& realspace_ba,
const amrex::DistributionMapping& dm,
const int norder_x, const int norder_y,
const int norder_z, const bool nodal,
const amrex::Array<amrex::Real,3>& v_galilean,
const amrex::RealVect dx, const amrex::Real dt,
const bool pml=false,
const bool periodic_single_box=false,
const bool update_with_rho=false,
const bool fft_do_time_averaging=false);
/**
* \brief Transform the component `i_comp` of MultiFab `mf`
* to spectral space, and store the corresponding result internally
* (in the spectral field specified by `field_index`) */
void ForwardTransform( const amrex::MultiFab& mf,
const int field_index,
const int i_comp=0 );
/**
* \brief Transform spectral field specified by `field_index` back to
* real space, and store it in the component `i_comp` of `mf`
*/
void BackwardTransform( amrex::MultiFab& mf,
const int field_index,
const int i_comp=0 );
/**
* \brief Update the fields in spectral space, over one timestep
*/
void pushSpectralFields();
/**
* \brief Public interface to call the member function ComputeSpectralDivE
* of the base class SpectralBaseAlgorithm from objects of class SpectralSolver
*/
void ComputeSpectralDivE ( const std::array<std::unique_ptr<amrex::MultiFab>,3>& Efield,
amrex::MultiFab& divE ) {
algorithm->ComputeSpectralDivE( field_data, Efield, divE );
}
/**
* \brief Public interface to call the virtual function \c CurrentCorrection,
* defined in the base class SpectralBaseAlgorithm and possibly overridden
* by its derived classes (e.g. PsatdAlgorithm, GalileanAlgorithm), from
* objects of class SpectralSolver through the private unique pointer \c algorithm
*
* \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
*/
void CurrentCorrection ( std::array<std::unique_ptr<amrex::MultiFab>,3>& current,
const std::unique_ptr<amrex::MultiFab>& rho ) {
algorithm->CurrentCorrection( field_data, current, rho );
}
/**
* \brief Public interface to call the virtual function \c VayDeposition,
* declared in the base class SpectralBaseAlgorithm and defined in its
* derived classes, from objects of class SpectralSolver through the private
* unique pointer \c algorithm.
*
* \param[in,out] current Array of unique pointers to \c MultiFab storing
* the three components of the current density
*/
void VayDeposition (std::array<std::unique_ptr<amrex::MultiFab>,3>& current)
{
algorithm->VayDeposition(field_data, current);
}
private:
void ReadParameters ();
// Store field in spectral space and perform the Fourier transforms
SpectralFieldData field_data;
// Defines field update equation in spectral space and the associated coefficients.
// SpectralBaseAlgorithm is a base class; this pointer is meant to point
// to an instance of a sub-class defining a specific algorithm
std::unique_ptr<SpectralBaseAlgorithm> algorithm;
};
#endif // WARPX_USE_PSATD
#endif // WARPX_SPECTRAL_SOLVER_H_
|
