PlasmaMLPALLASQuadrupoleUtils.hh

Go to the documentation of this file.

#ifndef QUADRUPOLEUTILS_HH
#define QUADRUPOLEUTILS_HH
 
// Simple 3D vector structure to store x, y, z components
struct Vector3
{
    float x, y, z;
};
 
// Structure representing the state of a single quadrupole
// It stores the position and momentum vectors at both the beginning and end of the quadrupole
struct QuadrupoleState
{
    Vector3 begin;         // Position at the beginning of the quadrupole
    Vector3 end;           // Position at the end of the quadrupole
    Vector3 beginMomentum; // Momentum at the beginning
    Vector3 endMomentum;   // Momentum at the end
};
 
// Structure storing all quadrupoles in a run, plus additional statistics like energy
struct RunTallyQuadrupoles
{
    QuadrupoleState Q1;
    QuadrupoleState Q2;
    QuadrupoleState Q3;
    QuadrupoleState Q4;
    float energy; // Total energy of the system/run
};
 
// Enumeration to identify each quadrupole
enum class QuadID { Q1 = 1, Q2, Q3, Q4 };
 
// Enumeration to specify whether we are referring to the beginning or end of a quadrupole
enum class PositionType { Begin, End };
 
// Enumeration to select between position vector or momentum vector
enum class VectorType { Position, Momentum };
 
// Enumeration to select a vector component
enum class Axis { X, Y, Z };
 
// Function declaration for setting a specific component of a quadrupole vector
// Implementation is in PlasmaMLPALLASQuadrupoleUtils.cc
void SetQuadrupoleValue(RunTallyQuadrupoles &stats,
                        QuadID qid,
                        PositionType posType,
                        VectorType vecType,
                        Axis axis,
                        float value);
 
#endif