BDSParticleDefinition.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSPARTICLEDEFINITION_H
#define BDSPARTICLEDEFINITION_H
#include "BDSIonDefinition.hh"
 
#include "CLHEP/Units/PhysicalConstants.h"
 
#include "globals.hh"
 
#include <ostream>
 
class G4ParticleDefinition;
 
class BDSParticleDefinition
{
public:
  BDSParticleDefinition(G4ParticleDefinition* particleIn,
                        G4double              totalEnergyIn,
                        G4double              kineticEnergyIn,
                        G4double              momentumIn,
                        G4double              ffact,
                        BDSIonDefinition*     ionDefinitionIn = nullptr,
                        G4int                 ionPDGID        = 0);
  
  BDSParticleDefinition(const G4String&    nameIn,
                        G4double          massIn,
                        G4double          chargeIn,
                        G4double          totalEnergyIn,
                        G4double          kineticEnergyIn,
                        G4double          momentumIn,
                        G4double          ffact,
                        BDSIonDefinition* ionDefinitionIn = nullptr,
                        G4int             ionPDGID        = 0);
 
  BDSParticleDefinition(const BDSParticleDefinition& other);
  BDSParticleDefinition(BDSParticleDefinition&& other) noexcept;
  BDSParticleDefinition& operator=(BDSParticleDefinition&& other) noexcept;
  
  ~BDSParticleDefinition();
 
  void SetEnergies(G4double totalEnergyIn,
                   G4double kineticEnergyIn,
                   G4double momentumIn);
 
  void UpdateG4ParticleDefinition(G4ParticleDefinition* particleIn) {particle = particleIn;}
 
 
  void ApplyChangeInKineticEnergy(G4double dEk);
 
  inline G4ParticleDefinition* ParticleDefinition() const {return particle;}
  inline BDSIonDefinition*     IonDefinition()      const {return ionDefinition;}
  inline G4String Name()          const {return name;}
  inline G4double Mass()          const {return mass;}
  inline G4double Charge()        const {return charge;}
  inline G4double TotalEnergy()   const {return totalEnergy;}
  inline G4double KineticEnergy() const {return kineticEnergy;}
  inline G4double Momentum()      const {return momentum;}
  inline G4double Gamma()         const {return gamma;}
  inline G4double Beta()          const {return beta;}
  inline G4double BRho()          const {return brho;}
  inline G4double FFact()         const {return ffact;}
  inline G4bool   IsAnIon()       const {return ionDefinition != nullptr;}
  inline G4bool   NElectrons()    const {return ionDefinition != nullptr ? ionDefinition->NElectrons() : 0;}
  inline G4double Velocity()      const {return Beta() * CLHEP::c_light;}
  inline G4bool   Forwards()      const {return forwards;}
 
  G4int PDGID() const;
 
  friend std::ostream& operator<< (std::ostream& out, BDSParticleDefinition const& def);
  
private:
  BDSParticleDefinition() = delete;
 
  void CalculateMomentum();
 
  void CalculateRigidity(const G4double& ffactIn);
 
  void CalculateLorentzFactors();
  
  G4ParticleDefinition* particle;      
  BDSIonDefinition*     ionDefinition; 
  G4int                 ionPDGID;      
 
  G4String name;           
  G4double mass;           
  G4double charge;         
  G4double totalEnergy;    
  G4double kineticEnergy;  
  G4double momentum;       
  G4double gamma;          
  G4double beta;           
  G4double brho;           
  G4double ffact;          
  G4bool   forwards;       
};
 
#endif