PlasmaMLPALLASQuadrupoleUtils.hh File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Vector3
struct	QuadrupoleState
struct	RunTallyQuadrupoles

Enumerations
enum class	QuadID { Q1 = 1 , Q2 , Q3 , Q4 }
enum class	PositionType { Begin , End }
enum class	VectorType { Position , Momentum }
enum class	Axis { X , Y , Z }

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

Enumeration Type Documentation

Axis

enum class Axis

strong

Enumerator
X
Y
Z

PositionType

enum class PositionType

strong

Enumerator
Begin
End

QuadID

enum class QuadID

strong

Enumerator
Q1
Q2
Q3
Q4

VectorType

enum class VectorType

strong

Enumerator
Position
Momentum

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.