10 #ifndef WARPX_WarpXParticleContainer_H_
11 #define WARPX_WarpXParticleContainer_H_
61 [[nodiscard]]
const std::array<RealVector, PIdx::nattribs>&
GetAttribs ()
const
66 [[nodiscard]] std::array<RealVector, PIdx::nattribs>&
GetAttribs ()
169 int n_external_attr_real,
170 int n_external_attr_int) = 0;
178 void PushX (
int lev, amrex::Real
dt);
203 amrex::Real
dt, amrex::Real relative_time);
216 bool local =
false,
bool reset =
false,
217 bool apply_boundary_and_scale_volume =
false,
218 bool interpolate_across_levels =
true,
220 void DepositCharge (std::unique_ptr<amrex::MultiFab>& rho,
int lev,
221 bool local =
false,
bool reset =
false,
222 bool apply_boundary_and_scale_volume =
false,
225 std::unique_ptr<amrex::MultiFab>
GetChargeDensity(
int lev,
bool local =
false);
253 amrex::Real relative_time,
323 int uniqueparticles, amrex::Long
id=-1);
384 int DoQED()
const {
return false; }
392 template<PhysicalSpecies PhysSpec>
416 virtual std::vector<std::
string>
getUserIntAttribs ()
const {
return std::vector<std::string>{}; }
PhysicalSpecies
Definition: SpeciesPhysicalProperties.H:16
DtType
Definition: WarpXDtType.H:11
PushType
Definition: WarpXPushType.H:12
Definition: BreitWheelerEngineWrapper.H:294
Definition: NamedComponentParticleContainer.H:64
Definition: PlasmaInjector.H:42
Definition: QuantumSyncEngineWrapper.H:273
Definition: WarpXParticleContainer.H:53
WarpXParIter(ContainerType &pc, int level)
Definition: WarpXParticleContainer.cpp:77
std::array< RealVector, PIdx::nattribs > & GetAttribs()
Definition: WarpXParticleContainer.H:66
const RealVector & GetAttribs(int comp) const
Definition: WarpXParticleContainer.H:71
IntVector & GetiAttribs(int comp)
Definition: WarpXParticleContainer.H:81
RealVector & GetAttribs(int comp)
Definition: WarpXParticleContainer.H:76
const std::array< RealVector, PIdx::nattribs > & GetAttribs() const
Definition: WarpXParticleContainer.H:61
Definition: WarpXParticleContainer.H:111
amrex::Real self_fields_required_precision
Definition: WarpXParticleContainer.H:347
int do_continuous_injection
Definition: WarpXParticleContainer.H:454
virtual std::vector< std::string > getUserIntAttribs() const
Definition: WarpXParticleContainer.H:416
~WarpXParticleContainer() override=default
bool AmIA() const noexcept
Definition: WarpXParticleContainer.H:393
virtual void DefaultInitializeRuntimeAttributes(typename ContainerLike< amrex::PinnedArenaAllocator >::ParticleTileType &pinned_tile, int n_external_attr_real, int n_external_attr_int)=0
Virtual method to initialize runtime attributes. Must be overriden by each derived class.
amrex::Vector< amrex::ParticleReal > m_B_external_particle
Definition: WarpXParticleContainer.H:353
bool m_gather_from_main_grid
instead of gathering fields from the finest patch level, gather from the coarsest
Definition: WarpXParticleContainer.H:445
void AllocData()
Definition: WarpXParticleContainer.cpp:152
virtual PlasmaInjector * GetPlasmaInjector(const int)
Definition: WarpXParticleContainer.H:141
void defineAllParticleTiles() noexcept
Definition: WarpXParticleContainer.cpp:1518
virtual void PostRestart()=0
void particlePostLocate(ParticleType &p, const amrex::ParticleLocData &pld, int lev) override
Definition: WarpXParticleContainer.cpp:1538
virtual void ReadHeader(std::istream &is)=0
int self_fields_max_iters
Definition: WarpXParticleContainer.H:349
amrex::Real m_current_injection_position
Current injection position.
Definition: WarpXParticleContainer.H:357
int species_id
Definition: WarpXParticleContainer.H:432
std::string m_qed_breit_wheeler_ele_product_name
Definition: WarpXParticleContainer.H:484
virtual void WriteHeader(std::ostream &os) const =0
amrex::Gpu::DeviceVector< amrex::Real > adk_exp_prefactor
Definition: WarpXParticleContainer.H:465
int do_adk_correction
Definition: WarpXParticleContainer.H:457
amrex::Gpu::DeviceVector< amrex::Real > adk_power
Definition: WarpXParticleContainer.H:463
PhysicalSpecies physical_species
Definition: WarpXParticleContainer.H:436
bool do_not_push
Definition: WarpXParticleContainer.H:447
virtual void ContinuousFluxInjection(amrex::Real, amrex::Real)
Definition: WarpXParticleContainer.H:274
std::string getSpeciesTypeName() const
This function returns a string containing the name of the species type.
Definition: WarpXParticleContainer.H:398
int m_qed_quantum_sync_phot_product
Definition: WarpXParticleContainer.H:487
amrex::ParticleReal maxParticleVelocity(bool local=false)
Definition: WarpXParticleContainer.cpp:1424
virtual void InitIonizationModule()
Definition: WarpXParticleContainer.H:135
virtual void InitData()=0
amrex::Gpu::DeviceVector< amrex::Real > adk_prefactor
Definition: WarpXParticleContainer.H:464
void SetDoBackTransformedParticles(const bool do_back_transformed_particles)
Definition: WarpXParticleContainer.H:366
virtual void Evolve(int lev, const amrex::MultiFab &Ex, const amrex::MultiFab &Ey, const amrex::MultiFab &Ez, const amrex::MultiFab &Bx, const amrex::MultiFab &By, const amrex::MultiFab &Bz, amrex::MultiFab &jx, amrex::MultiFab &jy, amrex::MultiFab &jz, amrex::MultiFab *cjx, amrex::MultiFab *cjy, amrex::MultiFab *cjz, amrex::MultiFab *rho, amrex::MultiFab *crho, const amrex::MultiFab *cEx, const amrex::MultiFab *cEy, const amrex::MultiFab *cEz, const amrex::MultiFab *cBx, const amrex::MultiFab *cBy, const amrex::MultiFab *cBz, amrex::Real t, amrex::Real dt, DtType a_dt_type=DtType::Full, bool skip_deposition=false, PushType push_type=PushType::Explicit)=0
amrex::ParticleReal sumParticleCharge(bool local=false)
Definition: WarpXParticleContainer.cpp:1333
int ionization_initial_level
Definition: WarpXParticleContainer.H:461
amrex::Real self_fields_absolute_tolerance
Definition: WarpXParticleContainer.H:348
amrex::Vector< amrex::FArrayBox > local_jx
Definition: WarpXParticleContainer.H:492
virtual void set_breit_wheeler_engine_ptr(const std::shared_ptr< BreitWheelerEngine > &)
Definition: WarpXParticleContainer.H:479
amrex::ParticleReal sumParticleWeight(bool local=false)
Definition: WarpXParticleContainer.cpp:1305
virtual void UpdateAntennaPosition(const amrex::Real)
Update antenna position for continuous injection of lasers in a boosted frame. Empty function for con...
Definition: WarpXParticleContainer.H:269
amrex::ParticleReal mass
Definition: WarpXParticleContainer.H:435
bool doContinuousInjection() const
Definition: WarpXParticleContainer.H:271
amrex::Vector< amrex::FArrayBox > local_jy
Definition: WarpXParticleContainer.H:493
std::unique_ptr< amrex::MultiFab > GetChargeDensity(int lev, bool local=false)
Definition: WarpXParticleContainer.cpp:1280
static void ReadParameters()
Definition: WarpXParticleContainer.cpp:140
int getIonizationInitialLevel() const noexcept
Definition: WarpXParticleContainer.H:504
std::array< amrex::Gpu::DeviceVector< amrex::ParticleReal >, TmpIdx::nattribs > TmpParticleTile
Definition: WarpXParticleContainer.H:499
amrex::Gpu::DeviceVector< amrex::Real > adk_correction_factors
Definition: WarpXParticleContainer.H:467
int ion_atomic_number
Definition: WarpXParticleContainer.H:460
bool m_do_back_transformed_particles
Definition: WarpXParticleContainer.H:473
amrex::Vector< amrex::FArrayBox > local_jz
Definition: WarpXParticleContainer.H:494
amrex::Gpu::DeviceVector< amrex::Real > ionization_energies
Definition: WarpXParticleContainer.H:462
amrex::ParticleReal getCharge() const
Definition: WarpXParticleContainer.H:371
TmpParticles tmp_particle_data
Definition: WarpXParticleContainer.H:507
virtual amrex::Vector< amrex::Parser * > getUserRealAttribParser() const
Definition: WarpXParticleContainer.H:422
void ApplyBoundaryConditions()
Apply particle BC.
Definition: WarpXParticleContainer.cpp:1560
virtual bool has_breit_wheeler() const
Definition: WarpXParticleContainer.H:380
virtual amrex::Vector< amrex::Parser * > getUserIntAttribParser() const
Definition: WarpXParticleContainer.H:420
virtual void PushP(int lev, amrex::Real dt, const amrex::MultiFab &Ex, const amrex::MultiFab &Ey, const amrex::MultiFab &Ez, const amrex::MultiFab &Bx, const amrex::MultiFab &By, const amrex::MultiFab &Bz)=0
std::string m_qed_breit_wheeler_pos_product_name
Definition: WarpXParticleContainer.H:486
std::string m_qed_quantum_sync_phot_product_name
Definition: WarpXParticleContainer.H:488
virtual void ContinuousInjection(const amrex::RealBox &)
Definition: WarpXParticleContainer.H:263
WarpXParticleContainer & operator=(const WarpXParticleContainer &)=delete
ParticleBoundaries m_boundary_conditions
Definition: WarpXParticleContainer.H:439
int m_qed_breit_wheeler_pos_product
Definition: WarpXParticleContainer.H:485
int ionization_product
Definition: WarpXParticleContainer.H:458
virtual BreitWheelerEngine * get_breit_wheeler_engine_ptr() const
Definition: WarpXParticleContainer.H:425
int m_qed_breit_wheeler_ele_product
Definition: WarpXParticleContainer.H:483
bool do_splitting
Definition: WarpXParticleContainer.H:344
virtual void set_quantum_sync_engine_ptr(const std::shared_ptr< QuantumSynchrotronEngine > &)
Definition: WarpXParticleContainer.H:481
std::array< amrex::ParticleReal, 3 > meanParticleVelocity(bool local=false)
Definition: WarpXParticleContainer.cpp:1338
WarpXParticleContainer & operator=(WarpXParticleContainer &&)=default
void DepositCurrent(amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > &J, amrex::Real dt, amrex::Real relative_time)
Deposit current density.
Definition: WarpXParticleContainer.cpp:821
bool initialize_self_fields
Definition: WarpXParticleContainer.H:346
int self_fields_verbosity
Definition: WarpXParticleContainer.H:350
virtual std::vector< std::string > getUserRealAttribs() const
Definition: WarpXParticleContainer.H:418
void DepositCharge(amrex::Vector< std::unique_ptr< amrex::MultiFab > > &rho, bool local=false, bool reset=false, bool apply_boundary_and_scale_volume=false, bool interpolate_across_levels=true, int icomp=0)
Deposit charge density.
Definition: WarpXParticleContainer.cpp:1171
virtual bool has_quantum_sync() const
Definition: WarpXParticleContainer.H:379
WarpXParticleContainer(amrex::AmrCore *amr_core, int ispecies)
Definition: WarpXParticleContainer.cpp:89
std::string physical_element
Definition: WarpXParticleContainer.H:468
virtual QuantumSynchrotronEngine * get_quantum_sync_engine_ptr() const
Definition: WarpXParticleContainer.H:426
void deleteInvalidParticles()
Definition: WarpXParticleContainer.cpp:310
int split_type
Definition: WarpXParticleContainer.H:360
void PushX(amrex::Real dt)
Definition: WarpXParticleContainer.cpp:1451
WarpXParticleContainer(WarpXParticleContainer &&)=default
void AddNParticles(int lev, long n, amrex::Vector< amrex::ParticleReal > const &x, amrex::Vector< amrex::ParticleReal > const &y, amrex::Vector< amrex::ParticleReal > const &z, amrex::Vector< amrex::ParticleReal > const &ux, amrex::Vector< amrex::ParticleReal > const &uy, amrex::Vector< amrex::ParticleReal > const &uz, int nattr_real, amrex::Vector< amrex::Vector< amrex::ParticleReal >> const &attr_real, int nattr_int, amrex::Vector< amrex::Vector< int >> const &attr_int, int uniqueparticles, amrex::Long id=-1)
Adds n particles to the simulation.
Definition: WarpXParticleContainer.cpp:161
TmpParticles getTmpParticleData() const noexcept
Definition: WarpXParticleContainer.H:502
friend MultiParticleContainer
Definition: WarpXParticleContainer.H:113
amrex::Vector< amrex::ParticleReal > m_E_external_particle
Definition: WarpXParticleContainer.H:354
std::string ionization_product_name
Definition: WarpXParticleContainer.H:459
int getSpeciesId() const
Definition: WarpXParticleContainer.H:276
virtual void resample(const int, bool)
Virtual method to resample the species. Overriden by PhysicalParticleContainer only....
Definition: WarpXParticleContainer.H:406
int DoFieldIonization() const
Definition: WarpXParticleContainer.H:375
int do_not_deposit
Definition: WarpXParticleContainer.H:345
void setDoNotPush(bool flag)
Definition: WarpXParticleContainer.H:429
WarpXParticleContainer(const WarpXParticleContainer &)=delete
amrex::ParticleReal getMass() const
Definition: WarpXParticleContainer.H:373
int DoQED() const
Definition: WarpXParticleContainer.H:382
int do_resampling
Definition: WarpXParticleContainer.H:470
int do_not_gather
Definition: WarpXParticleContainer.H:448
static void BackwardCompatibility()
bool m_deposit_on_main_grid
instead of depositing (current, charge) on the finest patch level, deposit to the coarsest grid
Definition: WarpXParticleContainer.H:442
amrex::Vector< amrex::FArrayBox > local_rho
Definition: WarpXParticleContainer.H:491
std::pair< int, int > PairIndex
Definition: WarpXParticleContainer.H:497
int do_field_ionization
Definition: WarpXParticleContainer.H:456
amrex::ParticleReal charge
Definition: WarpXParticleContainer.H:434
SoARef GetStructOfArrays() const
typename SoA::RealVector RealVector
typename SoA::IntVector IntVector
typename SoA::RealVector RealVector
T_ParticleType ParticleType
std::string get_name(const PhysicalSpecies &ps)
Returns the name associated to a PhysicalSpecies.
Definition: SpeciesPhysicalProperties.cpp:295
float dt
Definition: stencil.py:442
Definition: ParticleBoundaries.H:19
@ nattribs
Definition: WarpXParticleContainer_fwd.H:39