WarpX.H

Go to the documentation of this file.

/* Copyright 2016-2020 Andrew Myers, Ann Almgren, Aurore Blelly
 *                     Axel Huebl, Burlen Loring, David Grote
 *                     Glenn Richardson, Junmin Gu, Luca Fedeli
 *                     Mathieu Lobet, Maxence Thevenet, Michael Rowan
 *                     Remi Lehe, Revathi Jambunathan, Weiqun Zhang
 *                     Yinjian Zhao
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_H_
#define WARPX_H_
 
#include "BoundaryConditions/PEC_Insulator_fwd.H"
#include "BoundaryConditions/PML_fwd.H"
#include "Diagnostics/MultiDiagnostics_fwd.H"
#include "Diagnostics/ReducedDiags/MultiReducedDiags_fwd.H"
#include "EmbeddedBoundary/WarpXFaceInfoBox_fwd.H"
#include "FieldSolver/ElectrostaticSolvers/ElectrostaticSolver_fwd.H"
#include "FieldSolver/FiniteDifferenceSolver/FiniteDifferenceSolver_fwd.H"
#include "FieldSolver/FiniteDifferenceSolver/MacroscopicProperties/MacroscopicProperties_fwd.H"
#include "FieldSolver/FiniteDifferenceSolver/HybridPICModel/HybridPICModel_fwd.H"
#include "Filter/NCIGodfreyFilter_fwd.H"
#include "Initialization/ExternalField_fwd.H"
#include "Particles/ParticleBoundaryBuffer_fwd.H"
#include "Particles/MultiParticleContainer_fwd.H"
#include "Particles/WarpXParticleContainer_fwd.H"
#include "Fluids/MultiFluidContainer_fwd.H"
#include "Fluids/WarpXFluidContainer_fwd.H"
 
#ifdef WARPX_USE_FFT
#   ifdef WARPX_DIM_RZ
#       include "FieldSolver/SpectralSolver/SpectralSolverRZ_fwd.H"
#       include "BoundaryConditions/PML_RZ_fwd.H"
#   else
#       include "FieldSolver/SpectralSolver/SpectralSolver_fwd.H"
#   endif
#endif
#include "AcceleratorLattice/AcceleratorLattice.H"
#include "Fields.H"
#include "FieldSolver/MagnetostaticSolver/MagnetostaticSolver.H"
#include "FieldSolver/ImplicitSolvers/ImplicitSolver.H"
#include "FieldSolver/ImplicitSolvers/WarpXSolverVec.H"
#include "Filter/BilinearFilter.H"
#include "Parallelization/GuardCellManager.H"
#include "Utils/Parser/IntervalsParser.H"
#include "Utils/WarpXAlgorithmSelection.H"
#include "Utils/export.H"
 
#include <ablastr/fields/MultiFabRegister.H>
#include <ablastr/utils/Enums.H>
 
#include <AMReX.H>
#include <AMReX_AmrCore.H>
#include <AMReX_Array.H>
#include <AMReX_Config.H>
#ifdef AMREX_USE_EB
#   include <AMReX_EBFabFactory.H>
#endif
#include <AMReX_GpuContainers.H>
#include <AMReX_IntVect.H>
#include <AMReX_LayoutData.H>
#include <AMReX_Parser.H>
#include <AMReX_REAL.H>
#include <AMReX_RealBox.H>
#include <AMReX_RealVect.H>
#include <AMReX_Vector.H>
 
#include <AMReX_BaseFwd.H>
#include <AMReX_AmrCoreFwd.H>
 
#include <array>
#include <iostream>
#include <limits>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <variant>
#include <vector>
 
class WARPX_EXPORT WarpX
    : public amrex::AmrCore
{
public:
    static WarpX& GetInstance ();
 
    static void ResetInstance ();

    static void Finalize();

    ~WarpX () override;

    WarpX ( WarpX const &) = delete;
    WarpX& operator= ( WarpX const & ) = delete;

    WarpX ( WarpX && ) = delete;
    WarpX& operator= ( WarpX && ) = delete;
 
    static std::string Version (); 
    static std::string PicsarVersion (); 
 
    [[nodiscard]] int Verbose () const { return verbose; }
 
    [[nodiscard]] const amrex::Array<FieldBoundaryType,AMREX_SPACEDIM>& GetFieldBoundaryLo () const
    {
        return field_boundary_lo;
    }
 
    [[nodiscard]] const amrex::Array<FieldBoundaryType,AMREX_SPACEDIM>& GetFieldBoundaryHi () const
    {
        return field_boundary_hi;
    }
 
    void InitData ();
 
    void Evolve (int numsteps = -1);

    void SynchronizeVelocityWithPosition ();
 
    //
    // Functions used by implicit solvers
    //
    void SyncMassMatricesPC ();
    void SaveParticlesAtImplicitStepStart ();
    void FinishImplicitParticleUpdate ();
    void SetElectricFieldAndApplyBCs ( const WarpXSolverVec& a_E, amrex::Real a_time );
    void UpdateMagneticFieldAndApplyBCs ( ablastr::fields::MultiLevelVectorField const& a_Bn,
                                          amrex::Real a_thetadt, amrex::Real start_time );
    void SpectralSourceFreeFieldAdvance ( amrex::Real start_time);
    void FinishMagneticFieldAndApplyBCs ( ablastr::fields::MultiLevelVectorField const& a_Bn,
                                          amrex::Real a_theta, amrex::Real a_time );
    void FinishImplicitField ( const ablastr::fields::MultiLevelVectorField& Field_fp,
                               const ablastr::fields::MultiLevelVectorField& Field_n,
                               amrex::Real theta );
    void ImplicitComputeRHSE (         amrex::Real dt, WarpXSolverVec& a_Erhs_vec);
    void ImplicitComputeRHSE (int lev, amrex::Real dt, WarpXSolverVec& a_Erhs_vec);
    void ImplicitComputeRHSE (int lev, PatchType patch_type, amrex::Real dt, WarpXSolverVec& a_Erhs_vec);
 
    MultiParticleContainer& GetPartContainer () { return *mypc; }
    MultiFluidContainer& GetFluidContainer () { return *myfl; }
    ElectrostaticSolver& GetElectrostaticSolver () {return *m_electrostatic_solver;}
    [[nodiscard]] HybridPICModel * get_pointer_HybridPICModel () const { return m_hybrid_pic_model.get(); }
    MultiDiagnostics& GetMultiDiags () {return *multi_diags;}
    ParticleBoundaryBuffer& GetParticleBoundaryBuffer () { return *m_particle_boundary_buffer; }
    amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > >& GetEBUpdateEFlag() { return m_eb_update_E; }
    amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > >& GetEBUpdateBFlag() { return m_eb_update_B; }
    amrex::Vector< std::unique_ptr<amrex::iMultiFab> > const & GetEBReduceParticleShapeFlag() const { return m_eb_reduce_particle_shape; }

    [[nodiscard]] std::string GetAuthors () const { return m_authors; }

    int maxlevel_extEMfield_init;
 
    // Algorithms
    static inline auto current_deposition_algo = CurrentDepositionAlgo::Default;
    static inline auto charge_deposition_algo = ChargeDepositionAlgo::Default;
    static inline auto field_gathering_algo = GatheringAlgo::Default;
    static inline auto particle_pusher_algo = ParticlePusherAlgo::Default;
    static inline auto electromagnetic_solver_id = ElectromagneticSolverAlgo::Default;
    EvolveScheme evolve_scheme = EvolveScheme::Default;
    static inline auto load_balance_costs_update_algo = LoadBalanceCostsUpdateAlgo::Default;
    static inline amrex::Array<FieldBoundaryType,AMREX_SPACEDIM> field_boundary_lo;

    static inline amrex::Array<FieldBoundaryType,AMREX_SPACEDIM> field_boundary_hi;

    static inline amrex::Array<ParticleBoundaryType,AMREX_SPACEDIM> particle_boundary_lo;

    static inline amrex::Array<ParticleBoundaryType,AMREX_SPACEDIM> particle_boundary_hi;

    static inline auto time_dependency_J = TimeDependencyJ::Default;
    static inline auto time_dependency_rho = TimeDependencyRho::Default;

    bool do_current_centering = false;

    //  to satisfy the continuity equation and charge conservation
    bool current_correction = true;

    bool update_with_rho = false;

    static bool do_single_precision_comms;

    static bool do_shared_mem_charge_deposition;

    static bool do_shared_mem_current_deposition;

    static int shared_mem_current_tpb;

    static amrex::IntVect shared_tilesize;

    static amrex::IntVect m_fill_guards_fields;

    static amrex::IntVect m_fill_guards_current;

    static bool do_dive_cleaning;
    static bool do_divb_cleaning;

    static int nox;
    static int noy;
    static int noz;

    static int particle_max_grid_crossings;

    static int field_centering_nox;
    static int field_centering_noy;
    static int field_centering_noz;

    static int n_rz_azimuthal_modes;
    static int ncomps;

    static bool use_fdtd_nci_corr;
    static bool galerkin_interpolation;

    static bool use_filter;
    static bool use_kspace_filter;
    static bool use_filter_compensation;

    static bool serialize_initial_conditions;

    static amrex::Real gamma_boost;
    static amrex::Real beta_boost;
    static amrex::Vector<int> boost_direction;

    static amrex::Real zmin_domain_boost_step_0;

    static bool compute_max_step_from_btd;
 
    static bool do_dynamic_scheduling;
    static bool refine_plasma;
 
    static utils::parser::IntervalsParser sort_intervals;
    static amrex::IntVect sort_bin_size;

    static bool sort_particles_for_deposition;
    static amrex::IntVect sort_idx_type;

    static int n_field_gather_buffer;
    static int n_current_deposition_buffer;

    static inline auto grid_type = ablastr::utils::enums::GridType::Default;
 
    // Global rho nodal flag to know about rho index type when rho MultiFab is not allocated
    amrex::IntVect m_rho_nodal_flag;

    void AllocInitMultiFab (
        std::unique_ptr<amrex::iMultiFab>& mf,
        const amrex::BoxArray& ba,
        const amrex::DistributionMapping& dm,
        int ncomp,
        const amrex::IntVect& ngrow,
        int level,
        const std::string& name,
        std::optional<const int> initial_value = {});
 
    // Maps of all of the iMultiFabs used (this can include MFs from other classes)
    // This is a convenience for the Python interface, allowing all iMultiFabs
    // to be easily referenced from Python.
    std::map<std::string, amrex::iMultiFab *> imultifab_map;

    [[nodiscard]] const amrex::iMultiFab*
    getFieldDotMaskPointer (warpx::fields::FieldType field_type, int lev, ablastr::fields::Direction dir) const;
 
    [[nodiscard]] bool DoPML () const {return do_pml;}
    [[nodiscard]] bool DoFluidSpecies () const {return do_fluid_species;}

    [[nodiscard]] std::vector<bool> getPMLdirections() const;
 
    static amrex::LayoutData<amrex::Real>* getCosts (int lev);
 
    void setLoadBalanceEfficiency (int lev, amrex::Real efficiency);
 
    amrex::Real getLoadBalanceEfficiency (int lev);
 
    static amrex::IntVect filter_npass_each_dir;
    BilinearFilter bilinear_filter;
    amrex::Vector< std::unique_ptr<NCIGodfreyFilter> > nci_godfrey_filter_exeybz;
    amrex::Vector< std::unique_ptr<NCIGodfreyFilter> > nci_godfrey_filter_bxbyez;
 
    amrex::Real time_of_last_gal_shift = 0;
    amrex::Vector<amrex::Real> m_v_galilean = amrex::Vector<amrex::Real>(3, amrex::Real(0.));
    amrex::Array<amrex::Real,3> m_galilean_shift = {{0}};
 
    amrex::Vector<amrex::Real> m_v_comoving = amrex::Vector<amrex::Real>(3, amrex::Real(0.));

    std::unique_ptr<MultiReducedDiags> reduced_diags;
 
    void applyMirrors(amrex::Real time);

    void ComputeDt ();

    void UpdateDtFromParticleSpeeds ();

    void PrintMainPICparameters ();

    void ComputeMaxStep ();
    // Compute max_step automatically for simulations in a boosted frame.
    void computeMaxStepBoostAccelerator();

    int  MoveWindow (int step, bool move_j);

    void ShiftGalileanBoundary ();
 
    void ResetProbDomain (const amrex::RealBox& rb);
    void EvolveE (         amrex::Real dt, amrex::Real start_time);
    void EvolveE (int lev, amrex::Real dt, amrex::Real start_time);
    void EvolveB (         amrex::Real dt, SubcyclingHalf subcycling_half, amrex::Real start_time);
    void EvolveB (int lev, amrex::Real dt, SubcyclingHalf subcycling_half, amrex::Real start_time);
    void EvolveF (         amrex::Real dt, int const rho_comp);
    void EvolveF (int lev, amrex::Real dt, int const rho_comp);
    void EvolveG (         amrex::Real dt);
    void EvolveG (int lev, amrex::Real dt);
    void EvolveB (int lev, PatchType patch_type, amrex::Real dt, SubcyclingHalf subcycling_half, amrex::Real start_time);
    void EvolveE (int lev, PatchType patch_type, amrex::Real dt, amrex::Real start_time);
    void EvolveF (int lev, PatchType patch_type, amrex::Real dt, int const rho_comp);
    void EvolveG (int lev, PatchType patch_type, amrex::Real dt);
 
    void MacroscopicEvolveE (         amrex::Real dt, amrex::Real start_time);
    void MacroscopicEvolveE (int lev, amrex::Real dt, amrex::Real start_time);
    void MacroscopicEvolveE (int lev, PatchType patch_type, amrex::Real dt, amrex::Real start_time);

    void HybridPICEvolveFields ();

    void HybridPICInitializeRhoJandB ();

    void HybridPICDepositRhoAndJ ();

    void Hybrid_QED_Push (         amrex::Vector<amrex::Real> dt);

    void Hybrid_QED_Push (int lev, amrex::Real dt);

    void Hybrid_QED_Push (int lev, PatchType patch_type, amrex::Real dt);
 
    amrex::Real m_quantum_xi_c2;

    void CheckLoadBalance (int step);

    void LoadBalance ();

    void ResetCosts ();

    void RescaleCosts (int step);

    [[nodiscard]] utils::parser::IntervalsParser get_load_balance_intervals () const
    {
        return load_balance_intervals;
    }

    void DampFieldsInGuards (int lev,
                             const ablastr::fields::VectorField& Efield,
                             const ablastr::fields::VectorField& Bfield);

    void DampFieldsInGuards (int lev, amrex::MultiFab* mf);
 
#if defined(WARPX_DIM_RZ) || defined(WARPX_DIM_RCYLINDER) || defined(WARPX_DIM_RSPHERE)
    void ApplyInverseVolumeScalingToCurrentDensity(amrex::MultiFab* Jx,
                                                   amrex::MultiFab* Jy,
                                                   amrex::MultiFab* Jz,
                                                   int lev) const;
 
    void ApplyInverseVolumeScalingToChargeDensity(amrex::MultiFab* Rho,
                                                  int lev) const;
#endif

    void ApplyRhofieldBoundary (int lev, amrex::MultiFab* Rho,
                                PatchType patch_type);

    void ApplyJfieldBoundary (int lev, amrex::MultiFab* Jx,
                              amrex::MultiFab* Jy, amrex::MultiFab* Jz,
                              PatchType patch_type);
 
    void ApplyEfieldBoundary (int lev, PatchType patch_type, amrex::Real cur_time);
    void ApplyBfieldBoundary (int lev, PatchType patch_type, SubcyclingHalf subcycling_half, amrex::Real cur_time);
 
#if defined(WARPX_DIM_RZ) || defined(WARPX_DIM_RCYLINDER) || defined(WARPX_DIM_RSPHERE)
    // Applies the boundary conditions that are specific to the axis when in RZ.
    void ApplyFieldBoundaryOnAxis (amrex::MultiFab* Er, amrex::MultiFab* Et, amrex::MultiFab* Ez, int lev) const;
#endif

    void ApplyElectronPressureBoundary (int lev, PatchType patch_type);
 
    void DampPML ();
    void DampPML (int lev);
    void DampPML (int lev, PatchType patch_type);
    void DampPML_Cartesian (int lev, PatchType patch_type);
 
    void DampJPML ();
    void DampJPML (int lev);
    void DampJPML (int lev, PatchType patch_type);
 
    void CopyJPML ();

    static bool isAnyParticleBoundaryThermal();
 
    PML* GetPML (int lev);
#if (defined WARPX_DIM_RZ) && (defined WARPX_USE_FFT)
    PML_RZ* GetPML_RZ (int lev);
#endif

    void doFieldIonization ();
 
#ifdef WARPX_QED
    void doQEDEvents ();
#endif
 
    void PushParticlesandDeposit (int lev, amrex::Real cur_time, SubcyclingHalf subcycling_half=SubcyclingHalf::None, bool skip_current=false,
                                  ImplicitOptions const * implicit_options = nullptr);
    void PushParticlesandDeposit (amrex::Real cur_time, bool skip_current=false,
                                  ImplicitOptions const * implicit_options = nullptr);
 
    // This function does aux(lev) = fp(lev) + I(aux(lev-1)-cp(lev)).
    // Caller must make sure fp and cp have ghost cells filled.
    void UpdateAuxilaryData ();
    void UpdateAuxilaryDataStagToNodal ();
    void UpdateAuxilaryDataSameType ();
 
    // Fill boundary cells including coarse/fine boundaries
    void FillBoundaryB   (amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryE   (amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryB_avg   (amrex::IntVect ng);
    void FillBoundaryE_avg   (amrex::IntVect ng);
 
    void FillBoundaryF   (amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryG   (amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryAux (amrex::IntVect ng);
    void FillBoundaryE   (int lev, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryB   (int lev, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryE_avg   (int lev, amrex::IntVect ng);
    void FillBoundaryB_avg   (int lev, amrex::IntVect ng);
 
    void FillBoundaryF   (int lev, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryG   (int lev, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryAux (int lev, amrex::IntVect ng);

    void SyncCurrentAndRho ();

    void SyncCurrent (const std::string& current_fp_string);
 
    void SyncRho ();
 
    void SyncRho (
        const ablastr::fields::MultiLevelScalarField& charge_fp,
        const ablastr::fields::MultiLevelScalarField& charge_cp,
        ablastr::fields::MultiLevelScalarField const & charge_buffer);
 
    [[nodiscard]] amrex::Vector<int> getnsubsteps () const {return nsubsteps;}
    [[nodiscard]] int getnsubsteps (int lev) const {return nsubsteps[lev];}
    [[nodiscard]] amrex::Vector<int> getistep () const {return istep;}
    [[nodiscard]] int getistep (int lev) const {return istep[lev];}
    void setistep (int lev, int ii) {istep[lev] = ii;}
    [[nodiscard]] amrex::Vector<amrex::Real> gett_old () const {return t_old;}
    [[nodiscard]] amrex::Real gett_old (int lev) const {return t_old[lev];}
    [[nodiscard]] amrex::Vector<amrex::Real> gett_new () const {return t_new;}
    [[nodiscard]] amrex::Real gett_new (int lev) const {return t_new[lev];}
    void sett_new (int lev, amrex::Real time) {t_new[lev] = time;}
    [[nodiscard]] amrex::Vector<amrex::Real> getdt () const {return dt;}
    [[nodiscard]] amrex::Real getdt (int lev) const {return dt.at(lev);}
    [[nodiscard]] int getdo_moving_window() const {return do_moving_window;}
    [[nodiscard]] amrex::Real getmoving_window_x() const {return moving_window_x;}
    [[nodiscard]] bool getis_synchronized() const {return m_is_synchronized;}
 
    [[nodiscard]] int maxStep () const {return max_step;}
    void updateMaxStep (const int new_max_step) {max_step = new_max_step;}
    [[nodiscard]] amrex::Real stopTime () const {return stop_time;}
    void updateStopTime (const amrex::Real new_stop_time) {stop_time = new_stop_time;}
 
    static std::array<amrex::Real,3> CellSize (int lev);
    static amrex::XDim3 InvCellSize (int lev);
    static amrex::RealBox getRealBox(const amrex::Box& bx, int lev);

    static amrex::XDim3 LowerCorner (const amrex::Box& bx, int lev, amrex::Real time_shift_delta);
    static amrex::XDim3 UpperCorner (const amrex::Box& bx, int lev, amrex::Real time_shift_delta);
 
    static amrex::IntVect RefRatio (int lev);
 
    static const amrex::iMultiFab* CurrentBufferMasks (int lev);
    static const amrex::iMultiFab* GatherBufferMasks (int lev);
 
    static inline auto electrostatic_solver_id = ElectrostaticSolverAlgo::Default;
    static inline auto poisson_solver_id = PoissonSolverAlgo::Default;
 
    static int do_moving_window; // boolean
    static int start_moving_window_step; // the first step to move window
    static int end_moving_window_step; // the last step to move window
    static int moving_window_active (int const step) {
        bool const step_before_end = (step < end_moving_window_step) || (end_moving_window_step < 0);
        bool const step_after_start = (step >= start_moving_window_step);
        return do_moving_window && step_before_end && step_after_start;
    }
    static int moving_window_dir;
    static amrex::Real moving_window_v;
    static bool fft_do_time_averaging;
 
    // these should be private, but can't due to Cuda limitations
    static void ComputeDivB (amrex::MultiFab& divB, int dcomp,
                             ablastr::fields::VectorField const & B,
                             const std::array<amrex::Real,3>& dx);
 
    static void ComputeDivB (amrex::MultiFab& divB, int dcomp,
                             ablastr::fields::VectorField const & B,
                             const std::array<amrex::Real,3>& dx, amrex::IntVect ngrow);
 
    void ComputeDivE(amrex::MultiFab& divE, int lev);
 
    void ProjectionCleanDivB ();
    void CalculateExternalCurlA ();
 
    [[nodiscard]] amrex::IntVect getngEB() const { return guard_cells.ng_alloc_EB; }
    [[nodiscard]] amrex::IntVect getngF() const { return guard_cells.ng_alloc_F; }
    [[nodiscard]] amrex::IntVect getngUpdateAux() const { return guard_cells.ng_UpdateAux; }
    [[nodiscard]] amrex::IntVect get_ng_depos_J() const {return guard_cells.ng_depos_J;}
    [[nodiscard]] amrex::IntVect get_ng_depos_rho() const {return guard_cells.ng_depos_rho;}
    [[nodiscard]] amrex::IntVect get_ng_fieldgather () const {return guard_cells.ng_FieldGather;}

    [[nodiscard]] amrex::IntVect get_numprocs() const {return numprocs;}

    void ComputeSpaceChargeField (bool reset_fields);
 
    // Magnetostatic Solver Interface
    MagnetostaticSolver::VectorPoissonBoundaryHandler m_vector_poisson_boundary_handler;
    int magnetostatic_solver_max_iters = 200;
    int magnetostatic_solver_verbosity = 2;
    void ComputeMagnetostaticField ();
    void AddMagnetostaticFieldLabFrame ();
    void computeVectorPotential (ablastr::fields::MultiLevelVectorField const& curr,
                                 ablastr::fields::MultiLevelVectorField const& A,
                                 amrex::Real required_precision=amrex::Real(1.e-11),
                                 amrex::Real absolute_tolerance=amrex::Real(0.0),
                                 int max_iters=200,
                                 int verbosity=2); // const;
 
    void setVectorPotentialBC (ablastr::fields::MultiLevelVectorField const& A) const;

    void ComputeExternalFieldOnGridUsingParser (
        const std::variant<warpx::fields::FieldType, std::string>& field,
        amrex::ParserExecutor<4> const& fx_parser,
        amrex::ParserExecutor<4> const& fy_parser,
        amrex::ParserExecutor<4> const& fz_parser,
        int lev, PatchType patch_type,
        amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > > const& eb_update_field,
        bool use_eb_flags = true);

    void LoadExternalFields (int lev);

    void ReadExternalFieldFromFile (
         const std::string& read_fields_from_path, amrex::MultiFab* mf,
         const std::string& F_name, const std::string& F_component);

    void InitializeEBGridData(int lev);

    void ComputeCostsHeuristic (amrex::Vector<std::unique_ptr<amrex::LayoutData<amrex::Real> > >& costs);
 
    void ApplyFilterandSumBoundaryRho (int lev, int glev, amrex::MultiFab& rho, int icomp, int ncomp);
 
    void ApplyFilterMF (
        const ablastr::fields::MultiLevelVectorField& mfvec,
        int lev,
        int idim);
 
    void ApplyFilterMF (
        const ablastr::fields::MultiLevelVectorField& mfvec,
        int lev);
 
    // Device vectors of stencil coefficients used for finite-order centering of fields
    amrex::Gpu::DeviceVector<amrex::Real> device_field_centering_stencil_coeffs_x;
    amrex::Gpu::DeviceVector<amrex::Real> device_field_centering_stencil_coeffs_y;
    amrex::Gpu::DeviceVector<amrex::Real> device_field_centering_stencil_coeffs_z;
 
    // Device vectors of stencil coefficients used for finite-order centering of currents
    amrex::Gpu::DeviceVector<amrex::Real> device_current_centering_stencil_coeffs_x;
    amrex::Gpu::DeviceVector<amrex::Real> device_current_centering_stencil_coeffs_y;
    amrex::Gpu::DeviceVector<amrex::Real> device_current_centering_stencil_coeffs_z;
 
    // This needs to be public for CUDA.
    void ErrorEst (int lev, amrex::TagBoxArray& tags, amrex::Real time, int /*ngrow*/) final;
 
    // Return the accelerator lattice instance defined at the given refinement level
    const AcceleratorLattice& get_accelerator_lattice (int lev) {return *(m_accelerator_lattice[lev]);}
 
    // for cuda
    void BuildBufferMasksInBox ( amrex::Box tbx, amrex::IArrayBox &buffer_mask,
                                 const amrex::IArrayBox &guard_mask, int ng );
#ifdef AMREX_USE_EB
    [[nodiscard]] amrex::EBFArrayBoxFactory const& fieldEBFactory (int lev) const noexcept {
        return static_cast<amrex::EBFArrayBoxFactory const&>(*m_field_factory[lev]);
    }
#endif
 
    void InitEB ();

    void ComputeDistanceToEB ();
    void ComputeFaceExtensions();
    void InitBorrowing();
    void ShrinkBorrowing();
    void ComputeOneWayExtensions();
    void ComputeEightWaysExtensions();
 
#ifdef WARPX_USE_FFT
    auto&  get_spectral_solver_fp (int lev) {return *spectral_solver_fp[lev];}
#endif
 
    FiniteDifferenceSolver * get_pointer_fdtd_solver_fp (int lev) { return m_fdtd_solver_fp[lev].get(); }
 
    // Field container
    ablastr::fields::MultiFabRegister m_fields;
    ablastr::fields::MultiFabRegister& GetMultiFabRegister() {return m_fields;}

    void PostProcessBaseGrids (amrex::BoxArray& ba0) const final;
 
protected:

    void InitLevelData (int lev, amrex::Real time);

    [[nodiscard]] amrex::DistributionMapping
    MakeDistributionMap (int lev, amrex::BoxArray const& ba) final;

    void MakeNewLevelFromScratch (int lev, amrex::Real time, const amrex::BoxArray& new_grids,
                                          const amrex::DistributionMapping& new_dmap) final;

    void MakeNewLevelFromCoarse (int /*lev*/, amrex::Real /*time*/, const amrex::BoxArray& /*ba*/,
                                         const amrex::DistributionMapping& /*dm*/) final;

    void RemakeLevel (int lev, amrex::Real time, const amrex::BoxArray& ba,
                              const amrex::DistributionMapping& dm) final;

    void ClearLevel (int lev) final;
 
private:

    WarpX ();

    static void MakeWarpX ();
 
    // Singleton is used when the code is run from python
    static WarpX* m_instance;

    void HandleSignals ();
 
    void FillBoundaryB (int lev, PatchType patch_type, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryE (int lev, PatchType patch_type, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryF (int lev, PatchType patch_type, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
    void FillBoundaryG (int lev, PatchType patch_type, amrex::IntVect ng, std::optional<bool> nodal_sync = std::nullopt);
 
    void FillBoundaryB_avg (int lev, PatchType patch_type, amrex::IntVect ng);
    void FillBoundaryE_avg (int lev, PatchType patch_type, amrex::IntVect ng);
 
    void AddExternalFields (int lev);

    void OneStep (
        amrex::Real a_cur_time,
        amrex::Real a_dt,
        int a_step
    );
 
    void OneStep_nosub (amrex::Real cur_time);
    void OneStep_sub1 (amrex::Real cur_time);

    void OneStep_JRhom (amrex::Real cur_time);
 
    void RestrictCurrentFromFineToCoarsePatch (
        const ablastr::fields::MultiLevelVectorField& J_fp,
        const ablastr::fields::MultiLevelVectorField& J_cp,
        int lev);
    void AddCurrentFromFineLevelandSumBoundary (
        const ablastr::fields::MultiLevelVectorField& J_fp,
        const ablastr::fields::MultiLevelVectorField& J_cp,
        const ablastr::fields::MultiLevelVectorField& J_buffer,
        int lev);
    void SumBoundaryJ (
        const ablastr::fields::MultiLevelVectorField& current,
        int lev,
        int idim,
        const amrex::Periodicity& period);
    void SumBoundaryJ (
        const ablastr::fields::MultiLevelVectorField& current,
        int lev,
        const amrex::Periodicity& period);
 
    void RestrictRhoFromFineToCoarsePatch (int lev );
    void ApplyFilterandSumBoundaryRho (
        const ablastr::fields::MultiLevelScalarField& charge_fp,
        const ablastr::fields::MultiLevelScalarField& charge_cp,
        int lev,
        PatchType patch_type,
        int icomp,
        int ncomp);
    void AddRhoFromFineLevelandSumBoundary (
        const ablastr::fields::MultiLevelScalarField& charge_fp,
        const ablastr::fields::MultiLevelScalarField& charge_cp,
        ablastr::fields::MultiLevelScalarField const & charge_buffer,
        int lev,
        int icomp,
        int ncomp);
 
    void ReadParameters ();

    void BackwardCompatibility ();
 
    void InitFromScratch ();
 
    void AllocLevelData (int lev, const amrex::BoxArray& ba,
                         const amrex::DistributionMapping& dm);
 
    [[nodiscard]] amrex::DistributionMapping
    GetRestartDMap (const std::string& chkfile, const amrex::BoxArray& ba, int lev) const;
 
    void InitFromCheckpoint ();
    void PostRestart ();
 
    void InitPML ();
    void ComputePMLFactors ();
 
    void InitFilter ();
 
    void InitDiagnostics ();
 
    void InitNCICorrector ();

    void CheckGuardCells();
 
    void BuildBufferMasks ();
 
    [[nodiscard]] const amrex::iMultiFab* getCurrentBufferMasks (int lev) const {
        return current_buffer_masks[lev].get();
    }
 
    [[nodiscard]] const amrex::iMultiFab* getGatherBufferMasks (int lev) const
    {
        return gather_buffer_masks[lev].get();
    }
 
    void AllocLevelMFs (int lev, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm,
                        const amrex::IntVect& ngEB, amrex::IntVect& ngJ,
                        const amrex::IntVect& ngRho, const amrex::IntVect& ngF,
                        const amrex::IntVect& ngG, bool aux_is_nodal);
 
#ifdef WARPX_USE_FFT
#   ifdef WARPX_DIM_RZ
    void AllocLevelSpectralSolverRZ (amrex::Vector<std::unique_ptr<SpectralSolverRZ>>& spectral_solver,
                                     int lev,
                                     const amrex::BoxArray& realspace_ba,
                                     const amrex::DistributionMapping& dm,
                                     const std::array<amrex::Real,3>& dx);
#   else
    void AllocLevelSpectralSolver (amrex::Vector<std::unique_ptr<SpectralSolver>>& spectral_solver,
                                   int lev,
                                   const amrex::BoxArray& realspace_ba,
                                   const amrex::DistributionMapping& dm,
                                   const std::array<amrex::Real,3>& dx,
                                   bool pml_flag=false);
#   endif
#endif

    std::string m_authors;
 
    amrex::Vector<int> istep;      // which step?
    amrex::Vector<int> nsubsteps;  // how many substeps on each level?
 
    amrex::Vector<amrex::Real> t_new;
    amrex::Vector<amrex::Real> t_old;
    amrex::Vector<amrex::Real> dt;
    utils::parser::IntervalsParser m_dt_update_interval = utils::parser::IntervalsParser{}; // How often to update the timestep when using adaptive timestepping
 
    bool m_safe_guard_cells = false;
 
    // Particle container
    std::unique_ptr<MultiParticleContainer> mypc;
    std::unique_ptr<MultiDiagnostics> multi_diags;

    int m_current_centering_nox  = 2;
    int m_current_centering_noy = 2;
    int m_current_centering_noz = 2;
 
    // Fluid container
    bool do_fluid_species = false;
    std::unique_ptr<MultiFluidContainer> myfl;

    MediumForEM m_em_solver_medium = MediumForEM::Default;

    MacroscopicSolverAlgo m_macroscopic_solver_algo = MacroscopicSolverAlgo::Default;
 
    //
    // Fields: First array for level, second for direction
    //
 
    // Masks for computing dot product and global moments of fields when using grids that
    // have shared locations across different ranks (e.g., a Yee grid)
    mutable amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > > Efield_dotMask;
    mutable amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > > Bfield_dotMask;
    mutable amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > > Afield_dotMask;
    mutable amrex::Vector<            std::unique_ptr<amrex::iMultiFab>     > phi_dotMask;

    amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > > m_eb_update_E;
    amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>,3 > > m_eb_update_B;

    amrex::Vector<  std::unique_ptr<amrex::iMultiFab> > m_eb_reduce_particle_shape;

    amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>, 3 > > m_flag_info_face;
    amrex::Vector<std::array< std::unique_ptr<amrex::iMultiFab>, 3 > > m_flag_ext_face;

    amrex::Vector<std::array< std::unique_ptr<amrex::LayoutData<FaceInfoBox> >, 3 > > m_borrowing;
 
    // Copy of the coarse aux
    amrex::Vector<std::unique_ptr<amrex::iMultiFab> > current_buffer_masks;
    amrex::Vector<std::unique_ptr<amrex::iMultiFab> > gather_buffer_masks;
 
    // PML
    int do_pml = 0;
    int do_silver_mueller = 0;
    int pml_ncell = 10;
    int pml_delta = 10;
    int pml_has_particles = 0;
    int do_pml_j_damping = 0;
    int do_pml_in_domain = 0;
    bool do_similar_dm_pml = true;
    bool do_pml_dive_cleaning; // default set in WarpX.cpp
    bool do_pml_divb_cleaning; // default set in WarpX.cpp
    amrex::Vector<amrex::IntVect> do_pml_Lo;
    amrex::Vector<amrex::IntVect> do_pml_Hi;
    amrex::Vector<std::unique_ptr<PML> > pml;
#if (defined WARPX_DIM_RZ) && (defined WARPX_USE_FFT)
    amrex::Vector<std::unique_ptr<PML_RZ> > pml_rz;
#endif
    amrex::Real v_particle_pml;
 
    // Insulator boundary conditions
    std::unique_ptr<PEC_Insulator> pec_insulator_boundary;
 
    // External fields parameters
    std::unique_ptr<ExternalFieldParams> m_p_ext_field_params;
 
    amrex::Real moving_window_x = std::numeric_limits<amrex::Real>::max();
 
    // Mirrors
    int m_num_mirrors = 0;
    amrex::Vector<amrex::Real> m_mirror_z;
    amrex::Vector<amrex::Real> m_mirror_z_width;
    amrex::Vector<int> m_mirror_z_npoints;
 
    // Plasma injection parameters
    int warpx_do_continuous_injection = 0;
    int num_injected_species = -1;
    amrex::Vector<int> injected_plasma_species;
 
    // Timestepping parameters
    std::optional<amrex::Real> m_const_dt;
    std::optional<amrex::Real> m_max_dt;
 
    // whether to use subcycling
    bool m_do_subcycling = false;

    bool m_verboncoeur_axis_correction = true;
 
    // Macroscopic properties
    std::unique_ptr<MacroscopicProperties> m_macroscopic_properties;
 
    // Electrostatic solver
    std::unique_ptr<ElectrostaticSolver> m_electrostatic_solver;
 
    // Hybrid PIC algorithm parameters
    std::unique_ptr<HybridPICModel> m_hybrid_pic_model;
 
    // Load balancing
    utils::parser::IntervalsParser load_balance_intervals;
    amrex::Vector<std::unique_ptr<amrex::LayoutData<amrex::Real> > > costs;
    int load_balance_with_sfc = 0;
    amrex::Real load_balance_knapsack_factor = amrex::Real(1.24);
    amrex::Real load_balance_efficiency_ratio_threshold = amrex::Real(1.1);
    amrex::Vector<amrex::Real> load_balance_efficiency;
    amrex::Real costs_heuristic_cells_wt = amrex::Real(0);
    amrex::Real costs_heuristic_particles_wt = amrex::Real(0);
 
    // Determines timesteps for override sync
    utils::parser::IntervalsParser override_sync_intervals;
 
    // Other runtime parameters
    int verbose = 1;
    bool m_limit_verbose_step = false;
 
    bool use_hybrid_QED = false;
 
    int max_step   = std::numeric_limits<int>::max();
    amrex::Real stop_time = std::numeric_limits<amrex::Real>::max();

    std::optional<amrex::Real> m_zmax_plasma_to_compute_max_step = std::nullopt;
 
    int regrid_int = -1;
 
    amrex::Real cfl = amrex::Real(0.999);
 
    std::string restart_chkfile;

    bool write_diagnostics_on_restart = false;
 
    bool synchronize_velocity_for_diagnostics = true;
 
    bool use_single_read = true;
    bool use_single_write = true;
    int mffile_nstreams = 4;
    int field_io_nfiles = 1024;
    int particle_io_nfiles = 1024;
 
    amrex::RealVect fine_tag_lo;
    amrex::RealVect fine_tag_hi;
    std::unique_ptr<amrex::Parser> ref_patch_parser;
 
    bool m_is_synchronized = true;
 
    // Synchronization of nodal points
    static constexpr bool sync_nodal_points = true;
 
    guardCellManager guard_cells;
 
    // Slice Parameters
    int slice_max_grid_size;
    int slice_plot_int = -1;
    amrex::RealBox slice_realbox;
    amrex::IntVect slice_cr_ratio;
 
    bool fft_periodic_single_box = false;
    int nox_fft = 16;
    int noy_fft = 16;
    int noz_fft = 16;
 
 

#if defined(AMREX_USE_CUDA)
    bool m_sort_particles_for_deposition = true;
#else
    bool m_sort_particles_for_deposition = false;
#endif

    amrex::IntVect m_sort_idx_type = amrex::IntVect(AMREX_D_DECL(0,0,0));

    bool m_do_initial_div_cleaning = false;

    amrex::IntVect numprocs{0};

    std::unique_ptr<ParticleBoundaryBuffer> m_particle_boundary_buffer;
 
    // Accelerator lattice elements
    amrex::Vector< std::unique_ptr<AcceleratorLattice> > m_accelerator_lattice;
 
    //
    // Embedded Boundary
    //
 
    // Factory for field data
    amrex::Vector<std::unique_ptr<amrex::FabFactory<amrex::FArrayBox> > > m_field_factory;

    bool m_exit_loop_due_to_interrupt_signal = false;

    [[nodiscard]]
    bool checkStopSimulation (amrex::Real cur_time);

    void HandleParticlesAtBoundaries (int step, amrex::Real cur_time, int num_moved);

    void ExplicitFillBoundaryEBUpdateAux ();

    PSATDSolutionType m_psatd_solution_type = PSATDSolutionType::Default;
 
    void PushPSATD (amrex::Real start_time);
 
#ifdef WARPX_USE_FFT

    void PSATDForwardTransformEB ();

    void PSATDBackwardTransformEB ();

    void PSATDBackwardTransformEBavg (
        ablastr::fields::MultiLevelVectorField const& E_avg_fp,
        ablastr::fields::MultiLevelVectorField const& B_avg_fp,
        ablastr::fields::MultiLevelVectorField const& E_avg_cp,
        ablastr::fields::MultiLevelVectorField const& B_avg_cp);

    void PSATDForwardTransformJ (
        std::string const & J_fp_string,
        std::string const & J_cp_string,
        bool apply_kspace_filter=true);

    void PSATDBackwardTransformJ (
        std::string const & J_fp_string,
        std::string const & J_cp_string);

    void PSATDForwardTransformRho (
        std::string const & charge_fp_string,
        std::string const & charge_cp_string,
        int icomp, int dcomp, bool apply_kspace_filter=true);

    void PSATDMoveRhoNewToRhoOld ();

    void PSATDMoveJNewToJOld ();

    void PSATDMoveRhoNewToRhoMid ();

    void PSATDMoveJNewToJMid ();

    void PSATDForwardTransformF ();

    void PSATDBackwardTransformF ();

    void PSATDForwardTransformG ();

    void PSATDBackwardTransformG ();

    void PSATDPushSpectralFields ();

    void PSATDScaleAverageFields (amrex::Real scale_factor);

    void PSATDEraseAverageFields ();
 
#   ifdef WARPX_DIM_RZ
        amrex::Vector<std::unique_ptr<SpectralSolverRZ>> spectral_solver_fp;
        amrex::Vector<std::unique_ptr<SpectralSolverRZ>> spectral_solver_cp;
#   else
        amrex::Vector<std::unique_ptr<SpectralSolver>> spectral_solver_fp;
        amrex::Vector<std::unique_ptr<SpectralSolver>> spectral_solver_cp;
#   endif
 
#endif
 
    amrex::Vector<std::unique_ptr<FiniteDifferenceSolver>> m_fdtd_solver_fp;
    amrex::Vector<std::unique_ptr<FiniteDifferenceSolver>> m_fdtd_solver_cp;
 
    // implicit solver object
    std::unique_ptr<ImplicitSolver> m_implicit_solver;

    bool m_JRhom = false;
    int m_JRhom_subintervals;
 
};
 
#endif