RigidInjectedParticleContainer.H

Go to the documentation of this file.

/* Copyright 2019 Andrew Myers, David Grote, Maxence Thevenet
 * Weiqun Zhang
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_RigidInjectedParticleContainer_H_
#define WARPX_RigidInjectedParticleContainer_H_
 
#include "Particles/Gather/ScaleFields.H"
#include "PhysicalParticleContainer.H"
 
#include "WarpXParticleContainer_fwd.H"
#include "FieldSolver/ImplicitSolvers/ImplicitOptions.H"
 
#include <AMReX_Enum.H>
#include <AMReX_REAL.H>
#include <AMReX_Vector.H>
 
#include <AMReX_BaseFwd.H>
#include <AMReX_AmrCoreFwd.H>
 
#include <iosfwd>
#include <string>
 
AMREX_ENUM(RigidAdvanceMode, vz, vzbar, v);

class RigidInjectedParticleContainer
    : public PhysicalParticleContainer
{
public:
    RigidInjectedParticleContainer (amrex::AmrCore* amr_core,
                                    int ispecies,
                                    const std::string& name);
    ~RigidInjectedParticleContainer () override = default;
 
    RigidInjectedParticleContainer ( RigidInjectedParticleContainer const &)             = delete;
    RigidInjectedParticleContainer& operator= ( RigidInjectedParticleContainer const & ) = delete;
    RigidInjectedParticleContainer ( RigidInjectedParticleContainer&& )                  = default;
    RigidInjectedParticleContainer& operator= ( RigidInjectedParticleContainer&& )       = default;
 
 
    void InitData() override;
 
    virtual void RemapParticles();
 
    void Evolve (ablastr::fields::MultiFabRegister& fields,
                 int lev,
                 const std::string& current_fp_string,
                 amrex::Real t,
                 amrex::Real dt,
                 SubcyclingHalf subcycling_half=SubcyclingHalf::None,
                 bool skip_deposition=false,
                 PositionPushType position_push_type=PositionPushType::Full,
                 MomentumPushType momentum_push_type=MomentumPushType::Full,
                 ImplicitOptions const * implicit_options = nullptr) override;
 
    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 /*e_is_nodal*/,
                         long offset,
                         long np_to_push,
                         int lev, int gather_lev,
                         amrex::Real dt, ScaleFields scaleFields,
                         SubcyclingHalf subcycling_half=SubcyclingHalf::None,
                         PositionPushType position_push_type=PositionPushType::Full,
                         MomentumPushType momentum_push_type=MomentumPushType::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;
 
private:
 
    // User input quantities
    amrex::ParticleReal zinject_plane = 0.;
    RigidAdvanceMode rigid_advance_mode = RigidAdvanceMode::vzbar;
 
    amrex::ParticleReal vzbeam_ave_boosted;
 
    amrex::Vector<amrex::ParticleReal> zinject_plane_levels;
 
    // Temporary quantities
    amrex::ParticleReal zinject_plane_lev;
    amrex::ParticleReal zinject_plane_lev_previous;
    bool done_injecting_lev;
 
};
 
#endif