API: Z-prime charges for Standard Model

Key data structure

The key data structure here is the collection of integer charges one can assign to the Standard Model particles. Sets of charges which are multiples of each other should be equivalent.

• is defined

Need

Z-prime models are an important yet simple extension of the standard model. They have been utilized in many phenomenological problems. Having this data structure will allow us to reason more easily about these models.

Requirements

• The API shall contain an action of the group which permutes families of particles
• The API shall contain a function returning the charges associated with different terms in the potential
• The API shall contain a function given the anomaly cancellation conditions on the charges
• The API shall contain an equivalence class on the charges by addition of hypercharge
• The API shall contain common named sets of charges

Corresponding file system

Lots of aspect of this API already exist in PhysLean, however, it is not structured around a key data structure, so needs to be rewritten. This content can be found as part of:

https://github.com/HEPLean/PhysLean/tree/master/PhysLean/Particles/StandardModel

Parent APIs

#858

Start by reviewing the existing Standard Model material in PhysLean/Particles/StandardModel and the parent API in issue #858. Identify how the charge collection and its equivalence are currently represented, then compare that structure with the listed requirements. Done means the API provides the family permutation action, potential-term charges, anomaly cancellation conditions, hypercharge equivalence, and common named charge sets.