Classes
class	VarianceAccumulationBuffer

Enumerations
enum class	TemperatureDepositionType : int { SINGLE_PASS , DOUBLE_PASS }

enum class	TemperatureDepositionPass : int { FIRST , SECOND }

Functions
AMREX_GPU_HOST_DEVICE AMREX_INLINE void	varianceDepositionSubKernel (amrex::ParticleReal vx, amrex::ParticleReal vy, amrex::ParticleReal vz, const amrex::IntVectND< 3 > &ixv, const amrex::IntVectND< 3 > &iyv, const amrex::IntVectND< 3 > &izv, amrex::Real wpx_var, amrex::Real wpy_var, amrex::Real wpz_var, const amrex::Array4< int > &nx_arr, const amrex::Array4< int > &ny_arr, const amrex::Array4< int > &nz_arr, const amrex::Array4< amrex::Real > &wx_arr, const amrex::Array4< amrex::Real > &wy_arr, const amrex::Array4< amrex::Real > &wz_arr, const amrex::Array4< amrex::Real > &w2x_arr, const amrex::Array4< amrex::Real > &w2y_arr, const amrex::Array4< amrex::Real > &w2z_arr, const amrex::Array4< amrex::Real > &vxbar_arr, const amrex::Array4< amrex::Real > &vybar_arr, const amrex::Array4< amrex::Real > &vzbar_arr, const TemperatureDepositionType type, const TemperatureDepositionPass pass)

template<int depos_order>
AMREX_GPU_HOST_DEVICE AMREX_INLINE void	doVarianceDepositionShapeNKernel (const amrex::ParticleReal xp, const amrex::ParticleReal yp, const amrex::ParticleReal zp, const amrex::ParticleReal wp, const amrex::ParticleReal vx, const amrex::ParticleReal vy, const amrex::ParticleReal vz, const amrex::Array4< int > &nx_arr, const amrex::Array4< int > &ny_arr, const amrex::Array4< int > &nz_arr, const amrex::Array4< amrex::Real > &wx_arr, const amrex::Array4< amrex::Real > &wy_arr, const amrex::Array4< amrex::Real > &wz_arr, const amrex::Array4< amrex::Real > &w2x_arr, const amrex::Array4< amrex::Real > &w2y_arr, const amrex::Array4< amrex::Real > &w2z_arr, const amrex::Array4< amrex::Real > &vxbar_arr, const amrex::Array4< amrex::Real > &vybar_arr, const amrex::Array4< amrex::Real > &vzbar_arr, const amrex::IntVect &varx_type, const amrex::IntVect &vary_type, const amrex::IntVect &varz_type, const TemperatureDepositionType type, const TemperatureDepositionPass pass, const amrex::Real relative_time, const amrex::XDim3 &dinv, const amrex::XDim3 &xyzmin, const amrex::Dim3 lo, const int n_rz_azimuthal_modes)
	Kernel for the direct current deposition for thread thread_num.

template<int depos_order>
void	doVarianceDepositionShapeN (const GetParticlePosition< PIdx > &GetPosition, const amrex::ParticleReal wp, const amrex::ParticleReal uxp, const amrex::ParticleReal uyp, const amrex::ParticleReal uzp, amrex::FArrayBox &varx_fab, amrex::FArrayBox &vary_fab, amrex::FArrayBox &varz_fab, amrex::IArrayBox &nx_iab, amrex::IArrayBox &ny_iab, amrex::IArrayBox &nz_iab, amrex::FArrayBox &wx_fab, amrex::FArrayBox &wy_fab, amrex::FArrayBox &wz_fab, amrex::FArrayBox &w2x_fab, amrex::FArrayBox &w2y_fab, amrex::FArrayBox &w2z_fab, amrex::FArrayBox &vxbar_fab, amrex::FArrayBox &vybar_fab, amrex::FArrayBox &vzbar_fab, const TemperatureDepositionType type, const TemperatureDepositionPass pass, const long np_to_deposit, const amrex::Real relative_time, const amrex::XDim3 &dinv, const amrex::XDim3 &xyzmin, const amrex::Dim3 lo, const int n_rz_azimuthal_modes)
	Temperature Deposition Algorithm from Bell (1979) https://dl.acm.org/doi/pdf/10.1145/359146.359153 This can run either WV1 (Double Pass), or WV4 (Single Pass) Algorithms It should be noted that becuase of GPU Weak memory ordering in kernels it is quite difficult to perform online update algorithms (i.e.) WV2 and WV3 because of difficulties creating critical regions in kernels for all GPU kernel types.

Enumeration Type Documentation

◆ TemperatureDepositionPass

enum class warpx::particles::deposition::TemperatureDepositionPass : int

strong

Enumerator
FIRST
SECOND

◆ TemperatureDepositionType

enum class warpx::particles::deposition::TemperatureDepositionType : int

strong

Enumerator
SINGLE_PASS
DOUBLE_PASS

Function Documentation

◆ doVarianceDepositionShapeN()

template<int depos_order>

void warpx::particles::deposition::doVarianceDepositionShapeN	(	const GetParticlePosition< PIdx > &	GetPosition,
		const amrex::ParticleReal *	wp,
		const amrex::ParticleReal *	uxp,
		const amrex::ParticleReal *	uyp,
		const amrex::ParticleReal *	uzp,
		amrex::FArrayBox &	varx_fab,
		amrex::FArrayBox &	vary_fab,
		amrex::FArrayBox &	varz_fab,
		amrex::IArrayBox &	nx_iab,
		amrex::IArrayBox &	ny_iab,
		amrex::IArrayBox &	nz_iab,
		amrex::FArrayBox &	wx_fab,
		amrex::FArrayBox &	wy_fab,
		amrex::FArrayBox &	wz_fab,
		amrex::FArrayBox &	w2x_fab,
		amrex::FArrayBox &	w2y_fab,
		amrex::FArrayBox &	w2z_fab,
		amrex::FArrayBox &	vxbar_fab,
		amrex::FArrayBox &	vybar_fab,
		amrex::FArrayBox &	vzbar_fab,
		const TemperatureDepositionType	type,
		const TemperatureDepositionPass	pass,
		const long	np_to_deposit,
		const amrex::Real	relative_time,
		const amrex::XDim3 &	dinv,
		const amrex::XDim3 &	xyzmin,
		const amrex::Dim3	lo,
		const int	n_rz_azimuthal_modes )

Temperature Deposition Algorithm from Bell (1979) https://dl.acm.org/doi/pdf/10.1145/359146.359153 This can run either WV1 (Double Pass), or WV4 (Single Pass) Algorithms It should be noted that becuase of GPU Weak memory ordering in kernels it is quite difficult to perform online update algorithms (i.e.) WV2 and WV3 because of difficulties creating critical regions in kernels for all GPU kernel types.

Template Parameters

depos_order deposition order

Parameters

GetPosition	A functor for returning the particle position.
wp	Pointer to array of particle weights.
uxp,uyp,uzp	Pointer to arrays of particle momentum.
varx_fab,vary_fab,varz_fab	FArrayBox of variance, either full array or tile.
nx_iab,ny_iab,nz_iab	IArrayBox of sample count buffer, either full array or tile.
wx_fab,wy_fab,wz_fab	FArrayBox for running weights buffer, either full array or tile.
w2x_fab,w2y_fab,w2z_fab	FArrayBox for weights^2 buffer, either full array or tile.
vxbar_fab,vybar_fab,vzbar_fab	FArrayBox of current density, either full array or tile.
type	The type of deposition routine, either SINGLE_PASS or DOUBLE_PASS
pass	The pass that is occurring, either FIRST or SECOND
np_to_deposit	Number of particles for which current is deposited.
relative_time	Time at which to deposit J, relative to the time of the current positions of the particles. When different than 0, the particle position will be temporarily modified to match the time of the deposition.
dinv	3D cell size inverse
xyzmin	Physical lower bounds of domain.
lo	Index lower bounds of domain.
n_rz_azimuthal_modes	Number of azimuthal modes when using RZ geometry.

◆ doVarianceDepositionShapeNKernel()

template<int depos_order>

AMREX_GPU_HOST_DEVICE AMREX_INLINE void warpx::particles::deposition::doVarianceDepositionShapeNKernel	(	const amrex::ParticleReal	xp,
		const amrex::ParticleReal	yp,
		const amrex::ParticleReal	zp,
		const amrex::ParticleReal	wp,
		const amrex::ParticleReal	vx,
		const amrex::ParticleReal	vy,
		const amrex::ParticleReal	vz,
		const amrex::Array4< int > &	nx_arr,
		const amrex::Array4< int > &	ny_arr,
		const amrex::Array4< int > &	nz_arr,
		const amrex::Array4< amrex::Real > &	wx_arr,
		const amrex::Array4< amrex::Real > &	wy_arr,
		const amrex::Array4< amrex::Real > &	wz_arr,
		const amrex::Array4< amrex::Real > &	w2x_arr,
		const amrex::Array4< amrex::Real > &	w2y_arr,
		const amrex::Array4< amrex::Real > &	w2z_arr,
		const amrex::Array4< amrex::Real > &	vxbar_arr,
		const amrex::Array4< amrex::Real > &	vybar_arr,
		const amrex::Array4< amrex::Real > &	vzbar_arr,
		const amrex::IntVect &	varx_type,
		const amrex::IntVect &	vary_type,
		const amrex::IntVect &	varz_type,
		const TemperatureDepositionType	type,
		const TemperatureDepositionPass	pass,
		const amrex::Real	relative_time,
		const amrex::XDim3 &	dinv,
		const amrex::XDim3 &	xyzmin,
		const amrex::Dim3	lo,
		const int	n_rz_azimuthal_modes )

Kernel for the direct current deposition for thread thread_num.

Template Parameters

depos_order deposition order

Parameters

xp,yp,zp	The particle positions.
wp	The weight of the macroparticle
vx,vy,vz	The particle velocities
nx_arr,ny_arr,nz_arr	Array4<int> of velocity variance sample count, either full array or tile.
wx_arr,wy_arr,wz_arr	Array4 of weight sums, either full array or tile.
w2x_arr,w2y_arr,w2z_arr	Array4 of weight**2 sums, either full array or tile.
vxbar_arr,vybar_arr,vzbar_arr	Array4 of current density, either full array or tile.
varx_type,vary_type,varz_type	The grid types along each direction, either NODE or CELL
type	The type of deposition routine, either SINGLE_PASS or DOUBLE_PASS
pass	The pass that is occurring, either FIRST or SECOND
relative_time	Time at which to deposit J, relative to the time of the current positions of the particles. When different than 0, the particle position will be temporarily modified to match the time of the deposition.
dinv	3D cell size inverse
xyzmin	The lower bounds of the domain
lo	Index lower bounds of domain.
n_rz_azimuthal_modes	Number of azimuthal modes when using RZ geometry.

defined(WARPX_DIM_1D_Z)

◆ varianceDepositionSubKernel()

AMREX_GPU_HOST_DEVICE AMREX_INLINE void warpx::particles::deposition::varianceDepositionSubKernel	(	amrex::ParticleReal	vx,
		amrex::ParticleReal	vy,
		amrex::ParticleReal	vz,
		const amrex::IntVectND< 3 > &	ixv,
		const amrex::IntVectND< 3 > &	iyv,
		const amrex::IntVectND< 3 > &	izv,
		amrex::Real	wpx_var,
		amrex::Real	wpy_var,
		amrex::Real	wpz_var,
		const amrex::Array4< int > &	nx_arr,
		const amrex::Array4< int > &	ny_arr,
		const amrex::Array4< int > &	nz_arr,
		const amrex::Array4< amrex::Real > &	wx_arr,
		const amrex::Array4< amrex::Real > &	wy_arr,
		const amrex::Array4< amrex::Real > &	wz_arr,
		const amrex::Array4< amrex::Real > &	w2x_arr,
		const amrex::Array4< amrex::Real > &	w2y_arr,
		const amrex::Array4< amrex::Real > &	w2z_arr,
		const amrex::Array4< amrex::Real > &	vxbar_arr,
		const amrex::Array4< amrex::Real > &	vybar_arr,
		const amrex::Array4< amrex::Real > &	vzbar_arr,
		const TemperatureDepositionType	type,
		const TemperatureDepositionPass	pass )

Classes

Enumerations