WarpX
Public Member Functions | Private Attributes | List of all members
RigidInjectedParticleContainer Class Reference

#include <RigidInjectedParticleContainer.H>

Inheritance diagram for RigidInjectedParticleContainer:
PhysicalParticleContainer WarpXParticleContainer NamedComponentParticleContainer< amrex::DefaultAllocator > amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class > amrex::ParticleContainerBase

Public Member Functions

 RigidInjectedParticleContainer (amrex::AmrCore *amr_core, int ispecies, const std::string &name)
 
 ~RigidInjectedParticleContainer () override=default
 
 RigidInjectedParticleContainer (RigidInjectedParticleContainer const &)=delete
 
RigidInjectedParticleContaineroperator= (RigidInjectedParticleContainer const &)=delete
 
 RigidInjectedParticleContainer (RigidInjectedParticleContainer &&)=default
 
RigidInjectedParticleContaineroperator= (RigidInjectedParticleContainer &&)=default
 
void InitData () override
 
virtual void RemapParticles ()
 
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) override
 Evolve is the central function PhysicalParticleContainer that advances plasma particles for a time dt (typically one timestep). More...
 
void PushPX (WarpXParIter &pti, amrex::FArrayBox const *exfab, amrex::FArrayBox const *eyfab, amrex::FArrayBox const *ezfab, amrex::FArrayBox const *bxfab, amrex::FArrayBox const *byfab, amrex::FArrayBox const *bzfab, amrex::IntVect ngEB, int, long offset, long np_to_push, int lev, int gather_lev, amrex::Real dt, ScaleFields scaleFields, DtType a_dt_type=DtType::Full) override
 
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) override
 
void ReadHeader (std::istream &is) override
 
void WriteHeader (std::ostream &os) const override
 
- Public Member Functions inherited from PhysicalParticleContainer
 PhysicalParticleContainer (amrex::AmrCore *amr_core, int ispecies, const std::string &name)
 
 PhysicalParticleContainer (amrex::AmrCore *amr_core)
 
void BackwardCompatibility ()
 
 ~PhysicalParticleContainer () override=default
 
 PhysicalParticleContainer (PhysicalParticleContainer const &)=delete
 
PhysicalParticleContaineroperator= (PhysicalParticleContainer const &)=delete
 
 PhysicalParticleContainer (PhysicalParticleContainer &&)=default
 
PhysicalParticleContaineroperator= (PhysicalParticleContainer &&)=default
 
void InitIonizationModule () override
 
PlasmaInjectorGetPlasmaInjector (int i) override
 
void ImplicitPushXP (WarpXParIter &pti, amrex::FArrayBox const *exfab, amrex::FArrayBox const *eyfab, amrex::FArrayBox const *ezfab, amrex::FArrayBox const *bxfab, amrex::FArrayBox const *byfab, amrex::FArrayBox const *bzfab, amrex::IntVect ngEB, int, long offset, long np_to_push, int lev, int gather_lev, amrex::Real dt, ScaleFields scaleFields, DtType a_dt_type=DtType::Full)
 
void PartitionParticlesInBuffers (long &nfine_current, long &nfine_gather, long np, WarpXParIter &pti, int lev, amrex::iMultiFab const *current_masks, amrex::iMultiFab const *gather_masks)
 
void PostRestart () final
 
void SplitParticles (int lev)
 
IonizationFilterFunc getIonizationFunc (const WarpXParIter &pti, int lev, amrex::IntVect ngEB, const amrex::FArrayBox &Ex, const amrex::FArrayBox &Ey, const amrex::FArrayBox &Ez, const amrex::FArrayBox &Bx, const amrex::FArrayBox &By, const amrex::FArrayBox &Bz)
 
virtual void AddParticles (int lev)
 
void AddPlasma (PlasmaInjector const &plasma_injector, int lev, amrex::RealBox part_realbox=amrex::RealBox())
 
void AddPlasmaFlux (PlasmaInjector const &plasma_injector, amrex::Real dt)
 
void MapParticletoBoostedFrame (amrex::ParticleReal &x, amrex::ParticleReal &y, amrex::ParticleReal &z, amrex::ParticleReal &ux, amrex::ParticleReal &uy, amrex::ParticleReal &uz, amrex::Real t_lab=0.) const
 
void AddGaussianBeam (PlasmaInjector const &plasma_injector)
 
void AddPlasmaFromFile (PlasmaInjector &plasma_injector, amrex::ParticleReal q_tot, amrex::ParticleReal z_shift)
 
void CheckAndAddParticle (amrex::ParticleReal x, amrex::ParticleReal y, amrex::ParticleReal z, amrex::ParticleReal ux, amrex::ParticleReal uy, amrex::ParticleReal uz, amrex::ParticleReal weight, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_x, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_y, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_z, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_ux, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_uy, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_uz, amrex::Gpu::HostVector< amrex::ParticleReal > &particle_w, amrex::Real t_lab=0.) const
 
void DefaultInitializeRuntimeAttributes (typename ContainerLike< amrex::PinnedArenaAllocator >::ParticleTileType &pinned_tile, int n_external_attr_real, int n_external_attr_int) final
 Default initialize runtime attributes in a tile. This routine does not initialize the first n_external_attr_real real attributes and the first n_external_attr_int integer attributes, which have been in principle externally set elsewhere. More...
 
void applyNCIFilter (int lev, const amrex::Box &box, amrex::Elixir &exeli, amrex::Elixir &eyeli, amrex::Elixir &ezeli, amrex::Elixir &bxeli, amrex::Elixir &byeli, amrex::Elixir &bzeli, amrex::FArrayBox &filtered_Ex, amrex::FArrayBox &filtered_Ey, amrex::FArrayBox &filtered_Ez, amrex::FArrayBox &filtered_Bx, amrex::FArrayBox &filtered_By, amrex::FArrayBox &filtered_Bz, const amrex::FArrayBox &Ex, const amrex::FArrayBox &Ey, const amrex::FArrayBox &Ez, const amrex::FArrayBox &Bx, const amrex::FArrayBox &By, const amrex::FArrayBox &Bz, amrex::FArrayBox const *&ex_ptr, amrex::FArrayBox const *&ey_ptr, amrex::FArrayBox const *&ez_ptr, amrex::FArrayBox const *&bx_ptr, amrex::FArrayBox const *&by_ptr, amrex::FArrayBox const *&bz_ptr)
 Apply NCI Godfrey filter to all components of E and B before gather. More...
 
void resample (int timestep, bool verbose=true) final
 This function determines if resampling should be done for the current species, and if so, performs the resampling. More...
 
bool has_quantum_sync () const override
 
bool has_breit_wheeler () const override
 
void set_breit_wheeler_engine_ptr (const std::shared_ptr< BreitWheelerEngine > &ptr) override
 
void set_quantum_sync_engine_ptr (const std::shared_ptr< QuantumSynchrotronEngine > &ptr) override
 
BreitWheelerEngineget_breit_wheeler_engine_ptr () const override
 
QuantumSynchrotronEngineget_quantum_sync_engine_ptr () const override
 
PhotonEmissionFilterFunc getPhotonEmissionFilterFunc ()
 
PairGenerationFilterFunc getPairGenerationFilterFunc ()
 
std::vector< std::string > getUserIntAttribs () const override
 
std::vector< std::string > getUserRealAttribs () const override
 
amrex::Vector< amrex::Parser * > getUserIntAttribParser () const override
 
amrex::Vector< amrex::Parser * > getUserRealAttribParser () const override
 
- Public Member Functions inherited from WarpXParticleContainer
 WarpXParticleContainer (amrex::AmrCore *amr_core, int ispecies)
 
 ~WarpXParticleContainer () override=default
 
 WarpXParticleContainer (const WarpXParticleContainer &)=delete
 
WarpXParticleContaineroperator= (const WarpXParticleContainer &)=delete
 
 WarpXParticleContainer (WarpXParticleContainer &&)=default
 
WarpXParticleContaineroperator= (WarpXParticleContainer &&)=default
 
void AllocData ()
 
void PushX (amrex::Real dt)
 
void PushX (int lev, amrex::Real dt)
 
void DepositCurrent (amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > &J, amrex::Real dt, amrex::Real relative_time)
 Deposit current density. More...
 
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. More...
 
void DepositCharge (std::unique_ptr< amrex::MultiFab > &rho, int lev, bool local=false, bool reset=false, bool apply_boundary_and_scale_volume=false, int icomp=0)
 
std::unique_ptr< amrex::MultiFabGetChargeDensity (int lev, bool local=false)
 
virtual void DepositCharge (WarpXParIter &pti, RealVector const &wp, const int *ion_lev, amrex::MultiFab *rho, int icomp, long offset, long np_to_deposit, int thread_num, int lev, int depos_lev)
 
virtual void DepositCurrent (WarpXParIter &pti, RealVector const &wp, RealVector const &uxp, RealVector const &uyp, RealVector const &uzp, int const *ion_lev, amrex::MultiFab *jx, amrex::MultiFab *jy, amrex::MultiFab *jz, long offset, long np_to_deposit, int thread_num, int lev, int depos_lev, amrex::Real dt, amrex::Real relative_time, PushType push_type)
 
virtual void UpdateAntennaPosition (const amrex::Real)
 Update antenna position for continuous injection of lasers in a boosted frame. Empty function for containers other than lasers. More...
 
bool doContinuousInjection () const
 
int getSpeciesId () const
 
amrex::ParticleReal sumParticleCharge (bool local=false)
 
amrex::ParticleReal sumParticleWeight (bool local=false)
 
std::array< amrex::ParticleReal, 3 > meanParticleVelocity (bool local=false)
 
amrex::ParticleReal maxParticleVelocity (bool local=false)
 
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. More...
 
void deleteInvalidParticles ()
 
void ApplyBoundaryConditions ()
 Apply particle BC. More...
 
void SetDoBackTransformedParticles (const bool do_back_transformed_particles)
 
amrex::ParticleReal getCharge () const
 
amrex::ParticleReal getMass () const
 
int DoFieldIonization () const
 
int DoQED () const
 
template<PhysicalSpecies PhysSpec>
bool AmIA () const noexcept
 
std::string getSpeciesTypeName () const
 This function returns a string containing the name of the species type. More...
 
void defineAllParticleTiles () noexcept
 
void setDoNotPush (bool flag)
 
TmpParticles getTmpParticleData () const noexcept
 
int getIonizationInitialLevel () const noexcept
 
- Public Member Functions inherited from NamedComponentParticleContainer< amrex::DefaultAllocator >
 NamedComponentParticleContainer ()
 
 NamedComponentParticleContainer (amrex::AmrParGDB *amr_pgdb)
 
 NamedComponentParticleContainer (amrex::ParticleContainerPureSoA< PIdx::nattribs, 0, amrex::DefaultAllocator > &&pc, std::map< std::string, int > p_comps, std::map< std::string, int > p_icomps, std::map< std::string, int > p_rcomps, std::map< std::string, int > p_ricomps)
 
 NamedComponentParticleContainer (const NamedComponentParticleContainer &)=delete
 
 NamedComponentParticleContainer (NamedComponentParticleContainer &&) noexcept=default
 
 ~NamedComponentParticleContainer () override=default
 
NamedComponentParticleContaineroperator= (const NamedComponentParticleContainer &)=delete
 
NamedComponentParticleContaineroperator= (NamedComponentParticleContainer &&) noexcept=default
 
NamedComponentParticleContainer< NewAllocator > make_alike () const
 
void AddRealComp (const std::string &name, bool comm=true)
 
void AddIntComp (const std::string &name, bool comm=true)
 
void defineAllParticleTiles () noexcept
 
std::map< std::string, intgetParticleComps () const noexcept
 
std::map< std::string, intgetParticleiComps () const noexcept
 
std::map< std::string, intgetParticleRuntimeComps () const noexcept
 
std::map< std::string, intgetParticleRuntimeiComps () const noexcept
 
- Public Member Functions inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
 ParticleContainer_impl ()
 
 ParticleContainer_impl (ParGDBBase *gdb)
 
 ParticleContainer_impl (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
 ParticleContainer_impl (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
 ParticleContainer_impl (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
 ~ParticleContainer_impl () override=default
 
 ParticleContainer_impl (const ParticleContainer_impl &)=delete
 
ParticleContainer_imploperator= (const ParticleContainer_impl &)=delete
 
 ParticleContainer_impl (ParticleContainer_impl &&) noexcept=default
 
ParticleContainer_imploperator= (ParticleContainer_impl &&) noexcept=default
 
void Define (ParGDBBase *gdb)
 
void Define (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
int numLocalTilesAtLevel (int lev) const
 
void reserveData () override
 
void resizeData () override
 
void InitFromAsciiFile (const std::string &file, int extradata, const IntVect *Nrep=nullptr)
 
void InitFromBinaryFile (const std::string &file, int extradata)
 
void InitFromBinaryMetaFile (const std::string &file, int extradata)
 
void InitRandom (Long icount, ULong iseed, const ParticleInitData &pdata, bool serialize=false, RealBox bx=RealBox())
 
void InitRandomPerBox (Long icount, ULong iseed, const ParticleInitData &pdata)
 
void InitOnePerCell (Real x_off, Real y_off, Real z_off, const ParticleInitData &pdata)
 
void InitNRandomPerCell (int n_per_cell, const ParticleInitData &pdata)
 
void Increment (MultiFab &mf, int level)
 
Long IncrementWithTotal (MultiFab &mf, int level, bool local=false)
 
void Redistribute (int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
 
void ReorderParticles (int lev, const MFIter &mfi, const index_type *permutations)
 
void SortParticlesForDeposition (IntVect idx_type)
 
void SortParticlesByCell ()
 
void SortParticlesByBin (IntVect bin_size)
 
bool OK (int lev_min=0, int lev_max=-1, int nGrow=0) const
 
std::array< Long, 3 > ByteSpread () const
 
std::array< Long, 3 > PrintCapacity () const
 
void ShrinkToFit ()
 
Long NumberOfParticlesAtLevel (int level, bool only_valid=true, bool only_local=false) const
 
Vector< Long > NumberOfParticlesInGrid (int level, bool only_valid=true, bool only_local=false) const
 
Long TotalNumberOfParticles (bool only_valid=true, bool only_local=false) const
 
void RemoveParticlesAtLevel (int level)
 
void RemoveParticlesNotAtFinestLevel ()
 
void CreateVirtualParticles (int level, AoS &virts) const
 
void CreateGhostParticles (int level, int ngrow, AoS &ghosts) const
 
void AddParticlesAtLevel (AoS &particles, int level, int nGrow=0)
 
void CreateVirtualParticles (int level, ParticleTileType &virts) const
 
void CreateGhostParticles (int level, int ngrow, ParticleTileType &ghosts) const
 
void AddParticlesAtLevel (ParticleTileType &particles, int level, int nGrow=0)
 
void clearParticles ()
 
void copyParticles (const PCType &other, bool local=false)
 
void addParticles (const PCType &other, bool local=false)
 
void copyParticles (const PCType &other, F &&f, bool local=false)
 
void addParticles (const PCType &other, F const &f, bool local=false)
 
void WriteParticleRealData (void *data, size_t size, std::ostream &os) const
 
void ReadParticleRealData (void *data, size_t size, std::istream &is)
 
void Checkpoint (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names=Vector< std::string >(), const Vector< std::string > &int_comp_names=Vector< std::string >()) const
 
void Checkpoint (const std::string &dir, const std::string &name, bool is_checkpoint, const Vector< std::string > &real_comp_names=Vector< std::string >(), const Vector< std::string > &int_comp_names=Vector< std::string >()) const
 
void WriteBinaryParticleData (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F &&f, bool is_checkpoint=false) const
 
void CheckpointPre ()
 
void CheckpointPost ()
 
void Restart (const std::string &dir, const std::string &file)
 
void Restart (const std::string &dir, const std::string &file, bool is_checkpoint)
 
void WritePlotFile (const std::string &dir, const std::string &name) const
 
void WritePlotFile (const std::string &dir, const std::string &name, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F &&f) const
 
void WritePlotFilePre ()
 
void WritePlotFilePost ()
 
void WriteAsciiFile (const std::string &file)
 
const Vector< ParticleLevel > & GetParticles () const
 
Vector< ParticleLevel > & GetParticles ()
 
const ParticleLevelGetParticles (int lev) const
 
ParticleLevelGetParticles (int lev)
 
const ParticleTileTypeParticlesAt (int lev, int grid, int tile) const
 
ParticleTileTypeParticlesAt (int lev, int grid, int tile)
 
const ParticleTileTypeParticlesAt (int lev, const Iterator &iter) const
 
ParticleTileTypeParticlesAt (int lev, const Iterator &iter)
 
ParticleTileTypeDefineAndReturnParticleTile (int lev, int grid, int tile)
 
ParticleTileTypeDefineAndReturnParticleTile (int lev, const Iterator &iter)
 
void AssignDensity (int rho_index, Vector< std::unique_ptr< MultiFab > > &mf_to_be_filled, int lev_min, int ncomp, int finest_level, int ngrow=2) const
 
void AssignCellDensitySingleLevel (int rho_index, MultiFab &mf, int level, int ncomp=1, int particle_lvl_offset=0) const
 
IntVect Index (const P &p, int lev) const
 
ParticleLocData Reset (ParticleType &prt, bool update, bool verbose=true, ParticleLocData pld=ParticleLocData()) const
 
bool PeriodicShift (P &p) const
 
void SetLevelDirectoriesCreated (bool tf)
 
bool GetLevelDirectoriesCreated () const
 
void SetUsePrePost (bool tf) const
 
bool GetUsePrePost () const
 
int GetMaxNextIDPrePost () const
 
Long GetNParticlesPrePost () const
 
void SetUseUnlink (bool tf) const
 
bool GetUseUnlink () const
 
void RedistributeCPU (int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
 
void RedistributeGPU (int lev_min=0, int lev_max=-1, int nGrow=0, int local=0, bool remove_negative=true)
 
Long superParticleSize () const
 
void AddRealComp (T communicate=true)
 
void AddIntComp (T communicate=true)
 
int NumRuntimeRealComps () const
 
int NumRuntimeIntComps () const
 
int NumRealComps () const
 
int NumIntComps () const
 
void ResizeRuntimeRealComp (int new_size, bool communicate)
 
void ResizeRuntimeIntComp (int new_size, bool communicate)
 
ContainerLike< NewAllocator > make_alike () const
 
void WriteParticles (int level, std::ofstream &ofs, int fnum, Vector< int > &which, Vector< int > &count, Vector< Long > &where, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::map< std::pair< int, int >, IntVector >> &particle_io_flags, bool is_checkpoint) const
 
IntVect Index (const P &p, int lev) const
 
bool Where (const P &p, ParticleLocData &pld, int lev_min, int lev_max, int nGrow, int local_grid) const
 
bool EnforcePeriodicWhere (P &p, ParticleLocData &pld, int lev_min, int lev_max, int local_grid) const
 
bool PeriodicShift (P &p) const
 
void locateParticle (P &p, ParticleLocData &pld, int lev_min, int lev_max, int nGrow, int local_grid) const
 
void copyParticles (const PCType &other, bool local)
 
void addParticles (const PCType &other, bool local)
 
void copyParticles (const PCType &other, F &&f, bool local)
 
void addParticles (const PCType &other, F const &f, bool local)
 
void ReorderParticles (int lev, const MFIter &mfi, const index_type *permutations)
 
void WritePlotFile (const std::string &dir, const std::string &name, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< std::string > &real_comp_names, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, F &&f) const
 
void WritePlotFile (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F &&f) const
 
void WriteBinaryParticleData (const std::string &dir, const std::string &name, const Vector< int > &write_real_comp, const Vector< int > &write_int_comp, const Vector< std::string > &real_comp_names, const Vector< std::string > &int_comp_names, F &&f, bool is_checkpoint) const
 
void ReadParticles (int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)
 
- Public Member Functions inherited from amrex::ParticleContainerBase
 ParticleContainerBase ()=default
 
 ParticleContainerBase (ParGDBBase *gdb)
 
 ParticleContainerBase (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
 ParticleContainerBase (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
 ParticleContainerBase (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
virtual ~ParticleContainerBase ()=default
 
 ParticleContainerBase (const ParticleContainerBase &)=delete
 
ParticleContainerBaseoperator= (const ParticleContainerBase &)=delete
 
 ParticleContainerBase (ParticleContainerBase &&)=default
 
ParticleContainerBaseoperator= (ParticleContainerBase &&)=default
 
void Define (ParGDBBase *gdb)
 
void Define (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
void Define (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
bool isDefined () const
 
void RedefineDummyMF (int lev)
 
MFIter MakeMFIter (int lev, const MFItInfo &info) const
 
MFIter MakeMFIter (int lev) const
 
MFIter MakeMFIter (int lev, bool tile) const
 
void SetParGDB (const Geometry &geom, const DistributionMapping &dmap, const BoxArray &ba)
 
void SetParGDB (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< IntVect > &rr)
 
void SetParGDB (const Vector< Geometry > &geom, const Vector< DistributionMapping > &dmap, const Vector< BoxArray > &ba, const Vector< int > &rr)
 
void SetParticleBoxArray (int lev, BoxArray new_ba)
 
void SetParticleDistributionMap (int lev, DistributionMapping new_dmap)
 
void SetParticleGeometry (int lev, Geometry new_geom)
 
const BoxArrayParticleBoxArray (int lev) const
 
const DistributionMappingParticleDistributionMap (int lev) const
 
const GeometryGeom (int lev) const
 
const GeometryParticleGeom (int lev) const
 
int finestLevel () const
 
int maxLevel () const
 
int numLevels () const
 
const ParGDBBaseGetParGDB () const
 
ParGDBBaseGetParGDB ()
 
int Verbose () const
 
void SetVerbose (int verbose)
 
const ParticleBufferMapBufferMap () const
 
Vector< intNeighborProcs (int ngrow) const
 
bool OnSameGrids (int level, const MF &mf) const
 

Private Attributes

amrex::ParticleReal zinject_plane = 0.
 
bool rigid_advance = true
 
amrex::ParticleReal vzbeam_ave_boosted
 
amrex::Vector< amrex::ParticleReal > zinject_plane_levels
 
amrex::ParticleReal zinject_plane_lev
 
amrex::ParticleReal zinject_plane_lev_previous
 
bool done_injecting_lev
 

Additional Inherited Members

- Public Types inherited from WarpXParticleContainer
using DiagnosticParticleData = amrex::StructOfArrays< DiagIdx::nattribs, 0 >
 
using DiagnosticParticles = amrex::Vector< std::map< std::pair< int, int >, DiagnosticParticleData > >
 
using PairIndex = std::pair< int, int >
 
using TmpParticleTile = std::array< amrex::Gpu::DeviceVector< amrex::ParticleReal >, TmpIdx::nattribs >
 
using TmpParticles = amrex::Vector< std::map< PairIndex, TmpParticleTile > >
 
- Public Types inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
typedef T_ParticleType ParticleType
 
typedef typename ParticleType::ConstType ConstParticleType
 
typedef T_CellAssignor CellAssignor
 
typedef Allocator< T > AllocatorType
 
typedef Particle< NStructReal+NArrayReal, NStructInt+NArrayIntSuperParticleType
 
typedef typename Particle< NStructReal, NStructInt >::RealType RealType
 
typedef ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignorParticleContainerType
 
typedef ParticleTile< ParticleType, NArrayReal, NArrayInt, Allocator > ParticleTileType
 
typedef ParticleInitType< NStructReal, NStructInt, NArrayReal, NArrayIntParticleInitData
 
typedef std::map< std::pair< int, int >, ParticleTileTypeParticleLevel
 
typedef typename ParticleTileType::AoS AoS
 
typedef typename ParticleTileType::SoA SoA
 
typedef typename SoA::RealVector RealVector
 
typedef typename SoA::IntVector IntVector
 
typedef typename AoS::ParticleVector ParticleVector
 
typedef Gpu::DeviceVector< char > CharVector
 
typedef ParIter_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignorParIterType
 
typedef ParConstIter_impl< ParticleType, NArrayReal, NArrayInt, Allocator, CellAssignorParConstIterType
 
typedef amrex::ParticleContainer_impl< ParticleType, NArrayReal, NArrayInt, NewAllocator > ContainerLike
 
- Static Public Member Functions inherited from WarpXParticleContainer
static void ReadParameters ()
 
static void BackwardCompatibility ()
 
- Static Public Member Functions inherited from amrex::ParticleContainerBase
static const std::string & CheckpointVersion ()
 
static const std::string & PlotfileVersion ()
 
static const std::string & DataPrefix ()
 
static int MaxReaders ()
 
static Long MaxParticlesPerRead ()
 
static const std::string & AggregationType ()
 
static int AggregationBuffer ()
 
- Public Attributes inherited from WarpXParticleContainer
friend MultiParticleContainer
 
bool do_splitting = false
 
int do_not_deposit = 0
 
bool initialize_self_fields = false
 
amrex::Real self_fields_required_precision = amrex::Real(1.e-11)
 
amrex::Real self_fields_absolute_tolerance = amrex::Real(0.0)
 
int self_fields_max_iters = 200
 
int self_fields_verbosity = 2
 
amrex::Vector< amrex::ParticleReal > m_B_external_particle
 
amrex::Vector< amrex::ParticleReal > m_E_external_particle
 
amrex::Real m_current_injection_position
 Current injection position. More...
 
int split_type = 0
 
- Public Attributes inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
RealDescriptor ParticleRealDescriptor
 
Vector< inth_redistribute_real_comp
 
Vector< inth_redistribute_int_comp
 
bool levelDirectoriesCreated
 
bool usePrePost
 
bool doUnlink
 
int maxnextidPrePost
 
int nOutFilesPrePost
 
Long nparticlesPrePost
 
Vector< Long > nParticlesAtLevelPrePost
 
Vector< Vector< int > > whichPrePost
 
Vector< Vector< int > > countPrePost
 
Vector< Vector< Long > > wherePrePost
 
std::string HdrFileNamePrePost
 
Vector< std::string > filePrefixPrePost
 
- Public Attributes inherited from amrex::ParticleContainerBase
AmrParticleLocator< DenseBins< Box > > m_particle_locator
 
- Static Public Attributes inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
static constexpr int NStructReal
 
static constexpr int NStructInt
 
static constexpr int NArrayReal
 
static constexpr int NArrayInt
 
- Static Public Attributes inherited from amrex::ParticleContainerBase
static AMREX_EXPORT bool do_tiling
 
static AMREX_EXPORT IntVect tile_size
 
static AMREX_EXPORT bool memEfficientSort
 
- Protected Member Functions inherited from PhysicalParticleContainer
void ContinuousInjection (const amrex::RealBox &injection_box) override
 
void ContinuousFluxInjection (amrex::Real t, amrex::Real dt) override
 
- Protected Member Functions inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
bool Where (const P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int nGrow=0, int local_grid=-1) const
 
bool EnforcePeriodicWhere (P &prt, ParticleLocData &pld, int lev_min=0, int lev_max=-1, int local_grid=-1) const
 
void ReadParticles (int cnt, int grd, int lev, std::ifstream &ifs, int finest_level_in_file, bool convert_ids)
 
void SetParticleSize ()
 
- Protected Member Functions inherited from amrex::ParticleContainerBase
void BuildRedistributeMask (int lev, int nghost=1) const
 
void defineBufferMap () const
 
- Protected Attributes inherited from PhysicalParticleContainer
std::string species_name
 
std::vector< std::unique_ptr< PlasmaInjector > > plasma_injectors
 
bool boost_adjust_transverse_positions = false
 
bool do_backward_propagation = false
 
bool m_rz_random_theta = true
 
bool impose_t_lab_from_file = false
 
Resampling m_resampler
 
bool do_classical_radiation_reaction = false
 
bool m_save_previous_position = false
 
bool m_do_qed_quantum_sync = false
 
bool m_do_qed_breit_wheeler = false
 
std::shared_ptr< QuantumSynchrotronEnginem_shr_p_qs_engine
 
std::shared_ptr< BreitWheelerEnginem_shr_p_bw_engine
 
std::vector< std::string > m_user_int_attribs
 
std::vector< std::string > m_user_real_attribs
 
amrex::Vector< std::unique_ptr< amrex::Parser > > m_user_int_attrib_parser
 
amrex::Vector< std::unique_ptr< amrex::Parser > > m_user_real_attrib_parser
 
- Protected Attributes inherited from WarpXParticleContainer
int species_id
 
amrex::ParticleReal charge
 
amrex::ParticleReal mass
 
PhysicalSpecies physical_species
 
ParticleBoundaries m_boundary_conditions
 
bool m_deposit_on_main_grid = false
 instead of depositing (current, charge) on the finest patch level, deposit to the coarsest grid More...
 
bool m_gather_from_main_grid = false
 instead of gathering fields from the finest patch level, gather from the coarsest More...
 
bool do_not_push = false
 
int do_not_gather = 0
 
int do_continuous_injection = 0
 
int do_field_ionization = 0
 
int do_adk_correction = 0
 
int ionization_product
 
std::string ionization_product_name
 
int ion_atomic_number
 
int ionization_initial_level = 0
 
amrex::Gpu::DeviceVector< amrex::Real > ionization_energies
 
amrex::Gpu::DeviceVector< amrex::Real > adk_power
 
amrex::Gpu::DeviceVector< amrex::Real > adk_prefactor
 
amrex::Gpu::DeviceVector< amrex::Real > adk_exp_prefactor
 
amrex::Gpu::DeviceVector< amrex::Real > adk_correction_factors
 
std::string physical_element
 
int do_resampling = 0
 
bool m_do_back_transformed_particles = false
 
int m_qed_breit_wheeler_ele_product
 
std::string m_qed_breit_wheeler_ele_product_name
 
int m_qed_breit_wheeler_pos_product
 
std::string m_qed_breit_wheeler_pos_product_name
 
int m_qed_quantum_sync_phot_product
 
std::string m_qed_quantum_sync_phot_product_name
 
amrex::Vector< amrex::FArrayBoxlocal_rho
 
amrex::Vector< amrex::FArrayBoxlocal_jx
 
amrex::Vector< amrex::FArrayBoxlocal_jy
 
amrex::Vector< amrex::FArrayBoxlocal_jz
 
TmpParticles tmp_particle_data
 
- Protected Attributes inherited from NamedComponentParticleContainer< amrex::DefaultAllocator >
std::map< std::string, intparticle_comps
 
std::map< std::string, intparticle_icomps
 
std::map< std::string, intparticle_runtime_comps
 
std::map< std::string, intparticle_runtime_icomps
 
- Protected Attributes inherited from amrex::ParticleContainer_impl< class, T_NArrayReal, T_NArrayInt, Allocator, class >
DenseBins< typename ParticleTileType::ParticleTileDataTypem_bins
 
- Protected Attributes inherited from amrex::ParticleContainerBase
int m_verbose
 
std::unique_ptr< ParGDBm_gdb_object
 
ParGDBBasem_gdb
 
Vector< std::unique_ptr< MultiFab > > m_dummy_mf
 
std::unique_ptr< iMultiFabredistribute_mask_ptr
 
int redistribute_mask_nghost
 
amrex::Vector< intneighbor_procs
 
ParticleBufferMap m_buffer_map
 

Detailed Description

When injecting a particle beam (typically for a plasma wakefield acceleration simulation), say propagating in the z direction, it can be necessary to make particles propagate in a straight line up to a given location z=z0. This is of particular importance when running in a boosted frame, where the beam may evolve due to its space charge fields before entering the plasma, causing the actual injected beam, and hence the whole simulation result, to depend on the Lorentz factor of the boost.

This feature is implemented in RigidInjectedParticleContainer: At each iteration, for each particle, if z<z0 the particle moves in a straight line, and if z>z0 the particle evolves as a regular PhysicalParticleContainer.

Note: This option is also useful to build self-consistent space charge fields for the particle beam.

RigidInjectedParticleContainer derives from PhysicalParticleContainer.

Constructor & Destructor Documentation

◆ RigidInjectedParticleContainer() [1/3]

RigidInjectedParticleContainer::RigidInjectedParticleContainer ( amrex::AmrCore amr_core,
int  ispecies,
const std::string &  name 
)

◆ ~RigidInjectedParticleContainer()

RigidInjectedParticleContainer::~RigidInjectedParticleContainer ( )
overridedefault

◆ RigidInjectedParticleContainer() [2/3]

RigidInjectedParticleContainer::RigidInjectedParticleContainer ( RigidInjectedParticleContainer const &  )
delete

◆ RigidInjectedParticleContainer() [3/3]

RigidInjectedParticleContainer::RigidInjectedParticleContainer ( RigidInjectedParticleContainer &&  )
default

Member Function Documentation

◆ Evolve()

void RigidInjectedParticleContainer::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 
)
overridevirtual

Evolve is the central function PhysicalParticleContainer that advances plasma particles for a time dt (typically one timestep).

Parameters
levlevel on which particles are living
ExMultiFab from which field Ex is gathered
EyMultiFab from which field Ey is gathered
EzMultiFab from which field Ez is gathered
BxMultiFab from which field Bx is gathered
ByMultiFab from which field By is gathered
BzMultiFab from which field Bz is gathered
jxMultiFab to which the particles' current jx is deposited
jyMultiFab to which the particles' current jy is deposited
jzMultiFab to which the particles' current jz is deposited
cjxSame as jx (coarser, from lev-1), when using deposition buffers
cjySame as jy (coarser, from lev-1), when using deposition buffers
cjzSame as jz (coarser, from lev-1), when using deposition buffers
rhoMultiFab to which the particles' charge is deposited
crhoSame as rho (coarser, from lev-1), when using deposition buffers
cExSame as Ex (coarser, from lev-1), when using gather buffers
cEySame as Ey (coarser, from lev-1), when using gather buffers
cEzSame as Ez (coarser, from lev-1), when using gather buffers
cBxSame as Bx (coarser, from lev-1), when using gather buffers
cBySame as By (coarser, from lev-1), when using gather buffers
cBzSame as Bz (coarser, from lev-1), when using gather buffers
tcurrent physical time
dttime step by which particles are advanced
a_dt_typetype of time step (used for sub-cycling)
skip_depositionSkip the charge and current deposition.
push_typeType of particle push, explicit or implicit. Defaults to explicit

Evolve iterates over particle iterator (each box) and performs filtering, field gather, particle push and current deposition for all particles in the box.

Reimplemented from PhysicalParticleContainer.

◆ InitData()

void RigidInjectedParticleContainer::InitData ( )
overridevirtual

Reimplemented from PhysicalParticleContainer.

◆ operator=() [1/2]

RigidInjectedParticleContainer& RigidInjectedParticleContainer::operator= ( RigidInjectedParticleContainer &&  )
default

◆ operator=() [2/2]

RigidInjectedParticleContainer& RigidInjectedParticleContainer::operator= ( RigidInjectedParticleContainer const &  )
delete

◆ PushP()

void RigidInjectedParticleContainer::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 
)
overridevirtual

This pushes the particle momenta by dt.

Reimplemented from PhysicalParticleContainer.

◆ PushPX()

void RigidInjectedParticleContainer::PushPX ( WarpXParIter pti,
amrex::FArrayBox const *  exfab,
amrex::FArrayBox const *  eyfab,
amrex::FArrayBox const *  ezfab,
amrex::FArrayBox const *  bxfab,
amrex::FArrayBox const *  byfab,
amrex::FArrayBox const *  bzfab,
amrex::IntVect  ngEB,
int  e_is_nodal,
long  offset,
long  np_to_push,
int  lev,
int  gather_lev,
amrex::Real  dt,
ScaleFields  scaleFields,
DtType  a_dt_type = DtType::Full 
)
overridevirtual

Reimplemented from PhysicalParticleContainer.

◆ ReadHeader()

void RigidInjectedParticleContainer::ReadHeader ( std::istream &  is)
overridevirtual

Reimplemented from PhysicalParticleContainer.

◆ RemapParticles()

void RigidInjectedParticleContainer::RemapParticles ( )
virtual

◆ WriteHeader()

void RigidInjectedParticleContainer::WriteHeader ( std::ostream &  os) const
overridevirtual

Reimplemented from PhysicalParticleContainer.

Member Data Documentation

◆ done_injecting_lev

bool RigidInjectedParticleContainer::done_injecting_lev
private

◆ rigid_advance

bool RigidInjectedParticleContainer::rigid_advance = true
private

◆ vzbeam_ave_boosted

amrex::ParticleReal RigidInjectedParticleContainer::vzbeam_ave_boosted
private

◆ zinject_plane

amrex::ParticleReal RigidInjectedParticleContainer::zinject_plane = 0.
private

◆ zinject_plane_lev

amrex::ParticleReal RigidInjectedParticleContainer::zinject_plane_lev
private

◆ zinject_plane_lev_previous

amrex::ParticleReal RigidInjectedParticleContainer::zinject_plane_lev_previous
private

◆ zinject_plane_levels

amrex::Vector<amrex::ParticleReal> RigidInjectedParticleContainer::zinject_plane_levels
private

The documentation for this class was generated from the following files: