PushAll.H

Go to the documentation of this file.

/* Copyright 2022-2026 The Regents of the University of California, through Lawrence
 *           Berkeley National Laboratory (subject to receipt of any required
 *           approvals from the U.S. Dept. of Energy). All rights reserved.
 *
 * This file is part of ImpactX.
 *
 * Authors: Axel Huebl
 * License: BSD-3-Clause-LBNL
 */
#ifndef IMPACTX_PUSH_ALL_H
#define IMPACTX_PUSH_ALL_H
 
#include "particles/ImpactXParticleContainer.H"
 
#include <AMReX_BLProfiler.H>
 
 
namespace impactx
{
    template<typename T_Element>
    void push_all (
        ImpactXParticleContainer & pc,
        T_Element & element,
        [[maybe_unused]] int step,
        [[maybe_unused]] int period,
        [[maybe_unused]] bool omp_parallel = true
    )
    {
        // performance profiling per element
        std::string const profile_name = "impactx::push::" + std::string(T_Element::type);
        BL_PROFILE(profile_name);
 
        // is spin tracking enabled?
        bool spin = false;
        amrex::ParmParse pp_algo("algo");
        pp_algo.query("spin", spin);
 
        // preparing to access reference particle data: RefPart
        RefPart & ref_part = pc.GetRefParticle();
 
        // push reference particle in global coordinates
        {
            BL_PROFILE("impactx::push::RefPart");
            element(ref_part);
        }
 
        // loop over refinement levels
        int const nLevel = pc.finestLevel();
        for (int lev = 0; lev <= nLevel; ++lev)
        {
            // loop over all particle boxes
            using ParIt = ImpactXParticleContainer::iterator;
#ifdef AMREX_USE_OMP
#pragma omp parallel if (amrex::Gpu::notInLaunchRegion() && omp_parallel)
#endif
            for (ParIt pti(pc, lev); pti.isValid(); ++pti) {
                // push beam particles relative to reference particle
                element(pti, ref_part, spin);
            } // end loop over all particle boxes
        } // env mesh-refinement level loop
    }
 
} // namespace impactx

#define IMPACTX_PUSH_EXTERN_TEMPLATE(ElementType) \
    extern template void impactx::push_all<ElementType>( \
        impactx::ImpactXParticleContainer &, \
        ElementType &, \
        int, int, bool);

#define IMPACTX_PUSH_INSTANTIATE(ElementType) \
    template void impactx::push_all<ElementType>( \
        impactx::ImpactXParticleContainer &, \
        ElementType &, \
        int, int, bool);
 
#endif // IMPACTX_PUSH_ALL_H