InitDistribution.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, Andrew Myers, Marco Garten
 * License: BSD-3-Clause-LBNL
 */
#ifndef IMPACTX_INITIALIZATION_INITDISTRIBUTION_H
#define IMPACTX_INITIALIZATION_INITDISTRIBUTION_H
 
#include "particles/ImpactXParticleContainer.H"
#include "particles/CovarianceMatrix.H"
#include "particles/distribution/All.H"
 
#include <AMReX_Extension.H>  // for AMREX_RESTRICT
#include <AMReX_REAL.H>
 
#include <optional>  // for std::optional
#include <utility>  // for std::move
 
 
namespace impactx::initialization
{
    RefPart
    read_reference_particle (amrex::ParmParse const & pp_dist);

    distribution::KnownDistributions
    read_distribution (amrex::ParmParse const & pp_dist);

    Envelope
    create_envelope (
        distribution::KnownDistributions const & distr,
        std::optional<amrex::ParticleReal> intensity = std::nullopt
    );

    template <typename T_Distribution>
    struct InitSingleParticleData
    {
        InitSingleParticleData (
            T_Distribution distribution,
            amrex::ParticleReal* AMREX_RESTRICT part_x,
            amrex::ParticleReal* AMREX_RESTRICT part_y,
            amrex::ParticleReal* AMREX_RESTRICT part_t,
            amrex::ParticleReal* AMREX_RESTRICT part_px,
            amrex::ParticleReal* AMREX_RESTRICT part_py,
            amrex::ParticleReal* AMREX_RESTRICT part_pt
        )
        : m_distribution(std::move(distribution)),
          m_part_x(part_x), m_part_y(part_y), m_part_t(part_t),
          m_part_px(part_px), m_part_py(part_py), m_part_pt(part_pt)
        {
        }
 
        InitSingleParticleData () = delete;
        InitSingleParticleData (InitSingleParticleData const &) = default;
        InitSingleParticleData (InitSingleParticleData &&) = default;
        ~InitSingleParticleData () = default;

        AMREX_GPU_DEVICE AMREX_FORCE_INLINE
        void
        operator() (
            amrex::Long i,
            amrex::RandomEngine const & engine
        ) const
        {
            m_distribution(
                m_part_x[i],
                m_part_y[i],
                m_part_t[i],
                m_part_px[i],
                m_part_py[i],
                m_part_pt[i],
                engine
            );
        }
 
    private:
        T_Distribution const m_distribution;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_x;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_y;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_t;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_px;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_py;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_pt;
    };

    struct InitSingleParticleSpin
    {
        InitSingleParticleSpin (
            distribution::SpinvMF spinv,
            amrex::ParticleReal* AMREX_RESTRICT part_sx,
            amrex::ParticleReal* AMREX_RESTRICT part_sy,
            amrex::ParticleReal* AMREX_RESTRICT part_sz
        )
        : m_spinv(std::move(spinv)),
          m_part_sx(part_sx), m_part_sy(part_sy), m_part_sz(part_sz)
        {
        }
 
        InitSingleParticleSpin () = delete;
        InitSingleParticleSpin (InitSingleParticleSpin const &) = default;
        InitSingleParticleSpin (InitSingleParticleSpin &&) = default;
        ~InitSingleParticleSpin () = default;

        AMREX_GPU_DEVICE AMREX_FORCE_INLINE
        void
        operator() (
            amrex::Long i,
            amrex::RandomEngine const & engine
        ) const
        {
            m_spinv(
                m_part_sx[i],
                m_part_sy[i],
                m_part_sz[i],
                engine
            );
        }
 
    private:
        distribution::SpinvMF const m_spinv;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_sx;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_sy;
        amrex::ParticleReal* const AMREX_RESTRICT m_part_sz;
    };
 

    void
    set_distribution_parameters_from_phase_space_inputs (
        amrex::ParmParse const & pp_dist,
        amrex::ParticleReal& lambdax, amrex::ParticleReal& lambday, amrex::ParticleReal& lambdat,
        amrex::ParticleReal& lambdapx,amrex::ParticleReal& lambdapy, amrex::ParticleReal& lambdapt,
        amrex::ParticleReal& muxpx, amrex::ParticleReal& muypy, amrex::ParticleReal& mutpt,
        amrex::ParticleReal& meanx, amrex::ParticleReal& meany, amrex::ParticleReal& meant,
        amrex::ParticleReal& meanpx, amrex::ParticleReal& meanpy, amrex::ParticleReal& meanpt,
        amrex::ParticleReal& dispx, amrex::ParticleReal& disppx, amrex::ParticleReal& dispy, amrex::ParticleReal& disppy
    );
 

    void
    set_distribution_parameters_from_twiss_inputs (
        amrex::ParmParse const & pp_dist,
        amrex::ParticleReal& lambdax, amrex::ParticleReal& lambday, amrex::ParticleReal& lambdat,
        amrex::ParticleReal& lambdapx,amrex::ParticleReal& lambdapy, amrex::ParticleReal& lambdapt,
        amrex::ParticleReal& muxpx, amrex::ParticleReal& muypy, amrex::ParticleReal& mutpt,
        amrex::ParticleReal& meanx, amrex::ParticleReal& meany, amrex::ParticleReal& meant,
        amrex::ParticleReal& meanpx, amrex::ParticleReal& meanpy, amrex::ParticleReal& meanpt,
        amrex::ParticleReal& dispx, amrex::ParticleReal& disppx, amrex::ParticleReal& dispy, amrex::ParticleReal& disppy
    );
 
}  // namespace impactx::initialization
 
#endif  // IMPACTX_INITIALIZATION_INITDISTRIBUTION_H