Algorithms Namespace Reference

Functions
template<typename T = amrex::ParticleReal>
AMREX_GPU_HOST_DEVICE AMREX_INLINE T	KineticEnergy (const amrex::ParticleReal ux, const amrex::ParticleReal uy, const amrex::ParticleReal uz, const amrex::ParticleReal mass)
	Computes the kinetic energy of a particle. This method should not be used with photons.
AMREX_GPU_HOST_DEVICE AMREX_INLINE amrex::ParticleReal	KineticEnergyPhotons (const amrex::ParticleReal ux, const amrex::ParticleReal uy, const amrex::ParticleReal uz)
	Computes the kinetic energy of a photon.

Function Documentation

KineticEnergy()

template<typename T = amrex::ParticleReal>

AMREX_GPU_HOST_DEVICE AMREX_INLINE T Algorithms::KineticEnergy	(	const amrex::ParticleReal	ux,
		const amrex::ParticleReal	uy,
		const amrex::ParticleReal	uz,
		const amrex::ParticleReal	mass )

Computes the kinetic energy of a particle. This method should not be used with photons.

Template Parameters

T	floating-point type to be used in internal calculations (by default equal to amrex::ParticleReal)

Parameters

[in]	ux	x component of the particle momentum (code units)
[in]	uy	y component of the particle momentum (code units)
[in]	uz	z component of the particle momentum (code units)
[in]	mass	mass of the particle (in S.I. units)

Returns

the kinetic energy of the particle (in S.I. units)

KineticEnergyPhotons()

AMREX_GPU_HOST_DEVICE AMREX_INLINE amrex::ParticleReal Algorithms::KineticEnergyPhotons	(	const amrex::ParticleReal	ux,
		const amrex::ParticleReal	uy,
		const amrex::ParticleReal	uz )

Computes the kinetic energy of a photon.

Parameters

[in]	ux	x component of the particle momentum (code units)
[in]	uy	y component of the particle momentum (code units)
[in]	uz	z component of the particle momentum (code units)

Returns

the kinetic energy of the photon (in S.I. units)