GuardCellManager.H

Go to the documentation of this file.

/* Copyright 2019-2020 Maxence Thevenet
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_GUARDCELLMANAGER_H_
#define WARPX_GUARDCELLMANAGER_H_
 
#include <Utils/WarpXAlgorithmSelection.H>
#include <ablastr/utils/Enums.H>
 
#include <AMReX_Array.H>
#include <AMReX_IntVect.H>
#include <AMReX_REAL.H>
#include <AMReX_RealVect.H>
#include <AMReX_Vector.H>

class guardCellManager{
 
public:

    void Init(
        amrex::Real dt,
        const amrex::Real * dx,
        bool do_subcycling,
        bool do_fdtd_nci_corr,
        ablastr::utils::enums::GridType grid_type,
        bool do_moving_window,
        int moving_window_dir,
        int particle_max_grid_crossings,
        int nox,
        int nox_fft, int noy_fft, int noz_fft,
        int nci_corr_stencil,
        ElectromagneticSolverAlgo electromagnetic_solver_id,
        EvolveScheme evolve_scheme,
        int max_level,
        const amrex::Vector<amrex::Real>& v_galilean,
        const amrex::Vector<amrex::Real>& v_comoving,
        bool safe_guard_cells,
        int do_psatd_JRhom,
        bool fft_do_time_averaging,
        bool do_pml,
        int do_pml_in_domain,
        int pml_ncell,
        const amrex::Vector<amrex::IntVect>& ref_ratios,
        bool use_filter,
        const amrex::IntVect& bilinear_filter_stencil_length);
 
    // Guard cells allocated for MultiFabs E and B
    amrex::IntVect ng_alloc_EB = amrex::IntVect::TheZeroVector();
    // Guard cells allocated for MultiFab J
    amrex::IntVect ng_alloc_J = amrex::IntVect::TheZeroVector();
    // Guard cells allocated for MultiFab Rho
    amrex::IntVect ng_alloc_Rho = amrex::IntVect::TheZeroVector();
    // Guard cells allocated for MultiFab F
    amrex::IntVect ng_alloc_F = amrex::IntVect::TheZeroVector();
    // Guard cells allocated for MultiFab G
    amrex::IntVect ng_alloc_G = amrex::IntVect::TheZeroVector();
 
    // Guard cells exchanged for specific parts of the PIC loop
 
    // Number of guard cells of E and B that must exchanged before Field Solver
    amrex::IntVect ng_FieldSolver = amrex::IntVect::TheZeroVector();
    // Number of guard cells of F that must exchanged before Field Solver
    amrex::IntVect ng_FieldSolverF = amrex::IntVect::TheZeroVector();
    // Number of guard cells of G that must be exchanged before Field Solver
    amrex::IntVect ng_FieldSolverG = amrex::IntVect::TheZeroVector();
    // Number of guard cells of E and B that must exchanged before Field Gather
    amrex::IntVect ng_FieldGather = amrex::IntVect::TheZeroVector();
    // Number of guard cells of E and B that must exchanged before updating the Aux grid
    amrex::IntVect ng_UpdateAux = amrex::IntVect::TheZeroVector();
    // Number of guard cells of all MultiFabs that must exchanged before moving window
    amrex::IntVect ng_MovingWindow = amrex::IntVect::TheZeroVector();
    // Number of guard cells of E and B that are exchanged immediately after the main PSATD push
    amrex::IntVect ng_afterPushPSATD = amrex::IntVect::TheZeroVector();
 
    // Number of guard cells for local deposition of J and rho
    amrex::IntVect ng_depos_J   = amrex::IntVect::TheZeroVector();
    amrex::IntVect ng_depos_rho = amrex::IntVect::TheZeroVector();
};
 
#endif // WARPX_GUARDCELLMANAGER_H_