aboutsummaryrefslogtreecommitdiff
path: root/Source/Parallelization/WarpXSumGuardCells.H
blob: b9789b45ca45b92786d13e4bc0e68387cae8f0ee (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/* Copyright 2019 Maxence Thevenet, Remi Lehe, Weiqun Zhang
 *
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_SUM_GUARD_CELLS_H_
#define WARPX_SUM_GUARD_CELLS_H_

#include <AMReX_MultiFab.H>

/** \brief Sum the values of `mf`, where the different boxes overlap
 * (i.e. in the guard cells)
 *
 * This is typically called for the sources of the Maxwell equations (J/rho)
 * after deposition from the macroparticles.
 *
 *  - When WarpX is used with a finite-difference scheme: this only
 *    updates the *valid* cells of `mf`
 *  - When WarpX is used with a spectral scheme (PSATD): this
 *    updates both the *valid* cells and *guard* cells. (This is because a
 *    spectral solver requires the value of the sources over a large stencil.)
 */
inline void
WarpXSumGuardCells(amrex::MultiFab& mf, const amrex::Periodicity& period,
                   const int icomp=0, const int ncomp=1)
{
    amrex::IntVect n_updated_guards;

    // Update both valid cells and guard cells
    if (WarpX::maxwell_solver_id == MaxwellSolverAlgo::PSATD)
        n_updated_guards = mf.nGrowVect();
    else  // Update only the valid cells
        n_updated_guards = amrex::IntVect::TheZeroVector();
    mf.SumBoundary(icomp, ncomp, n_updated_guards, period);
}

/** \brief Sum the values of `src` where the different boxes overlap
 * (i.e. in the guard cells) and copy them into `dst`
 *
 * This is typically called for the sources of the Maxwell equations (J/rho)
 * after deposition from the macroparticles + filtering.
 *
 *  - When WarpX is used with a finite-difference scheme: this only
 *    updates the *valid* cells of `dst`
 *  - When WarpX is used with a spectral scheme (PSATD): this
 *    updates both the *valid* cells and *guard* cells. (This is because a
 *    spectral solver requires the value of the sources over a large stencil.)
 *
 * Note: `i_comp` is the component where the results will be stored in `dst`;
 *       The component from which we copy in `src` is always 0.
 */
inline void
WarpXSumGuardCells(amrex::MultiFab& dst, amrex::MultiFab& src,
                   const amrex::Periodicity& period,
                   const int icomp=0, const int ncomp=1)
{
    amrex::IntVect n_updated_guards;

    // Update both valid cells and guard cells
    if (WarpX::maxwell_solver_id == MaxwellSolverAlgo::PSATD)
        n_updated_guards = dst.nGrowVect();
    else  // Update only the valid cells
        n_updated_guards = amrex::IntVect::TheZeroVector();

    src.SumBoundary(0, ncomp, n_updated_guards, period);
    amrex::Copy( dst, src, 0, icomp, ncomp, n_updated_guards );
}

#endif // WARPX_SUM_GUARD_CELLS_H_