Empty.H

Go to the documentation of this file.

/* Copyright 2022-2023 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_ELEMENT_EMPTY_H
#define IMPACTX_ELEMENT_EMPTY_H
 
#include "particles/ImpactXParticleContainer.H"
#include "mixin/thin.H"
#include "mixin/lineartransport.H"
#include "mixin/nofinalize.H"
 
#include <AMReX_Extension.H>
#include <AMReX_REAL.H>
#include <AMReX_SIMD.H>
 
#include <stdexcept>
#include <string>
 
 
namespace impactx::elements
{
    struct Empty
    : public mixin::Thin,
      public mixin::LinearTransport<Empty>,
      public mixin::NoFinalize,
      public amrex::simd::Vectorized<amrex::simd::native_simd_size_particlereal>
    {
        static constexpr auto type = "None";
        using PType = ImpactXParticleContainer::ParticleType;

        Empty ()
        {
        }

        void operator() (
            ImpactXParticleContainer & /* pc */,
            int /* step */,
            int /* period */
        ) {
            // nothing to do
        }

        void compute_constants (RefPart const & /* refpart */)
        {
            // nothing to do
        }

        void operator() (
            ImpactXParticleContainer::iterator & /* pti */,
            RefPart & AMREX_RESTRICT /* ref_part */
        ) {
            // nothing to do
        }

        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
        void operator() ([[maybe_unused]] RefPart & AMREX_RESTRICT refpart) const
        {
            // nothing to do
        }

        AMREX_GPU_HOST AMREX_FORCE_INLINE
        Map6x6
        transport_map ([[maybe_unused]] RefPart const & AMREX_RESTRICT refpart) const
        {
            // nothing to do
            return Map6x6::Identity();
        }

        template<typename T_Real=amrex::ParticleReal, typename T_IdCpu=uint64_t>
        AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
        void operator() (
            [[maybe_unused]] T_Real & AMREX_RESTRICT x,
            [[maybe_unused]] T_Real & AMREX_RESTRICT y,
            [[maybe_unused]] T_Real & AMREX_RESTRICT t,
            [[maybe_unused]] T_Real & AMREX_RESTRICT px,
            [[maybe_unused]] T_Real & AMREX_RESTRICT py,
            [[maybe_unused]] T_Real & AMREX_RESTRICT pt,
            [[maybe_unused]] T_IdCpu & AMREX_RESTRICT idcpu,
            [[maybe_unused]] RefPart const & AMREX_RESTRICT refpart
        ) const
        {
            // nothing to do
        }

        using Thin::operator();

        using LinearTransport::operator();

        AMREX_FORCE_INLINE
        std::string name () const { throw std::runtime_error("Name not set on element!"); }

        AMREX_FORCE_INLINE
        bool has_name () const { return false; }
    };
 
} // namespace impactx
 
#endif // IMPACTX_ELEMENT_EMPTY_H