UpdatePosition.H

Go to the documentation of this file.

/* Copyright 2019 David Grote, Maxence Thevenet, Remi Lehe
 * Weiqun Zhang
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PARTICLES_PUSHER_UPDATEPOSITION_H_
#define WARPX_PARTICLES_PUSHER_UPDATEPOSITION_H_
 
#include "Utils/WarpXConst.H"
 
#include <AMReX.H>
#include <AMReX_FArrayBox.H>
#include <AMReX_REAL.H>
 
 
 
AMREX_GPU_HOST_DEVICE AMREX_INLINE
void UpdatePosition(amrex::ParticleReal& x, amrex::ParticleReal& y, amrex::ParticleReal& z,
                    const amrex::ParticleReal ux, const amrex::ParticleReal uy, const amrex::ParticleReal uz,
                    const amrex::Real dt )
{
    using namespace amrex::literals;
 
    constexpr amrex::ParticleReal inv_c2 = 1._prt/(PhysConst::c*PhysConst::c);
 
    // Compute inverse Lorentz factor
    const amrex::ParticleReal inv_gamma = 1._prt/std::sqrt(1._prt + (ux*ux + uy*uy + uz*uz)*inv_c2);
    // Update positions over one time step
#if (AMREX_SPACEDIM >= 2)
    x += ux * inv_gamma * dt;
#else
    amrex::ignore_unused(x);
#endif
#if defined(WARPX_DIM_3D) || defined(WARPX_DIM_RZ) // RZ pushes particles in 3D
    y += uy * inv_gamma * dt;
#else
    amrex::ignore_unused(y);
#endif
    z += uz * inv_gamma * dt;
}
 
AMREX_GPU_HOST_DEVICE AMREX_INLINE
void UpdatePositionImplicit(amrex::ParticleReal& x, amrex::ParticleReal& y, amrex::ParticleReal& z,
                            const amrex::ParticleReal ux_n, const amrex::ParticleReal uy_n, const amrex::ParticleReal uz_n,
                            const amrex::ParticleReal ux, const amrex::ParticleReal uy, const amrex::ParticleReal uz,
                            const amrex::Real dt )
{
    using namespace amrex::literals;
 
    constexpr amrex::ParticleReal inv_c2 = 1._prt/(PhysConst::c*PhysConst::c);
 
    // Compute inverse Lorentz factor, the average of gamma at time levels n and n+1
    // The ux,uy,uz are the velocities at time level n+1/2
    const amrex::ParticleReal ux_np1 = 2._prt*ux - ux_n;
    const amrex::ParticleReal uy_np1 = 2._prt*uy - uy_n;
    const amrex::ParticleReal uz_np1 = 2._prt*uz - uz_n;
    const amrex::ParticleReal gamma_n = std::sqrt(1._prt + (ux_n*ux_n + uy_n*uy_n + uz_n*uz_n)*inv_c2);
    const amrex::ParticleReal gamma_np1 = std::sqrt(1._prt + (ux_np1*ux_np1 + uy_np1*uy_np1 + uz_np1*uz_np1)*inv_c2);
    const amrex::ParticleReal inv_gamma = 2.0_prt/(gamma_n + gamma_np1);
 
    // Update positions over one time step
#if (AMREX_SPACEDIM >= 2)
    x += ux * inv_gamma * dt;
#else
    amrex::ignore_unused(x);
#endif
#if defined(WARPX_DIM_3D) || defined(WARPX_DIM_RZ) // RZ pushes particles in 3D
    y += uy * inv_gamma * dt;
#else
    amrex::ignore_unused(y);
#endif
    z += uz * inv_gamma * dt;
}
 
AMREX_GPU_HOST_DEVICE AMREX_INLINE
void PositionNorm( amrex::ParticleReal dxp, amrex::ParticleReal dyp, amrex::ParticleReal dzp,
                   amrex::ParticleReal& dxp_save, amrex::ParticleReal& dyp_save, amrex::ParticleReal& dzp_save,
                   amrex::ParticleReal idxg2, amrex::ParticleReal idyg2, amrex::ParticleReal idzg2,
                   amrex::ParticleReal& step_norm, const int iter )
{
    using namespace amrex::literals;
 
#if defined(WARPX_DIM_1D_Z)
    amrex::ignore_unused(dxp, dxp_save, idxg2);
#endif
#if !defined(WARPX_DIM_3D)
    amrex::ignore_unused(dyp, dyp_save, idyg2);
#endif
 
    if (iter==0) { step_norm = 1.0_prt; }
    else {
        step_norm = (dzp - dzp_save)*(dzp - dzp_save)*idzg2;
#if !defined(WARPX_DIM_1D_Z)
        step_norm += (dxp - dxp_save)*(dxp - dxp_save)*idxg2;
#endif
#if defined(WARPX_DIM_3D)
        step_norm += (dyp - dyp_save)*(dyp - dyp_save)*idyg2;
#elif defined(WARPX_DIM_RZ)
        step_norm += (dyp - dyp_save)*(dyp - dyp_save)*idxg2;
#endif
        step_norm = std::sqrt(step_norm);
    }
    dzp_save = dzp;
#if !defined(WARPX_DIM_1D_Z)
    dxp_save = dxp;
#endif
#if defined(WARPX_DIM_3D) || defined(WARPX_DIM_RZ)
    dyp_save = dyp;
#endif
 
}
 
#endif // WARPX_PARTICLES_PUSHER_UPDATEPOSITION_H_