guardCellManager Class Reference

This class computes and stores the number of guard cells needed for the allocation of the MultiFabs and required for each part of the PIC loop. More...

#include <GuardCellManager.H>

Public Member Functions
void	Init (const bool do_subcycling, const bool do_fdtd_nci_corr, const bool do_nodal, const bool do_moving_window, const bool aux_is_nodal, const int moving_window_dir, const int nox, const int nox_fft, const int noy_fft, const int noz_fft, const int nci_corr_stencil, const int maxwell_solver_id, const int max_level, const amrex::Array< amrex::Real, 3 > v_galilean, const bool safe_guard_cells)
	Initialize number of guard cells depending on the options used. More...

Public Attributes
amrex::IntVect	ng_alloc_EB = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_alloc_J = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_alloc_Rho = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_alloc_F = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_FieldSolver = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_FieldSolverF = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_FieldGather = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_UpdateAux = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_MovingWindow = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_Extra = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_depos_J = amrex::IntVect::TheZeroVector()
amrex::IntVect	ng_depos_rho = amrex::IntVect::TheZeroVector()

Detailed Description

This class computes and stores the number of guard cells needed for the allocation of the MultiFabs and required for each part of the PIC loop.

Member Function Documentation

Init()

void guardCellManager::Init	(	const bool	do_subcycling,
		const bool	do_fdtd_nci_corr,
		const bool	do_nodal,
		const bool	do_moving_window,
		const bool	aux_is_nodal,
		const int	moving_window_dir,
		const int	nox,
		const int	nox_fft,
		const int	noy_fft,
		const int	noz_fft,
		const int	nci_corr_stencil,
		const int	maxwell_solver_id,
		const int	max_level,
		const amrex::Array< amrex::Real, 3 >	v_galilean,
		const bool	safe_guard_cells
	)

Initialize number of guard cells depending on the options used.

Parameters

do_subcycling	bool, whether to use subcycling
do_fdtd_nci_corr	bool, whether to use Godfrey NCI corrector
do_nodal	bool, whether the field solver is nodal
do_moving_window	bool, whether to use moving window
aux_is_nodal	bool, true if the aux grid is nodal
moving_window_dir	direction of moving window
nox	order of current deposition
nox_fft	order of PSATD in x direction
noy_fft	order of PSATD in y direction
noz_fft	order of PSATD in z direction
nci_corr_stencil	stencil of NCI corrector
maxwell_solver_id	if of Maxwell solver
max_level	max level of the simulation

Member Data Documentation

ng_alloc_EB

amrex::IntVect guardCellManager::ng_alloc_EB = amrex::IntVect::TheZeroVector()

ng_alloc_F

amrex::IntVect guardCellManager::ng_alloc_F = amrex::IntVect::TheZeroVector()

ng_alloc_J

amrex::IntVect guardCellManager::ng_alloc_J = amrex::IntVect::TheZeroVector()

ng_alloc_Rho

amrex::IntVect guardCellManager::ng_alloc_Rho = amrex::IntVect::TheZeroVector()

ng_depos_J

amrex::IntVect guardCellManager::ng_depos_J = amrex::IntVect::TheZeroVector()

ng_depos_rho

amrex::IntVect guardCellManager::ng_depos_rho = amrex::IntVect::TheZeroVector()

ng_Extra

amrex::IntVect guardCellManager::ng_Extra = amrex::IntVect::TheZeroVector()

ng_FieldGather

amrex::IntVect guardCellManager::ng_FieldGather = amrex::IntVect::TheZeroVector()

ng_FieldSolver

amrex::IntVect guardCellManager::ng_FieldSolver = amrex::IntVect::TheZeroVector()

ng_FieldSolverF

amrex::IntVect guardCellManager::ng_FieldSolverF = amrex::IntVect::TheZeroVector()

ng_MovingWindow

amrex::IntVect guardCellManager::ng_MovingWindow = amrex::IntVect::TheZeroVector()

ng_UpdateAux

amrex::IntVect guardCellManager::ng_UpdateAux = amrex::IntVect::TheZeroVector()

---

The documentation for this class was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/20.10/Source/Parallelization/GuardCellManager.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/20.10/Source/Parallelization/GuardCellManager.cpp