26 #ifdef WARPX_USE_PSATD
46 #include <AMReX_Config.H>
98 void Evolve (
int numsteps = -1);
108 int num_shift,
int dir,
const int lev,
bool update_cost_flag,
109 amrex::Real external_field=0.0,
bool useparser =
false,
378 std::unique_ptr<amrex::MultiFab>& mf,
384 const std::string&
name,
385 std::optional<const amrex::Real> initial_value = {});
403 std::unique_ptr<amrex::iMultiFab>& mf,
409 const std::string&
name,
410 std::optional<const int> initial_value = {});
424 std::unique_ptr<amrex::MultiFab>& mf,
429 const std::string&
name,
430 std::optional<const amrex::Real> initial_value);
458 std::array<const amrex::MultiFab* const, 3>
466 std::array<const amrex::MultiFab* const, 3>
523 #if (defined WARPX_DIM_RZ) && (defined WARPX_USE_PSATD)
688 const std::array<std::unique_ptr<amrex::MultiFab>,3>& Efield,
689 const std::array<std::unique_ptr<amrex::MultiFab>,3>& Bfield);
768 #if (defined WARPX_DIM_RZ) && (defined WARPX_USE_PSATD)
846 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_fp,
847 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_cp,
848 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_buffer);
853 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_fp,
854 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_cp,
855 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_buffer);
868 amrex::Real
getdt (
int lev)
const {
return dt[lev];}
886 static std::array<amrex::Real,3>
CellSize (
int lev);
897 static std::array<amrex::Real,3>
LowerCorner (
const amrex::Box& bx,
const int lev,
const amrex::Real time_shift_delta);
906 static std::array<amrex::Real,3>
UpperCorner (
const amrex::Box& bx,
const int lev,
const amrex::Real time_shift_delta);
940 const std::array<const amrex::MultiFab* const, 3>& B,
941 const std::array<amrex::Real,3>&
dx);
944 const std::array<const amrex::MultiFab* const, 3>& B,
972 std::array<amrex::Real, 3>
const beta = {{0,0,0}},
973 amrex::Real
const required_precision=amrex::Real(1.e-11),
974 amrex::Real absolute_tolerance=amrex::Real(0.0),
975 const int max_iters=200,
982 std::array<amrex::Real, 3>
const beta = {{0,0,0}} )
const;
985 std::array<amrex::Real, 3>
const beta = {{0,0,0}} )
const;
987 amrex::Vector<std::unique_ptr<amrex::MultiFab> >& phi)
const;
995 amrex::Real
const required_precision=amrex::Real(1.e-11),
996 amrex::Real absolute_tolerance=amrex::Real(0.0),
997 const int max_iters=200,
998 const int verbosity=2)
const;
1028 std::array< std::unique_ptr<amrex::MultiFab>, 3 >
const& edge_lengths,
1029 std::array< std::unique_ptr<amrex::MultiFab>, 3 >
const& face_areas,
1035 std::string F_name, std::string F_component);
1171 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_fp,
1172 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_cp,
1175 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_fp,
1176 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_cp,
1177 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_buffer,
1182 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& current,
1186 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& current,
1189 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& current,
1194 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& current,
1198 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_fp,
1199 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_cp,
1204 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_fp,
1205 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_cp,
1208 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_fp,
1209 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_cp,
1215 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_fp,
1216 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_cp,
1217 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_buffer,
1222 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_fp,
1223 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_cp,
1314 const int centering_nox,
1315 const int centering_noy,
1316 const int centering_noz,
1317 const short a_grid_type);
1324 #ifdef WARPX_USE_PSATD
1325 # ifdef WARPX_DIM_RZ
1330 const std::array<amrex::Real,3>&
dx);
1332 void AllocLevelSpectralSolver (
amrex::Vector<std::unique_ptr<SpectralSolver>>& spectral_solver,
1336 const std::array<amrex::Real,3>&
dx,
1337 const bool pml_flag=
false);
1349 std::unique_ptr<MultiParticleContainer>
mypc;
1466 #if (defined WARPX_DIM_RZ) && (defined WARPX_USE_PSATD)
1530 amrex::Real
stop_time = std::numeric_limits<amrex::Real>::max();
1534 amrex::Real
cfl = amrex::Real(0.999);
1609 static void ComputeEdgeLengths (std::array< std::unique_ptr<amrex::MultiFab>, 3 >& edge_lengths,
1615 static void ComputeFaceAreas (std::array< std::unique_ptr<amrex::MultiFab>, 3 >& face_areas,
1621 static void ScaleEdges (std::array< std::unique_ptr<amrex::MultiFab>, 3 >& edge_lengths,
1622 const std::array<amrex::Real,3>&
cell_size);
1626 static void ScaleAreas (std::array< std::unique_ptr<amrex::MultiFab>, 3 >& face_areas,
1627 const std::array<amrex::Real,3>&
cell_size);
1688 #ifdef WARPX_USE_PSATD
1703 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& E_fp,
1704 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& B_fp,
1705 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& E_cp,
1706 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& B_cp);
1722 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& E_fp,
1723 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& B_fp,
1724 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& E_cp,
1725 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& B_cp);
1740 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& E_avg_fp,
1741 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& B_avg_fp,
1742 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& E_avg_cp,
1743 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& B_avg_cp);
1757 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_fp,
1758 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_cp,
1759 const bool apply_kspace_filter=
true);
1770 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_fp,
1771 const amrex::Vector<std::array<std::unique_ptr<amrex::MultiFab>,3>>& J_cp);
1785 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_fp,
1786 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& charge_cp,
1787 const int icomp,
const int dcomp,
const bool apply_kspace_filter=
true);
1846 # ifdef WARPX_DIM_RZ
1856 # ifdef WARPX_DIM_RZ
PatchType
Definition: WarpX.H:73
DtType
Definition: WarpXDtType.H:11
Definition: AcceleratorLattice.H:21
Definition: BilinearFilter.H:17
Definition: ElectrostaticSolver.H:35
Top-level class for the electromagnetic finite-difference solver.
Definition: FiniteDifferenceSolver.H:34
This class contains the parameters needed to evaluate hybrid field solutions (kinetic ions with fluid...
Definition: HybridPICModel.H:30
This class contains the macroscopic properties of the medium needed to evaluate macroscopic Maxwell e...
Definition: MacroscopicProperties.H:32
Definition: MagnetostaticSolver.H:21
This class contains a vector of all diagnostics in the simulation.
Definition: MultiDiagnostics.H:21
Definition: MultiParticleContainer.H:65
Definition: ParticleBoundaryBuffer.H:20
Top-level class for the electromagnetic spectral solver.
Definition: SpectralSolver.H:33
Definition: SpectralSolverRZ.H:22
void DampFieldsInGuards(const int lev, const std::array< std::unique_ptr< amrex::MultiFab >, 3 > &Efield, const std::array< std::unique_ptr< amrex::MultiFab >, 3 > &Bfield)
Private function for spectral solver Applies a damping factor in the guards cells that extend beyond ...
Definition: WarpXPushFieldsEM.cpp:1066
std::unique_ptr< ParticleBoundaryBuffer > m_particle_boundary_buffer
particle buffer for scraped particles on the boundaries
Definition: WarpX.H:1578
static int self_fields_max_iters
Definition: WarpX.H:918
void PSATDMoveRhoNewToRhoOld()
Copy rho_new to rho_old in spectral space (when rho is linear in time)
Definition: WarpXPushFieldsEM.cpp:561
const amrex::MultiFab & getrho_fp(int lev)
Definition: WarpX.H:511
static int field_centering_nox
Order of finite centering of fields (from staggered grid to nodal grid), along x.
Definition: WarpX.H:258
amrex::Vector< std::unique_ptr< amrex::LayoutData< amrex::Real > > > costs
Definition: WarpX.H:1492
static short current_deposition_algo
Integer that corresponds to the current deposition algorithm (Esirkepov, direct, Vay)
Definition: WarpX.H:160
amrex::Vector< std::unique_ptr< amrex::MultiFab > > G_fp
Definition: WarpX.H:1362
amrex::Gpu::DeviceVector< amrex::Real > device_field_centering_stencil_coeffs_y
Definition: WarpX.H:1068
static int moving_window_dir
Definition: WarpX.H:934
void SyncCurrent(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_cp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_buffer)
Apply filter and sum guard cells across MR levels. If current centering is used, center the current f...
Definition: WarpXComm.cpp:857
amrex::Gpu::DeviceVector< amrex::Real > device_current_centering_stencil_coeffs_x
Definition: WarpX.H:1072
void computePhi(const amrex::Vector< std::unique_ptr< amrex::MultiFab > > &rho, amrex::Vector< std::unique_ptr< amrex::MultiFab > > &phi, std::array< amrex::Real, 3 > const beta={{0, 0, 0}}, amrex::Real const required_precision=amrex::Real(1.e-11), amrex::Real absolute_tolerance=amrex::Real(0.0), const int max_iters=200, const int verbosity=2) const
Definition: ElectrostaticSolver.cpp:275
void ComputeSpaceChargeField(bool const reset_fields)
Definition: ElectrostaticSolver.cpp:58
void BuildBufferMasks()
Definition: WarpX.cpp:2886
bool use_hybrid_QED
Definition: WarpX.H:1527
static bool do_dive_cleaning
Definition: WarpX.H:246
static amrex::Real zmax_plasma_to_compute_max_step
Definition: WarpX.H:316
void doFieldIonization()
Definition: WarpXEvolve.cpp:937
amrex::MultiFab * get_pointer_edge_lengths(int lev, int direction) const
Definition: WarpX.H:495
const amrex::IntVect get_ng_fieldgather() const
Definition: WarpX.H:954
amrex::MultiFab * get_pointer_Efield_fp(int lev, int direction) const
Definition: WarpX.H:478
const amrex::MultiFab & getEfield_fp(int lev, int direction)
Definition: WarpX.H:509
const amrex::IntVect getngEB() const
Definition: WarpX.H:949
static std::string Version()
Version of WarpX executable.
Definition: WarpXVersion.cpp:14
amrex::Vector< int > getnsubsteps() const
Definition: WarpX.H:857
void PSATDVayDeposition()
Vay deposition in Fourier space (https://doi.org/10.1016/j.jcp.2013.03.010)
Definition: WarpXPushFieldsEM.cpp:417
static bool do_multi_J
Definition: WarpX.H:340
std::unique_ptr< MacroscopicProperties > m_macroscopic_properties
Definition: WarpX.H:1481
MultiDiagnostics & GetMultiDiags()
Definition: WarpX.H:103
bool DoPML() const
Definition: WarpX.H:521
const amrex::MultiFab & getcurrent_cp(int lev, int direction)
Definition: WarpX.H:501
static short rho_in_time
Definition: WarpX.H:208
void UpdateAuxilaryDataSameType()
Definition: WarpXComm.cpp:274
virtual void PostProcessBaseGrids(amrex::BoxArray &ba0) const final
Definition: WarpXInitData.cpp:86
int pml_delta
Definition: WarpX.H:1456
amrex::Vector< std::unique_ptr< amrex::FabFactory< amrex::FArrayBox > > > m_field_factory
Definition: WarpX.H:1588
bool getis_synchronized() const
Definition: WarpX.H:871
int do_pml_j_damping
Definition: WarpX.H:1458
int noy_fft
Definition: WarpX.H:1571
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_cp
Definition: WarpX.H:1436
amrex::Vector< std::unique_ptr< amrex::MultiFab > > m_distance_to_eb
Definition: WarpX.H:1424
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_slice
Definition: WarpX.H:1566
void PSATDBackwardTransformEB(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &E_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &B_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &E_cp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &B_cp)
Backward FFT of E,B on all mesh refinement levels, with field damping in the guard cells (if needed)
Definition: WarpXPushFieldsEM.cpp:123
void NodalSyncPML()
Synchronize the nodal points of the PML MultiFabs.
Definition: WarpXComm.cpp:1477
static std::string str_Ex_ext_grid_function
String storing parser function to initialize x-component of the electric field on the grid.
Definition: WarpX.H:139
void ComputeFaceExtensions()
Main function computing the cell extension. Where possible it computes one-way extensions and,...
Definition: WarpXFaceExtensions.cpp:202
static void CheckSignals()
Check and clear signal flags and asynchronously broadcast them from process 0.
Definition: WarpXEvolve.cpp:1116
amrex::Vector< amrex::Real > m_v_galilean
Definition: WarpX.H:560
void DampJPML()
Definition: WarpXEvolvePML.cpp:220
static short psatd_solution_type
Definition: WarpX.H:203
void ResetProbDomain(const amrex::RealBox &rb)
Definition: WarpXMovingWindow.cpp:636
amrex::Vector< std::unique_ptr< amrex::iMultiFab > > gather_buffer_masks
Definition: WarpX.H:1446
void updateStopTime(const amrex::Real new_stop_time)
Definition: WarpX.H:876
std::array< const amrex::MultiFab *const, 3 > get_array_Efield_aux(const int lev) const
Definition: WarpX.H:467
amrex::Vector< int > mirror_z_npoints
Definition: WarpX.H:568
static amrex::Real zmin_domain_boost_step_0
Definition: WarpX.H:323
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_slice
Definition: WarpX.H:1565
static const amrex::iMultiFab * GatherBufferMasks(int lev)
Definition: WarpX.cpp:3070
static bool do_compute_max_step_from_zmax
Definition: WarpX.H:320
static amrex::Vector< int > field_boundary_lo
Definition: WarpX.H:183
static bool sort_particles_for_deposition
If true, particles will be sorted in the order x -> y -> z -> ppc for faster deposition.
Definition: WarpX.H:335
SpectralSolverRZ & get_spectral_solver_fp(int lev)
Definition: WarpX.H:1861
static int n_field_gather_buffer
Definition: WarpX.H:349
static void shiftMF(amrex::MultiFab &mf, const amrex::Geometry &geom, int num_shift, int dir, const int lev, bool update_cost_flag, amrex::Real external_field=0.0, bool useparser=false, amrex::ParserExecutor< 3 > const &field_parser={})
Definition: WarpXMovingWindow.cpp:414
static int do_multi_J_n_depositions
Definition: WarpX.H:341
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_fp_nodal
Definition: WarpX.H:1430
void MacroscopicEvolveE(amrex::Real dt)
Definition: WarpXPushFieldsEM.cpp:1011
amrex::Vector< amrex::Real > t_new
Definition: WarpX.H:1344
static bool do_single_precision_comms
perform field communications in single precision
Definition: WarpX.H:224
amrex::IntVect slice_cr_ratio
Definition: WarpX.H:1561
void SyncCurrentAndRho()
Synchronize J and rho: filter (if used), exchange guard cells, interpolate across MR levels and apply...
Definition: WarpXEvolve.cpp:522
int field_io_nfiles
Definition: WarpX.H:1544
static amrex::Vector< ParticleBoundaryType > particle_boundary_lo
Definition: WarpX.H:193
void AddSpaceChargeFieldLabFrame()
Definition: ElectrostaticSolver.cpp:194
static amrex::Vector< amrex::Real > B_external_grid
Initial magnetic field on the grid.
Definition: WarpX.H:120
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_store
Definition: WarpX.H:1427
void prepareFields(int const step, amrex::Vector< std::string > &varnames, amrex::Vector< amrex::MultiFab > &mf_avg, amrex::Vector< const amrex::MultiFab * > &output_mf, amrex::Vector< amrex::Geometry > &output_geom) const
void CheckKnownIssues()
Checks for known numerical issues involving different WarpX modules.
guardCellManager guard_cells
Definition: WarpX.H:1555
static bool do_shared_mem_charge_deposition
used shared memory algorithm for charge deposition
Definition: WarpX.H:227
amrex::VisMF::Header::Version slice_plotfile_headerversion
Definition: WarpX.H:1539
static int em_solver_medium
Integer that corresponds to electromagnetic Maxwell solver (vacuum - 0, macroscopic - 1)
Definition: WarpX.H:174
void ComputeMagnetostaticField()
Definition: MagnetostaticSolver.cpp:59
void computeB(amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > &B, const amrex::Vector< std::unique_ptr< amrex::MultiFab > > &phi, std::array< amrex::Real, 3 > const beta={{0, 0, 0}}) const
Definition: ElectrostaticSolver.cpp:571
amrex::Real stop_time
Definition: WarpX.H:1530
MultiParticleContainer & GetPartContainer()
Definition: WarpX.H:100
static amrex::Vector< int > boost_direction
Direction of the Lorentz transform that defines the boosted frame of the simulation.
Definition: WarpX.H:312
void ComputeDt()
Definition: WarpXComputeDt.cpp:33
void PSATDSubtractCurrentPartialSumsAvg()
Subtract the average of the cumulative sums of the preliminary current D from the current J (computed...
Definition: WarpXPushFieldsEM.cpp:430
static bool use_fdtd_nci_corr
Definition: WarpX.H:281
static bool verboncoeur_axis_correction
Definition: WarpX.H:295
static amrex::Real moving_window_v
Definition: WarpX.H:935
static bool do_shared_mem_current_deposition
use shared memory algorithm for current deposition
Definition: WarpX.H:230
amrex::Vector< amrex::IntVect > do_pml_Hi
Definition: WarpX.H:1464
void setistep(int lev, int ii)
Definition: WarpX.H:861
amrex::MultiFab * get_pointer_vector_potential_fp(int lev, int direction) const
Definition: WarpX.H:486
void BuildBufferMasksInBox(const amrex::Box tbx, amrex::IArrayBox &buffer_mask, const amrex::IArrayBox &guard_mask, const int ng)
Build buffer mask within given FArrayBox.
Definition: WarpX.cpp:2927
static bool fft_do_time_averaging
Definition: WarpX.H:936
void EvolveF(amrex::Real dt, DtType dt_type)
Definition: WarpXPushFieldsEM.cpp:917
static short particle_pusher_algo
Integer that corresponds to the particle push algorithm (Boris, Vay, Higuera-Cary)
Definition: WarpX.H:166
virtual void ClearLevel(int lev) final
Delete level data. Called by AmrCore::regrid.
Definition: WarpX.cpp:1882
amrex::Vector< std::unique_ptr< PML > > pml
Definition: WarpX.H:1465
void FillBoundaryE_avg(amrex::IntVect ng)
Definition: WarpXComm.cpp:521
amrex::RealVect fine_tag_lo
Definition: WarpX.H:1547
std::string restart_chkfile
Definition: WarpX.H:1536
static WarpX * m_instance
Definition: WarpX.H:1140
const amrex::MultiFab & getG_fp(int lev)
Definition: WarpX.H:514
amrex::Vector< std::unique_ptr< amrex::MultiFab > > rho_cp
Definition: WarpX.H:1435
amrex::MultiFab * get_pointer_G_fp(int lev) const
Definition: WarpX.H:484
static amrex::RealBox getRealBox(const amrex::Box &bx, int lev)
Definition: WarpX.cpp:2679
static bool do_dynamic_scheduling
Definition: WarpX.H:328
const amrex::MultiFab & getBfield_cp(int lev, int direction)
Definition: WarpX.H:503
void ReorderFornbergCoefficients(amrex::Vector< amrex::Real > &ordered_coeffs, amrex::Vector< amrex::Real > &unordered_coeffs, const int order)
Re-orders the Fornberg coefficients so that they can be used more conveniently for finite-order cente...
Definition: WarpX.cpp:2992
void InitFromCheckpoint()
Definition: WarpXIO.cpp:94
void SumBoundaryJ(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> ¤t, const int lev, const int idim, const amrex::Periodicity &period)
Definition: WarpXComm.cpp:1150
void RestrictCurrentFromFineToCoarsePatch(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_cp, const int lev)
Fills the values of the current on the coarse patch by averaging the values of the current of the fin...
Definition: WarpXComm.cpp:1101
static std::array< amrex::Real, 3 > CellSize(int lev)
Definition: WarpX.cpp:2665
static std::string E_ext_grid_s
Initialization type for external electric field on the grid.
Definition: WarpX.H:125
amrex::Gpu::DeviceVector< amrex::Real > device_field_centering_stencil_coeffs_z
Definition: WarpX.H:1069
void AllocateCenteringCoefficients(amrex::Gpu::DeviceVector< amrex::Real > &device_centering_stencil_coeffs_x, amrex::Gpu::DeviceVector< amrex::Real > &device_centering_stencil_coeffs_y, amrex::Gpu::DeviceVector< amrex::Real > &device_centering_stencil_coeffs_z, const int centering_nox, const int centering_noy, const int centering_noz, const short a_grid_type)
Allocates and initializes the stencil coefficients used for the finite-order centering of fields and ...
Definition: WarpX.cpp:3005
amrex::MultiFab * get_pointer_phi_fp(int lev) const
Definition: WarpX.H:485
void PSATDForwardTransformEB(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &E_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &B_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &E_cp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &B_cp)
Forward FFT of E,B on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:102
static int self_fields_verbosity
Definition: WarpX.H:919
amrex::Real stopTime() const
Definition: WarpX.H:875
std::unique_ptr< amrex::Parser > Byfield_parser
User-defined parser to initialize y-component of the magnetic field on the grid.
Definition: WarpX.H:148
amrex::Vector< std::unique_ptr< PML_RZ > > pml_rz
Definition: WarpX.H:1467
void FillBoundaryE(amrex::IntVect ng, std::optional< bool > nodal_sync=std::nullopt)
Definition: WarpXComm.cpp:485
amrex::Array1D< int, 0, 2 > CountExtFaces()
Auxiliary function to count the amount of faces which still need to be extended.
Definition: WarpXFaceExtensions.cpp:166
const amrex::MultiFab & getphi_fp(int lev)
Definition: WarpX.H:512
amrex::Vector< amrex::Real > m_v_comoving
Definition: WarpX.H:563
static std::map< std::string, amrex::MultiFab * > multifab_map
Definition: WarpX.H:435
void RestoreCurrent(const int lev)
Definition: WarpX.cpp:3087
void InitializeExternalFieldsOnGridUsingParser(amrex::MultiFab *mfx, amrex::MultiFab *mfy, amrex::MultiFab *mfz, amrex::ParserExecutor< 3 > const &xfield_parser, amrex::ParserExecutor< 3 > const &yfield_parser, amrex::ParserExecutor< 3 > const &zfield_parser, std::array< std::unique_ptr< amrex::MultiFab >, 3 > const &edge_lengths, std::array< std::unique_ptr< amrex::MultiFab >, 3 > const &face_areas, const char field, const int lev, PatchType patch_type)
This function initializes the E and B fields on each level using the parser and the user-defined func...
void PSATDBackwardTransformG()
Backward FFT of G on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:242
amrex::Array< amrex::Real, 3 > m_galilean_shift
Definition: WarpX.H:561
amrex::Gpu::DeviceVector< amrex::Real > device_field_centering_stencil_coeffs_x
Definition: WarpX.H:1067
amrex::MultiFab * get_pointer_current_fp(int lev, int direction) const
Definition: WarpX.H:480
std::unique_ptr< HybridPICModel > m_hybrid_pic_model
Definition: WarpX.H:1484
void UpdateCurrentNodalToStag(amrex::MultiFab &dst, amrex::MultiFab const &src)
This function is called if warpx.do_current_centering = 1 and it centers the currents from a nodal gr...
Definition: WarpXComm.cpp:428
const amrex::IntVect get_ng_depos_rho() const
Definition: WarpX.H:953
amrex::MultiFab * get_pointer_current_cp(int lev, int direction) const
Definition: WarpX.H:490
amrex::Vector< amrex::Real > getdt() const
Definition: WarpX.H:867
static int noz
Order of the particle shape factors (splines) along z.
Definition: WarpX.H:255
amrex::Gpu::DeviceVector< amrex::Real > device_current_centering_stencil_coeffs_z
Definition: WarpX.H:1074
amrex::Vector< amrex::Real > gett_new() const
Definition: WarpX.H:864
const amrex::MultiFab & getBfield_avg_cp(int lev, int direction)
Definition: WarpX.H:519
int mffile_nstreams
Definition: WarpX.H:1543
static int num_mirrors
Definition: WarpX.H:565
std::vector< bool > getPMLdirections() const
Definition: WarpX.cpp:2856
void ApplyElectronPressureBoundary(const int lev, PatchType patch_type)
When the Ohm's law solver is used, the electron pressure values on PEC boundaries are set to enforce ...
Definition: WarpXFieldBoundaries.cpp:94
amrex::MultiFab * get_pointer_face_areas(int lev, int direction) const
Definition: WarpX.H:496
amrex::Vector< std::unique_ptr< amrex::MultiFab > > phi_fp
Definition: WarpX.H:1364
void AddMagnetostaticFieldLabFrame()
Definition: MagnetostaticSolver.cpp:71
ParticleBoundaryBuffer & GetParticleBoundaryBuffer()
Definition: WarpX.H:105
void WriteUsedInputsFile() const
void AddSpaceChargeField(WarpXParticleContainer &pc)
Definition: ElectrostaticSolver.cpp:140
void OneStep_nosub(amrex::Real t)
Definition: WarpXEvolve.cpp:417
bool do_pml_divb_cleaning
Definition: WarpX.H:1462
amrex::Vector< int > getistep() const
Definition: WarpX.H:859
static int current_centering_noy
Order of finite centering of currents (from nodal grid to staggered grid), along y.
Definition: WarpX.H:267
void ReadParameters()
Definition: WarpX.cpp:499
static void ResetInstance()
Definition: WarpX.cpp:245
static void AddToMultiFabMap(const std::string &name, const std::unique_ptr< amrex::MultiFab > &mf)
Add the MultiFab to the map of MultiFabs.
Definition: WarpX.H:444
int verbose
Definition: WarpX.H:1525
amrex::Gpu::DeviceVector< amrex::Real > device_current_centering_stencil_coeffs_y
Definition: WarpX.H:1073
static bool add_external_E_field
Whether to apply the effect of an externally-defined electric field.
Definition: WarpX.H:128
amrex::MultiFab * get_pointer_Efield_aux(int lev, int direction) const
Definition: WarpX.H:475
void AddCurrentFromFineLevelandSumBoundary(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_cp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_buffer, const int lev)
Definition: WarpXComm.cpp:1212
int MoveWindow(const int step, bool move_j)
Move the moving window.
Definition: WarpXMovingWindow.cpp:128
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_avg_cp
Definition: WarpX.H:1439
void InitLevelData(int lev, amrex::Real time)
This function initializes E, B, rho, and F, at all the levels of the multifab. rho and F are initiali...
const amrex::MultiFab & getrho_cp(int lev)
Definition: WarpX.H:504
amrex::Real load_balance_knapsack_factor
Definition: WarpX.H:1499
void setVectorPotentialBC(amrex::Vector< amrex::Array< std::unique_ptr< amrex::MultiFab >, 3 > > &A) const
Definition: MagnetostaticSolver.cpp:206
amrex::Vector< amrex::Real > load_balance_efficiency
Definition: WarpX.H:1507
static amrex::Real self_fields_required_precision
Definition: WarpX.H:916
static amrex::IntVect sort_bin_size
Definition: WarpX.H:332
static std::string str_Bx_ext_grid_function
String storing parser function to initialize x-component of the magnetic field on the grid.
Definition: WarpX.H:133
amrex::IntVect m_rho_nodal_flag
Definition: WarpX.H:360
static std::map< std::string, amrex::iMultiFab * > imultifab_map
Definition: WarpX.H:436
utils::parser::IntervalsParser load_balance_intervals
Definition: WarpX.H:1489
amrex::Vector< std::array< std::unique_ptr< amrex::iMultiFab >, 3 > > m_flag_ext_face
Definition: WarpX.H:1400
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_fp
Definition: WarpX.H:1365
static std::array< amrex::Real, 3 > LowerCorner(const amrex::Box &bx, const int lev, const amrex::Real time_shift_delta)
Return the lower corner of the box in real units.
Definition: WarpX.cpp:2687
utils::parser::IntervalsParser override_sync_intervals
Definition: WarpX.H:1522
void EvolveB(amrex::Real dt, DtType dt_type)
Definition: WarpXPushFieldsEM.cpp:795
std::unique_ptr< amrex::Parser > Bxfield_parser
User-defined parser to initialize x-component of the magnetic field on the grid.
Definition: WarpX.H:146
bool isAnyBoundaryPML()
Definition: WarpX.cpp:3097
utils::parser::IntervalsParser get_load_balance_intervals() const
returns the load balance interval
Definition: WarpX.H:675
void ComputeCostsHeuristic(amrex::Vector< std::unique_ptr< amrex::LayoutData< amrex::Real > > > &costs)
adds particle and cell contributions in cells to compute heuristic cost in each box on each level,...
Definition: WarpXRegrid.cpp:370
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > m_face_areas
EB: Areas of the mesh faces.
Definition: WarpX.H:1385
amrex::Real gett_old(int lev) const
Definition: WarpX.H:863
std::unique_ptr< amrex::Parser > Exfield_parser
User-defined parser to initialize x-component of the electric field on the grid.
Definition: WarpX.H:152
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_cax
Definition: WarpX.H:1444
amrex::MultiFab * get_pointer_F_cp(int lev) const
Definition: WarpX.H:492
const amrex::MultiFab & getF_fp(int lev)
Definition: WarpX.H:513
void StoreCurrent(const int lev)
Definition: WarpX.cpp:3076
static int do_moving_window
Definition: WarpX.H:921
virtual void MakeNewLevelFromCoarse(int, amrex::Real, const amrex::BoxArray &, const amrex::DistributionMapping &) final
Definition: WarpX.cpp:1875
amrex::Real moving_window_x
Definition: WarpX.H:1471
amrex::MultiFab * get_pointer_Efield_cp(int lev, int direction) const
Definition: WarpX.H:488
void ReadExternalFieldFromFile(std::string read_fields_from_path, amrex::MultiFab *mf, std::string F_name, std::string F_component)
static std::string str_By_ext_grid_function
String storing parser function to initialize y-component of the magnetic field on the grid.
Definition: WarpX.H:135
int maxStep() const
Definition: WarpX.H:873
static int nox
Order of the particle shape factors (splines) along x.
Definition: WarpX.H:251
int getnsubsteps(int lev) const
Definition: WarpX.H:858
static amrex::Real quantum_xi_c2
Definition: WarpX.H:664
const amrex::IntVect getngF() const
Definition: WarpX.H:950
static void GotoNextLine(std::istream &is)
Definition: WarpXIO.cpp:54
static amrex::Vector< amrex::Real > getFornbergStencilCoefficients(const int n_order, const short a_grid_type)
Returns an array of coefficients (Fornberg coefficients), corresponding to the weight of each point i...
Definition: WarpX.cpp:2949
void AllocLevelData(int lev, const amrex::BoxArray &new_grids, const amrex::DistributionMapping &new_dmap)
Definition: WarpX.cpp:1950
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_slice
Definition: WarpX.H:1567
void AverageAndPackFields(amrex::Vector< std::string > &varnames, amrex::Vector< amrex::MultiFab > &mf_avg, const amrex::IntVect ngrow) const
amrex::Vector< std::array< std::unique_ptr< amrex::iMultiFab >, 3 > > m_flag_info_face
Definition: WarpX.H:1393
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_fp_vay
Definition: WarpX.H:1366
static void AddToMultiFabMap(const std::string &name, const std::unique_ptr< amrex::iMultiFab > &mf)
Add the iMultiFab to the map of MultiFabs.
Definition: WarpX.H:454
void updateMaxStep(const int new_max_step)
Definition: WarpX.H:874
HybridPICModel & GetHybridPICModel()
Definition: WarpX.H:102
void PSATDMoveJNewToJOld()
Copy J_new to J_old in spectral space (when J is linear in time)
Definition: WarpXPushFieldsEM.cpp:577
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_cp
Definition: WarpX.H:1438
static bool serialize_initial_conditions
If true, the initial conditions from random number generators are serialized (useful for reproducible...
Definition: WarpX.H:305
const amrex::iMultiFab * getGatherBufferMasks(int lev) const
Definition: WarpX.H:1283
std::unique_ptr< amrex::Parser > Bzfield_parser
User-defined parser to initialize z-component of the magnetic field on the grid.
Definition: WarpX.H:150
void doQEDEvents()
Definition: WarpXEvolve.cpp:954
amrex::Vector< std::unique_ptr< SpectralSolverRZ > > spectral_solver_fp
Definition: WarpX.H:1847
void ApplyInverseVolumeScalingToChargeDensity(amrex::MultiFab *Rho, int lev)
Definition: WarpXPushFieldsEM.cpp:1387
static amrex::IntVect m_fill_guards_fields
Whether to fill guard cells when computing inverse FFTs of fields.
Definition: WarpX.H:239
void CopyJPML()
Copy the current J from the regular grid to the PML.
Definition: WarpXEvolvePML.cpp:340
static short grid_type
Definition: WarpX.H:357
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > vector_potential_grad_buf_b_stag
Definition: WarpX.H:1376
void NodalSyncJ(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_cp, const int lev, PatchType patch_type)
Definition: WarpXComm.cpp:1429
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_aux
Definition: WarpX.H:1357
const amrex::MultiFab & getEfield_cp(int lev, int direction)
Definition: WarpX.H:502
void PSATDCurrentCorrection()
Correct current in Fourier space so that the continuity equation is satisfied.
Definition: WarpXPushFieldsEM.cpp:404
static int current_centering_nox
Order of finite centering of currents (from nodal grid to staggered grid), along x.
Definition: WarpX.H:265
amrex::MultiFab * get_pointer_Bfield_aux(int lev, int direction) const
Definition: WarpX.H:476
static bool use_filter_compensation
If true, a compensation step is added to the bilinear filtering of charge and currents.
Definition: WarpX.H:302
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > vector_potential_grad_buf_e_stag
Definition: WarpX.H:1375
amrex::Vector< std::array< std::unique_ptr< amrex::LayoutData< FaceInfoBox > >, 3 > > m_borrowing
Definition: WarpX.H:1408
void PSATDPushSpectralFields()
Update all necessary fields in spectral space.
Definition: WarpXPushFieldsEM.cpp:547
static bool add_external_B_field
Whether to apply the effect of an externally-defined magnetic field.
Definition: WarpX.H:130
static short charge_deposition_algo
Integer that corresponds to the charge deposition algorithm (only standard deposition)
Definition: WarpX.H:162
void PushParticlesandDepose(int lev, amrex::Real cur_time, DtType a_dt_type=DtType::Full, bool skip_current=false)
Definition: WarpXEvolve.cpp:981
amrex::Real cfl
Definition: WarpX.H:1534
amrex::Real gett_new(int lev) const
Definition: WarpX.H:865
amrex::Vector< amrex::Real > dt
Definition: WarpX.H:1346
amrex::Vector< std::unique_ptr< amrex::MultiFab > > rho_slice
Definition: WarpX.H:1564
amrex::Vector< std::unique_ptr< amrex::MultiFab > > F_cp
Definition: WarpX.H:1433
void HybridPICEvolveFields()
Hybrid-PIC field evolve function. This function contains the logic involved in evolving the electric ...
Definition: WarpXPushFieldsHybridPIC.cpp:18
int nox_fft
Definition: WarpX.H:1570
void UpdateAuxilaryData()
Definition: WarpXComm.cpp:53
int particle_io_nfiles
Definition: WarpX.H:1545
bool is_synchronized
Definition: WarpX.H:1550
static WarpX & GetInstance()
Definition: WarpX.cpp:236
amrex::RealVect fine_tag_hi
Definition: WarpX.H:1548
static int start_moving_window_step
Definition: WarpX.H:922
PML_RZ * GetPML_RZ(int lev)
Definition: WarpX.cpp:2833
void PSATDForwardTransformF()
Forward FFT of F on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:180
int do_silver_mueller
Definition: WarpX.H:1454
void setPhiBC(amrex::Vector< std::unique_ptr< amrex::MultiFab > > &phi) const
Definition: ElectrostaticSolver.cpp:372
amrex::Vector< int > istep
Definition: WarpX.H:1341
static int electrostatic_solver_id
Definition: WarpX.H:913
void PrintMainPICparameters()
void FillBoundaryB(amrex::IntVect ng, std::optional< bool > nodal_sync=std::nullopt)
Definition: WarpXComm.cpp:476
void UpdatePlasmaInjectionPosition(amrex::Real dt)
Definition: WarpXMovingWindow.cpp:56
void RestrictRhoFromFineToCoarsePatch(const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_fp, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_cp, const int lev)
Definition: WarpXComm.cpp:1290
const AcceleratorLattice & get_accelerator_lattice(int lev)
Definition: WarpX.H:1081
void HandleSignals()
Complete the asynchronous broadcast of signal flags, and initiate a checkpoint if requested.
Definition: WarpXEvolve.cpp:1122
amrex::Vector< std::unique_ptr< amrex::MultiFab > > G_slice
Definition: WarpX.H:1563
static int n_current_deposition_buffer
Definition: WarpX.H:353
amrex::Vector< std::unique_ptr< amrex::MultiFab > > F_fp
Definition: WarpX.H:1361
static amrex::Vector< int > field_boundary_hi
Definition: WarpX.H:188
void UpdateAuxilaryDataStagToNodal()
Definition: WarpXComm.cpp:65
int Verbose() const
Definition: WarpX.H:94
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_cax
Definition: WarpX.H:1443
amrex::Vector< std::unique_ptr< amrex::MultiFab > > charge_buf
Definition: WarpX.H:1450
amrex::DistributionMapping GetRestartDMap(const std::string &chkfile, const amrex::BoxArray &ba, int lev) const
Definition: WarpXIO.cpp:61
std::array< const amrex::MultiFab *const, 3 > get_array_Bfield_aux(const int lev) const
Definition: WarpX.H:459
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > m_edge_lengths
EB: Lengths of the mesh edges.
Definition: WarpX.H:1383
const amrex::iMultiFab * getCurrentBufferMasks(int lev) const
Definition: WarpX.H:1280
void ShiftGalileanBoundary()
This function shifts the boundary of the grid by 'm_v_galilean*dt'. In doding so, only positions attr...
Definition: WarpXMovingWindow.cpp:585
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_avg_fp
Definition: WarpX.H:1369
amrex::Vector< int > injected_plasma_species
Definition: WarpX.H:1476
static bool do_device_synchronize
Definition: WarpX.H:343
void Evolve(int numsteps=-1)
Definition: WarpXEvolve.cpp:61
void CheckGuardCells(amrex::MultiFab const &mf)
Check that the number of guard cells is smaller than the number of valid cells, for a given MultiFab,...
static bool use_kspace_filter
If true, the bilinear filtering of charge and currents is done in Fourier space.
Definition: WarpX.H:300
amrex::MultiFab * get_pointer_F_fp(int lev) const
Definition: WarpX.H:483
int getistep(int lev) const
Definition: WarpX.H:860
std::unique_ptr< MultiDiagnostics > multi_diags
Definition: WarpX.H:1350
std::unique_ptr< amrex::Parser > Ezfield_parser
User-defined parser to initialize z-component of the electric field on the grid.
Definition: WarpX.H:156
static int noy
Order of the particle shape factors (splines) along y.
Definition: WarpX.H:253
void EvolveEM(int numsteps)
amrex::Vector< int > nsubsteps
Definition: WarpX.H:1342
void ComputeMaxStep()
Compute the last time step of the simulation Calls computeMaxStepBoostAccelerator() if required.
void SyncRho()
Definition: WarpXComm.cpp:1019
int noz_fft
Definition: WarpX.H:1572
void PSATDForwardTransformRho(const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_fp, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_cp, const int icomp, const int dcomp, const bool apply_kspace_filter=true)
Forward FFT of rho on all mesh refinement levels, with k-space filtering (if needed)
Definition: WarpXPushFieldsEM.cpp:368
void ApplyFilterJ(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> ¤t, const int lev, const int idim)
Definition: WarpXComm.cpp:1123
static int field_centering_noz
Order of finite centering of fields (from staggered grid to nodal grid), along z.
Definition: WarpX.H:262
void sett_new(int lev, amrex::Real time)
Definition: WarpX.H:866
void computePhiTriDiagonal(const amrex::Vector< std::unique_ptr< amrex::MultiFab > > &rho, amrex::Vector< std::unique_ptr< amrex::MultiFab > > &phi) const
Definition: ElectrostaticSolver.cpp:680
amrex::Real load_balance_efficiency_ratio_threshold
Definition: WarpX.H:1505
void PSATDBackwardTransformEBavg(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &E_avg_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &B_avg_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &E_avg_cp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &B_avg_cp)
Backward FFT of averaged E,B on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:154
void DampPML()
Definition: WarpXEvolvePML.cpp:43
static std::string PicsarVersion()
Version of PICSAR dependency.
Definition: WarpXVersion.cpp:27
static amrex::Real beta_boost
Beta value corresponding to the Lorentz factor of the boosted frame of the simulation.
Definition: WarpX.H:310
void FillBoundaryAux(amrex::IntVect ng)
Definition: WarpXComm.cpp:836
void PSATDBackwardTransformJ(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_cp)
Backward FFT of J on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:332
void FillBoundaryB_avg(amrex::IntVect ng)
Definition: WarpXComm.cpp:512
void ShrinkBorrowing()
Shrink the vectors in the FaceInfoBoxes.
Definition: WarpXFaceExtensions.cpp:739
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_fp_external
Definition: WarpX.H:1379
void ComputeDivE(amrex::MultiFab &divE, const int lev)
Definition: WarpX.cpp:2817
amrex::MultiFab * get_pointer_G_cp(int lev) const
Definition: WarpX.H:493
void InitializeEBGridData(int lev)
This function initializes and calculates grid quantities used along with EBs such as edge lengths,...
void CheckGuardCells()
Check that the number of guard cells is smaller than the number of valid cells, for all available Mul...
static bool do_divb_cleaning
Solve additional Maxwell equation for G in order to control errors in magnetic Gauss' law.
Definition: WarpX.H:248
void NodalSyncRho(const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_fp, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_cp, const int lev, PatchType patch_type, const int icomp, const int ncomp)
Definition: WarpXComm.cpp:1453
WarpX()
Definition: WarpX.cpp:251
const amrex::IntVect get_ng_depos_J() const
Definition: WarpX.H:952
int load_balance_with_sfc
Definition: WarpX.H:1494
amrex::Real getLoadBalanceEfficiency(const int lev)
Definition: WarpX.H:543
std::unique_ptr< MultiParticleContainer > mypc
Definition: WarpX.H:1349
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > current_buf
Definition: WarpX.H:1449
static bool use_filter
If true, a bilinear filter is used to smooth charge and currents.
Definition: WarpX.H:298
amrex::MultiFab * get_pointer_rho_fp(int lev) const
Definition: WarpX.H:482
static amrex::IntVect m_fill_guards_current
Whether to fill guard cells when computing inverse FFTs of currents.
Definition: WarpX.H:242
MacroscopicProperties & GetMacroscopicProperties()
Definition: WarpX.H:101
MagnetostaticSolver::VectorPoissonBoundaryHandler m_vector_poisson_boundary_handler
Definition: WarpX.H:990
const amrex::MultiFab & getG_cp(int lev)
Definition: WarpX.H:506
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > vector_potential_fp_nodal
Definition: WarpX.H:1374
ElectrostaticSolver::PoissonBoundaryHandler m_poisson_boundary_handler
Definition: WarpX.H:965
static amrex::IntVect shared_tilesize
tileSize to use for shared current deposition operations
Definition: WarpX.H:236
static int do_similar_dm_pml
Definition: WarpX.H:1460
static std::string str_Ey_ext_grid_function
String storing parser function to initialize y-component of the electric field on the grid.
Definition: WarpX.H:141
amrex::Vector< std::unique_ptr< FiniteDifferenceSolver > > m_fdtd_solver_fp
Definition: WarpX.H:1868
void ApplyInverseVolumeScalingToCurrentDensity(amrex::MultiFab *Jx, amrex::MultiFab *Jy, amrex::MultiFab *Jz, int lev)
Definition: WarpXPushFieldsEM.cpp:1214
amrex::Vector< amrex::Real > gett_old() const
Definition: WarpX.H:862
static int current_centering_noz
Order of finite centering of currents (from nodal grid to staggered grid), along z.
Definition: WarpX.H:269
static bool safe_guard_cells
Definition: WarpX.H:344
void PSATDScaleAverageFields(const amrex::Real scale_factor)
Scale averaged E,B fields to account for time integration.
Definition: WarpXPushFieldsEM.cpp:623
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_cp
Definition: WarpX.H:1437
amrex::Vector< std::unique_ptr< amrex::MultiFab > > rho_fp
Definition: WarpX.H:1363
int slice_plot_int
Definition: WarpX.H:1559
amrex::MultiFab * get_pointer_rho_cp(int lev) const
Definition: WarpX.H:491
void InitEB()
Definition: WarpXInitEB.cpp:81
void BackwardCompatibility()
Definition: WarpX.cpp:1624
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_fp
Definition: WarpX.H:1368
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > ECTRhofield
Definition: WarpX.H:1417
void ApplyEfieldBoundary(const int lev, PatchType patch_type)
Definition: WarpXFieldBoundaries.cpp:21
int num_injected_species
Definition: WarpX.H:1475
void AllocLevelSpectralSolverRZ(amrex::Vector< std::unique_ptr< SpectralSolverRZ >> &spectral_solver, const int lev, const amrex::BoxArray &realspace_ba, const amrex::DistributionMapping &dm, const std::array< amrex::Real, 3 > &dx)
Definition: WarpX.cpp:2575
amrex::Vector< amrex::Real > t_old
Definition: WarpX.H:1345
static amrex::IntVect sort_idx_type
Specifies the type of grid used for the above sorting, i.e. cell-centered, nodal, or mixed.
Definition: WarpX.H:337
int regrid_int
Definition: WarpX.H:1532
bool use_single_write
Definition: WarpX.H:1542
static void AllocInitMultiFab(std::unique_ptr< amrex::MultiFab > &mf, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm, const int ncomp, const amrex::IntVect &ngrow, const int level, const std::string &name, std::optional< const amrex::Real > initial_value={})
Allocate and optionally initialize the MultiFab. This also adds the MultiFab to the map of MultiFabs ...
Definition: WarpX.cpp:3115
static bool refine_plasma
Definition: WarpX.H:329
amrex::FabFactory< amrex::FArrayBox > const & fieldFactory(int lev) const noexcept
Definition: WarpX.H:1590
static int macroscopic_solver_algo
Definition: WarpX.H:178
bool use_single_read
Definition: WarpX.H:1541
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_aux
Definition: WarpX.H:1358
amrex::IntVect numprocs
Domain decomposition on Level 0.
Definition: WarpX.H:1575
static int ncomps
Definition: WarpX.H:277
static int moving_window_active(int const step)
Definition: WarpX.H:929
void PSATDForwardTransformG()
Forward FFT of G on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:226
const bool sync_nodal_points
Definition: WarpX.H:1553
void DampPML_Cartesian(const int lev, PatchType patch_type)
Definition: WarpXEvolvePML.cpp:76
const amrex::IntVect getngUpdateAux() const
Definition: WarpX.H:951
int warpx_do_continuous_injection
Definition: WarpX.H:1474
static bool galerkin_interpolation
Definition: WarpX.H:291
static std::string str_Ez_ext_grid_function
String storing parser function to initialize z-component of the electric field on the grid.
Definition: WarpX.H:143
int do_pml_in_domain
Definition: WarpX.H:1459
void PSATDForwardTransformJ(const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_fp, const amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 >> &J_cp, const bool apply_kspace_filter=true)
Forward FFT of J on all mesh refinement levels, with k-space filtering (if needed)
Definition: WarpXPushFieldsEM.cpp:271
amrex::Vector< std::unique_ptr< NCIGodfreyFilter > > nci_godfrey_filter_bxbyez
Definition: WarpX.H:557
virtual void ErrorEst(int lev, amrex::TagBoxArray &tags, amrex::Real time, int) final
Tagging cells for refinement.
Definition: WarpXTagging.cpp:28
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > m_area_mod
Definition: WarpX.H:1404
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, const bool aux_is_nodal)
Definition: WarpX.cpp:2030
void PrintDtDxDyDz()
Definition: WarpXComputeDt.cpp:102
virtual void MakeNewLevelFromScratch(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) final
Definition: WarpX.cpp:1866
static amrex::IntVect filter_npass_each_dir
Definition: WarpX.H:554
const amrex::MultiFab & getBfield_fp(int lev, int direction)
Definition: WarpX.H:510
void ComputeDistanceToEB()
Compute the length of the mesh edges. Here the length is a value in [0, 1]. An edge of length 0 is fu...
Definition: WarpXInitEB.cpp:408
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Venl
Definition: WarpX.H:1421
void setLoadBalanceEfficiency(const int lev, const amrex::Real efficiency)
Definition: WarpX.H:532
static short electromagnetic_solver_id
Integer that corresponds to the type of Maxwell solver (Yee, CKC, PSATD, ECT)
Definition: WarpX.H:168
PML * GetPML(int lev)
Definition: WarpX.cpp:2845
amrex::Real v_particle_pml
Definition: WarpX.H:1469
void OneStep_sub1(amrex::Real t)
Definition: WarpXEvolve.cpp:778
BilinearFilter bilinear_filter
Definition: WarpX.H:555
void FillBoundaryF(amrex::IntVect ng, std::optional< bool > nodal_sync=std::nullopt)
Definition: WarpXComm.cpp:494
amrex::MultiFab * get_pointer_current_fp_nodal(int lev, int direction) const
Definition: WarpX.H:481
bool fft_periodic_single_box
Definition: WarpX.H:1569
const amrex::MultiFab & getEfield_avg_fp(int lev, int direction)
Definition: WarpX.H:516
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_avg_fp
Definition: WarpX.H:1370
const amrex::MultiFab & getBfield_avg_fp(int lev, int direction)
Definition: WarpX.H:517
static amrex::LayoutData< amrex::Real > * getCosts(int lev)
Definition: WarpX.cpp:2874
void AddRhoFromFineLevelandSumBoundary(const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_fp, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_cp, const amrex::Vector< std::unique_ptr< amrex::MultiFab >> &charge_buffer, const int lev, const int icomp, const int ncomp)
Definition: WarpXComm.cpp:1348
void PushPSATD()
Definition: WarpXPushFieldsEM.cpp:650
static int field_centering_noy
Order of finite centering of fields (from staggered grid to nodal grid), along y.
Definition: WarpX.H:260
int do_pml
Definition: WarpX.H:1453
static std::string str_Bz_ext_grid_function
String storing parser function to initialize z-component of the magnetic field on the grid.
Definition: WarpX.H:137
amrex::Real getdt(int lev) const
Definition: WarpX.H:868
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_fp_external
Definition: WarpX.H:1380
static amrex::IntVect RefRatio(int lev)
Definition: WarpX.cpp:2737
int max_step
Definition: WarpX.H:1529
void ApplyBfieldBoundary(const int lev, PatchType patch_type, DtType dt_type)
Definition: WarpXFieldBoundaries.cpp:46
void EvolveG(amrex::Real dt, DtType dt_type)
Definition: WarpXPushFieldsEM.cpp:967
const amrex::MultiFab & getEfield_avg_cp(int lev, int direction)
Definition: WarpX.H:518
amrex::Real costs_heuristic_particles_wt
Definition: WarpX.H:1519
int pml_has_particles
Definition: WarpX.H:1457
amrex::Vector< std::unique_ptr< NCIGodfreyFilter > > nci_godfrey_filter_exeybz
Definition: WarpX.H:556
static bool do_current_centering
Definition: WarpX.H:213
amrex::Vector< amrex::Real > mirror_z
Definition: WarpX.H:566
amrex::Vector< std::unique_ptr< amrex::MultiFab > > F_slice
Definition: WarpX.H:1562
int getdo_moving_window() const
Definition: WarpX.H:869
static bool do_subcycling
Definition: WarpX.H:339
int pml_ncell
Definition: WarpX.H:1455
static void ComputeDivB(amrex::MultiFab &divB, int const dcomp, const std::array< const amrex::MultiFab *const, 3 > &B, const std::array< amrex::Real, 3 > &dx)
Definition: WarpX.cpp:2743
static void AliasInitMultiFab(std::unique_ptr< amrex::MultiFab > &mf, const amrex::MultiFab &mf_to_alias, const int scomp, const int ncomp, const int level, const std::string &name, std::optional< const amrex::Real > initial_value)
Create an alias of a MultiFab, adding the alias to the MultiFab map.
Definition: WarpX.cpp:3155
static int n_rz_azimuthal_modes
Number of modes for the RZ multi-mode version.
Definition: WarpX.H:272
static short J_in_time
Definition: WarpX.H:207
void PSATDBackwardTransformF()
Backward FFT of F on all mesh refinement levels.
Definition: WarpXPushFieldsEM.cpp:196
~WarpX()
Definition: WarpX.cpp:490
static amrex::Real gamma_boost
Lorentz factor of the boosted frame in which a boosted-frame simulation is run.
Definition: WarpX.H:308
static short field_gathering_algo
Integer that corresponds to the field gathering algorithm (energy-conserving, momentum-conserving)
Definition: WarpX.H:164
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Bfield_avg_cp
Definition: WarpX.H:1440
static int shared_mem_current_tpb
number of threads to use per block in shared deposition
Definition: WarpX.H:233
static short load_balance_costs_update_algo
Definition: WarpX.H:172
amrex::MultiFab * get_pointer_Bfield_fp(int lev, int direction) const
Definition: WarpX.H:479
amrex::Vector< std::unique_ptr< FiniteDifferenceSolver > > m_fdtd_solver_cp
Definition: WarpX.H:1869
void ResetCosts()
resets costs to zero
Definition: WarpXRegrid.cpp:400
void InitBorrowing()
Initialize the memory for the FaceInfoBoxes.
Definition: WarpXFaceExtensions.cpp:277
void computeMaxStepBoostAccelerator()
void OneStep_multiJ(const amrex::Real t)
Perform one PIC iteration, with the multiple J deposition per time step.
Definition: WarpXEvolve.cpp:591
amrex::Vector< amrex::Real > mirror_z_width
Definition: WarpX.H:567
const amrex::MultiFab & getcurrent_fp(int lev, int direction)
Definition: WarpX.H:508
std::unique_ptr< MultiReducedDiags > reduced_diags
object with all reduced diagnotics, similar to MultiParticleContainer for species.
Definition: WarpX.H:571
const amrex::MultiFab & getBfield(int lev, int direction)
Definition: WarpX.H:499
void ApplyBCKCorrection(const int idim)
Whenever an unstable cell cannot be extended we increase its area to be the minimal for stability....
Definition: WarpXFaceExtensions.cpp:706
const amrex::MultiFab & getF_cp(int lev)
Definition: WarpX.H:505
amrex::Vector< std::unique_ptr< amrex::iMultiFab > > current_buffer_masks
Definition: WarpX.H:1445
const amrex::IntVect get_numprocs() const
Definition: WarpX.H:963
amrex::MultiFab * get_pointer_Bfield_cp(int lev, int direction) const
Definition: WarpX.H:489
int slice_max_grid_size
Definition: WarpX.H:1558
static std::string B_ext_grid_s
Initialization type for external magnetic field on the grid.
Definition: WarpX.H:123
void PSATDEraseAverageFields()
Set averaged E,B fields to zero before new iteration.
Definition: WarpXPushFieldsEM.cpp:597
virtual void RemakeLevel(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) final
Definition: WarpXRegrid.cpp:162
amrex::Vector< std::unique_ptr< amrex::MultiFab > > G_cp
Definition: WarpX.H:1434
void FillBoundaryG(amrex::IntVect ng, std::optional< bool > nodal_sync=std::nullopt)
Definition: WarpXComm.cpp:503
const amrex::MultiFab & getEfield(int lev, int direction)
Definition: WarpX.H:498
void ComputeEightWaysExtensions()
Do the eight-ways extension.
Definition: WarpXFaceExtensions.cpp:548
void ApplyFilterandSumBoundaryRho(int lev, int glev, amrex::MultiFab &rho, int icomp, int ncomp)
Definition: WarpXComm.cpp:1317
std::unique_ptr< amrex::Parser > Eyfield_parser
User-defined parser to initialize y-component of the electric field on the grid.
Definition: WarpX.H:154
static amrex::Real self_fields_absolute_tolerance
Definition: WarpX.H:917
amrex::Vector< std::unique_ptr< AcceleratorLattice > > m_accelerator_lattice
Definition: WarpX.H:1581
void EvolveE(amrex::Real dt)
Definition: WarpXPushFieldsEM.cpp:844
static amrex::Vector< ParticleBoundaryType > particle_boundary_hi
Definition: WarpX.H:198
std::optional< amrex::Real > m_const_dt
Definition: WarpX.H:1478
static std::array< amrex::Real, 3 > UpperCorner(const amrex::Box &bx, const int lev, const amrex::Real time_shift_delta)
Return the upper corner of the box in real units.
Definition: WarpX.cpp:2712
void ComputeOneWayExtensions()
Do the one-way extension.
Definition: WarpXFaceExtensions.cpp:424
void Hybrid_QED_Push(amrex::Vector< amrex::Real > dt)
Definition: WarpX_QED_Field_Pushers.cpp:46
FiniteDifferenceSolver * get_pointer_fdtd_solver_fp(int lev)
Definition: WarpX.H:1865
amrex::RealBox slice_realbox
Definition: WarpX.H:1560
amrex::Vector< amrex::IntVect > do_pml_Lo
Definition: WarpX.H:1463
void applyMirrors(amrex::Real time)
Definition: WarpXEvolve.cpp:1046
amrex::Vector< std::unique_ptr< SpectralSolverRZ > > spectral_solver_cp
Definition: WarpX.H:1848
amrex::Real getmoving_window_x() const
Definition: WarpX.H:870
amrex::Real costs_heuristic_cells_wt
Definition: WarpX.H:1513
static amrex::Vector< amrex::Real > E_external_grid
Initial electric field on the grid.
Definition: WarpX.H:118
bool do_pml_dive_cleaning
Definition: WarpX.H:1461
static std::string authors
Author of an input file / simulation setup.
Definition: WarpX.H:115
amrex::VisMF::Header::Version plotfile_headerversion
Definition: WarpX.H:1538
void AddBoundaryField()
Definition: ElectrostaticSolver.cpp:100
const PML_RZ * getPMLRZ()
Definition: WarpX.H:524
void ApplyRhofieldBoundary(const int lev, amrex::MultiFab *Rho, PatchType patch_type)
If a PEC boundary conditions is used the charge density deposited in the guard cells have to be refle...
Definition: WarpXFieldBoundaries.cpp:81
static bool compute_max_step_from_btd
If true, the code will compute max_step from the back transformed diagnostics.
Definition: WarpX.H:326
void computeE(amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > &E, const amrex::Vector< std::unique_ptr< amrex::MultiFab > > &phi, std::array< amrex::Real, 3 > const beta={{0, 0, 0}}) const
Definition: ElectrostaticSolver.cpp:453
bool current_correction
If true, a correction is applied to the current in Fourier space,.
Definition: WarpX.H:217
static const amrex::iMultiFab * CurrentBufferMasks(int lev)
Definition: WarpX.cpp:3064
static int end_moving_window_step
Definition: WarpX.H:923
static utils::parser::IntervalsParser sort_intervals
Definition: WarpX.H:331
void computeVectorPotential(const amrex::Vector< amrex::Array< std::unique_ptr< amrex::MultiFab >, 3 > > &curr, amrex::Vector< amrex::Array< std::unique_ptr< amrex::MultiFab >, 3 > > &A, amrex::Real const required_precision=amrex::Real(1.e-11), amrex::Real absolute_tolerance=amrex::Real(0.0), const int max_iters=200, const int verbosity=2) const
Definition: MagnetostaticSolver.cpp:142
amrex::Vector< std::array< std::unique_ptr< amrex::MultiFab >, 3 > > Efield_fp
Definition: WarpX.H:1367
void ApplyJfieldBoundary(const int lev, amrex::MultiFab *Jx, amrex::MultiFab *Jy, amrex::MultiFab *Jz, PatchType patch_type)
If a PEC boundary conditions is used the current density deposited in the guard cells have to be refl...
Definition: WarpXFieldBoundaries.cpp:87
bool update_with_rho
Definition: WarpX.H:221
void HybridPICDepositInitialRhoAndJ()
Hybrid-PIC initial deposition function. The hybrid-PIC algorithm uses the charge and current density ...
Definition: WarpXPushFieldsHybridPIC.cpp:171
void LoadBalance()
perform load balance; compute and communicate new amrex::DistributionMapping
Definition: WarpXRegrid.cpp:52
amrex::Real time_of_last_gal_shift
Definition: WarpX.H:559
Definition: WarpXParticleContainer.H:105
This class computes and stores the number of guard cells needed for the allocation of the MultiFabs a...
Definition: GuardCellManager.H:20
amrex::IntVect ng_depos_rho
Definition: GuardCellManager.H:108
amrex::IntVect ng_depos_J
Definition: GuardCellManager.H:107
amrex::IntVect ng_alloc_F
Definition: GuardCellManager.H:85
amrex::IntVect ng_alloc_EB
Definition: GuardCellManager.H:79
amrex::IntVect ng_UpdateAux
Definition: GuardCellManager.H:100
amrex::IntVect ng_FieldGather
Definition: GuardCellManager.H:98
This class is a parser for multiple slices of the form x,y,z,... where x, y and z are slices of the f...
Definition: IntervalsParser.H:103
direction
Definition: AnyFFT.H:75
ii
Definition: check_interp_points_and_weights.py:148
cell_size
Definition: compute_domain.py:37
int dx
Definition: stencil.py:436
string name
Definition: stencil.py:452
string field
Definition: video_yt.py:31