ParticleIO.H

Go to the documentation of this file.

/* Copyright 2021 Axel Huebl
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
#ifndef WARPX_PARTICLEIO_H_
#define WARPX_PARTICLEIO_H_
 
#include "Particles/WarpXParticleContainer.H"
#include "Particles/Pusher/GetAndSetPosition.H"
 
#include <ablastr/particles/NodalFieldGather.H>
 
#include <AMReX_AmrParticles.H>
#include <AMReX_ParIter.H>
#include <AMReX_Gpu.H>
#include <AMReX_REAL.H>
 
 
enum struct ConvertDirection{WarpX_to_SI, SI_to_WarpX};

template< typename T_ParticleContainer >
void
particlesConvertUnits (ConvertDirection convert_direction, T_ParticleContainer* pc, amrex::ParticleReal const mass )
{
    using namespace amrex;
 
    // Compute conversion factor
    auto factor = 1_rt;
 
    if (convert_direction == ConvertDirection::WarpX_to_SI){
        factor = mass;
    } else if (convert_direction == ConvertDirection::SI_to_WarpX){
        factor = 1._rt/mass;
    }
 
    using PinnedParIter = typename T_ParticleContainer::ParIterType;
 
    const int nLevels = pc->finestLevel();
    for (int lev=0; lev<=nLevels; lev++){
#ifdef AMREX_USE_OMP
#pragma omp parallel if (Gpu::notInLaunchRegion())
#endif
        for (PinnedParIter pti(*pc, lev); pti.isValid(); ++pti)
        {
            // - momenta are stored as a struct of array, in `attribs`
            // The GetStructOfArrays is called directly since the convenience routine GetAttribs
            // is only available in WarpXParIter. ParIter is used here since the pc passed in
            // will sometimes be a WarpXParticleContainer (not derived from a WarpXParticleContainer).
            auto& attribs = pti.GetStructOfArrays().GetRealData();
            ParticleReal* AMREX_RESTRICT ux = attribs[PIdx::ux].dataPtr();
            ParticleReal* AMREX_RESTRICT uy = attribs[PIdx::uy].dataPtr();
            ParticleReal* AMREX_RESTRICT uz = attribs[PIdx::uz].dataPtr();
            // Loop over the particles and convert momentum
            const long np = pti.numParticles();
            ParallelFor( np,
                         [=] AMREX_GPU_DEVICE (long i) {
                ux[i] *= factor;
                uy[i] *= factor;
                uz[i] *= factor;
            }
            );
        }
    }
}

void
storePhiOnParticles ( WarpXParticleContainer::Base& tmp,
    ElectrostaticSolverAlgo electrostatic_solver_id, bool is_full_diagnostic );

void
storeFieldOnParticles (WarpXParticleContainer::Base& tmp, bool is_full_diagnostic,
                       bool save_Ex, bool save_Ey, bool save_Ez,
                       bool save_Bx, bool save_By, bool save_Bz);
 
#endif /* WARPX_PARTICLEIO_H_ */