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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/* Copyright 2019 Andrew Myers, Axel Huebl, David Grote
* Maxence Thevenet, Remi Lehe, Weiqun Zhang
*
*
* This file is part of WarpX.
*
* License: BSD-3-Clause-LBNL
*/
#ifndef PLASMA_INJECTOR_H_
#define PLASMA_INJECTOR_H_
#include "InjectorDensity.H"
#include "InjectorMomentum.H"
#include "TemperatureProperties.H"
#include "VelocityProperties.H"
#include "Particles/SpeciesPhysicalProperties.H"
#include "InjectorPosition_fwd.H"
#include <AMReX_Dim3.H>
#include <AMReX_REAL.H>
#include <AMReX_Vector.H>
#include <AMReX_BaseFwd.H>
#ifdef WARPX_USE_OPENPMD
# include <openPMD/openPMD.hpp>
#endif
#include <limits>
#include <memory>
#include <string>
///
/// The PlasmaInjector class parses and stores information about the plasma
/// type used in the particle container. This information is used to create the
/// particles on initialization and whenever the window moves.
///
class PlasmaInjector
{
public:
PlasmaInjector ();
PlasmaInjector (int ispecies, const std::string& name);
~PlasmaInjector ();
// bool: whether the point (x, y, z) is inside the plasma region
bool insideBounds (amrex::Real x, amrex::Real y, amrex::Real z) const noexcept;
// bool: whether the region defined by lo and hi overlaps with the plasma region
bool overlapsWith (const amrex::XDim3& lo, const amrex::XDim3& hi) const noexcept;
int num_particles_per_cell;
amrex::Real num_particles_per_cell_real;
amrex::Vector<int> num_particles_per_cell_each_dim;
// gamma * beta
amrex::XDim3 getMomentum (amrex::Real x, amrex::Real y, amrex::Real z) const noexcept;
amrex::Real getCharge () {return charge;}
amrex::Real getMass () {return mass;}
PhysicalSpecies getPhysicalSpecies() const {return physical_species;}
// bool: whether the initial injection of particles should be done
// This routine is called during initialization of the plasma. When injecting
// a surface flux, no injection is done doing initialization so return false.
bool doInjection () const noexcept { return h_inj_pos != nullptr && !surface_flux;}
bool add_single_particle = false;
amrex::Vector<amrex::ParticleReal> single_particle_pos;
amrex::Vector<amrex::ParticleReal> single_particle_vel;
amrex::ParticleReal single_particle_weight;
bool add_multiple_particles = false;
amrex::Vector<amrex::ParticleReal> multiple_particles_pos_x;
amrex::Vector<amrex::ParticleReal> multiple_particles_pos_y;
amrex::Vector<amrex::ParticleReal> multiple_particles_pos_z;
amrex::Vector<amrex::ParticleReal> multiple_particles_vel_x;
amrex::Vector<amrex::ParticleReal> multiple_particles_vel_y;
amrex::Vector<amrex::ParticleReal> multiple_particles_vel_z;
amrex::Vector<amrex::ParticleReal> multiple_particles_weight;
bool gaussian_beam = false;
amrex::Real x_m;
amrex::Real y_m;
amrex::Real z_m;
amrex::Real x_rms;
amrex::Real y_rms;
amrex::Real z_rms;
amrex::Real x_cut = std::numeric_limits<amrex::Real>::max();
amrex::Real y_cut = std::numeric_limits<amrex::Real>::max();
amrex::Real z_cut = std::numeric_limits<amrex::Real>::max();
amrex::Real q_tot = 0.0;
long npart;
int do_symmetrize = 0;
bool external_file = false; //! initialize from an openPMD file
amrex::Real z_shift = 0.0; //! additional z offset for particle positions
#ifdef WARPX_USE_OPENPMD
//! openPMD::Series to load from in external_file injection
std::unique_ptr<openPMD::Series> m_openpmd_input_series;
#endif
bool surface_flux = false; // inject from a surface
amrex::Real surface_flux_pos; // surface location
int flux_normal_axis;
int flux_direction; // -1 for left, +1 for right
bool radially_weighted = true;
std::string str_density_function;
std::string str_momentum_function_ux;
std::string str_momentum_function_uy;
std::string str_momentum_function_uz;
amrex::Real xmin, xmax;
amrex::Real ymin, ymax;
amrex::Real zmin, zmax;
amrex::Real density_min = std::numeric_limits<amrex::Real>::epsilon();
amrex::Real density_max = std::numeric_limits<amrex::Real>::max();
InjectorPosition* getInjectorPosition ();
InjectorDensity* getInjectorDensity ();
InjectorMomentum* getInjectorMomentum ();
protected:
amrex::Real mass, charge;
PhysicalSpecies physical_species = PhysicalSpecies::unspecified;
amrex::Real density;
int species_id;
std::string species_name;
std::unique_ptr<InjectorPosition> h_inj_pos;
InjectorPosition* d_inj_pos = nullptr;
std::unique_ptr<InjectorDensity,InjectorDensityDeleter> h_inj_rho;
InjectorDensity* d_inj_rho = nullptr;
std::unique_ptr<amrex::Parser> density_parser;
std::unique_ptr<InjectorMomentum,InjectorMomentumDeleter> h_inj_mom;
InjectorMomentum* d_inj_mom = nullptr;
std::unique_ptr<amrex::Parser> ux_parser;
std::unique_ptr<amrex::Parser> uy_parser;
std::unique_ptr<amrex::Parser> uz_parser;
// Keep a pointer to TemperatureProperties to ensure the lifetime of the
// contained Parser
std::unique_ptr<TemperatureProperties> h_mom_temp;
std::unique_ptr<VelocityProperties> h_mom_vel;
void parseDensity (amrex::ParmParse& pp);
void parseMomentum (amrex::ParmParse& pp);
};
#endif
|
