LinearMap.H

Go to the documentation of this file.

/* Copyright 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_DIAGNOSTICS_LINEAR_MAP_H
#define IMPACTX_DIAGNOSTICS_LINEAR_MAP_H
 
#include "elements/All.H"
#include "particles/CovarianceMatrix.H"
#include "particles/ReferenceParticle.H"
 
#include <list>
#include <string>
#include <vector>
 
 
namespace impactx::diagnostics
{
    enum class OnMissingLinearMap
    {
        IdentityWithWarning,  
        IdentitySilent,       
        Throw                 
    };

    struct MapTraceEntry
    {
        amrex::ParticleReal s;          
        std::string element_name;       
        std::string element_type;       
        Map6x6 M_cumulative;            
    };

    std::vector<MapTraceEntry>
    map_trace (
        std::list<elements::KnownElements> const & lattice,
        RefPart const & ref_part_init,
        OnMissingLinearMap on_missing = OnMissingLinearMap::IdentityWithWarning
    );

    Map6x6
    linear_map (
        std::list<elements::KnownElements> const & lattice,
        RefPart const & ref_part_init,
        OnMissingLinearMap on_missing = OnMissingLinearMap::IdentityWithWarning
    );
 
} // namespace impactx::diagnostics
 
#endif // IMPACTX_DIAGNOSTICS_LINEAR_MAP_H