Source.H

Go to the documentation of this file.

/* Copyright 2022-2025 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_SOURCE_H
#define IMPACTX_SOURCE_H
 
#include "particles/ImpactXParticleContainer.H"
#include "mixin/lineartransport.H"
#include "mixin/named.H"
#include "mixin/nofinalize.H"
#include "mixin/thin.H"
 
#include <stdexcept>
#include <string>
 
 
namespace impactx::elements
{
    struct Source
    : public mixin::Named,
      public mixin::LinearTransport<Source>,
      public mixin::Thin,
      public mixin::NoFinalize
    {
        static constexpr auto type = "Source";
        using PType = ImpactXParticleContainer::ParticleType;

        Source (
            std::string distribution,
            std::string openpmd_path,
            bool active_once = true,
            std::optional<std::string> name = std::nullopt
        )
        : Named(std::move(name)),
          m_distribution(distribution),
          m_series_name(std::move(openpmd_path)),
          m_active_once(active_once)
        {
            if (distribution != "openPMD") {
                throw std::runtime_error("Only 'openPMD' distribution is supported if openpmd_path is provided!");
            }
        }

        void reverse ()
        {
            throw std::runtime_error("Source: reverse() is not supported.");
        }

        void operator() (
            ImpactXParticleContainer & pc,
            [[maybe_unused]] int step,
            int period
        );

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

        using Thin::operator();

        using LinearTransport::operator();
 
        std::string m_distribution; 
        std::string m_series_name; 
        bool m_active_once = true; 
    };
 
} // namespace impactx
 
#endif  // IMPACTX_SOURCE_H