PlasmaMLPALLASQuadrupoleUtils.cc File Reference

Utility functions for updating quadrupole vectors in simulation statistics. More...

#include "PlasmaMLPALLASQuadrupoleUtils.hh"

Include dependency graph for PlasmaMLPALLASQuadrupoleUtils.cc:

Functions
void	SetQuadrupoleValue (RunTallyQuadrupoles &stats, QuadID qid, PositionType posType, VectorType vecType, Axis axis, float value)
	Sets a specific component of a quadrupole vector.

Detailed Description

Utility functions for updating quadrupole vectors in simulation statistics.

This file provides helper functions to modify specific components of quadrupole position or momentum vectors, either at the beginning or the end of the quadrupole element during a simulation run.

Functions in this file are intended to simplify bookkeeping of quadrupole data in RunTallyQuadrupoles structures.

Example usage:

SetQuadrupoleValue(stats, QuadID::Q1, PositionType::Begin, VectorType::Position, Axis::X, 0.1f);

Authors

Arnaud HUBER

Alexei SYTOV

Date

2025

Copyright

PALLAS Project - GEANT4 Collaboration

Function Documentation

SetQuadrupoleValue()

void SetQuadrupoleValue	(	RunTallyQuadrupoles &	stats,
		QuadID	qid,
		PositionType	posType,
		VectorType	vecType,
		Axis	axis,
		float	value
	)

Sets a specific component of a quadrupole vector.

Allows modification of a single axis (X, Y, Z) of either the position or momentum vector for a given quadrupole, at either the beginning or the end of the quadrupole element.

Parameters

stats

Reference to the `RunTally*

#include "PlasmaMLPALLASQuadrupoleUtils.hh"

---

SetQuadrupoleValue

/**

Sets a specific component of a quadrupole vector in the simulation statistics.

This function allows fine-grained modification of a single vector component (X, Y, or Z) for either the position or momentum vector of a quadrupole, at the beginning or end of the element.

Parameters

stats	Reference to the RunTallyQuadrupoles structure containing all quadrupole data.
qid	Identifier of the quadrupole (Q1, Q2, Q3, Q4).
posType	Position type: whether to modify the vector at the beginning or end of the quadrupole.
vecType	Vector type: position or momentum.
axis	Component of the vector to modify (X, Y, Z).
value	The new value to assign to the selected component.