BDSBunch.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
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 BDSBUNCH_H
#define BDSBUNCH_H
 
#include "BDSBunchType.hh"
#include "BDSParticleCoords.hh"
#include "BDSParticleCoordsFull.hh"
#include "BDSParticleCoordsFullGlobal.hh"
#include "BDSParticleDefinition.hh"
 
#include "globals.hh"
#include "G4Transform3D.hh"
 
class BDSBeamline;
 
namespace GMAD
{
  class Beam;
}
 
class BDSBunch
{
public:
  BDSBunch();
  explicit BDSBunch(const G4String& nameIn);
  virtual ~BDSBunch();
 
  friend class BDSPrimaryGeneratorFileHEPMC;
  friend class BDSPrimaryGeneratorFileSampler;
 
  virtual void SetOptions(const BDSParticleDefinition* beamParticle,
                          const GMAD::Beam& beam,
                          const BDSBunchType& distrType,
                          G4Transform3D beamlineTransformIn = G4Transform3D::Identity,
                          const G4double beamlineS = 0);
  
  virtual void CheckParameters();
 
  virtual void Initialise();
 
  BDSParticleCoordsFullGlobal GetNextParticle();
  
  virtual G4bool ExpectChangingParticleType() const {return false;}
 
  virtual BDSParticleCoordsFullGlobal GetNextParticleValid(G4int maxTries = 100);
 
  virtual void BeginOfRunAction(G4int numberOfEvents,
                                G4bool batchMode);
 
  inline virtual const BDSParticleDefinition* ParticleDefinition() const {return particleDefinition;}
 
  virtual void SetGeneratePrimariesOnly(G4bool generatePrimariesOnlyIn);
 
  virtual BDSParticleCoordsFull GetNextParticleLocal();
 
  G4bool UseCurvilinearTransform() const {return useCurvilinear;}
 
  virtual void RecreateAdvanceToEvent(G4int eventOffset);
 
  inline G4bool BeamParticleIsAnIon() const {return particleDefinition->IsAnIon();}
 
  virtual void UpdateIonDefinition();
 
  inline G4bool ParticleDefinitionHasBeenUpdated() const {return particleDefinitionHasBeenUpdated;}
 
  static G4double CalculateZp(G4double xp, G4double yp, G4double Zp0);
 
  static void SetEmittances(const BDSParticleDefinition* beamParticle,
                            const GMAD::Beam& beam,
                            G4double&         emittGeometricX,
                            G4double&         emittGeometricY,
                            G4double&         emittNormalisedX,
                            G4double&         emittNormalisedY);
 
  inline G4String Name() const {return name;}
 
  inline G4int CurrentBunchIndex() const {return currentBunchIndex;}
 
  void CalculateBunchIndex(G4int eventIndex);
 
protected:
  BDSParticleCoordsFullGlobal ApplyTransform(const BDSParticleCoordsFull& localIn) const;
 
  void ApplyTilt(BDSParticleCoordsFull& localIn) const;
  
  void ApplyBunchTiming(BDSParticleCoordsFullGlobal& localIn) const;
 
  BDSParticleCoordsFullGlobal ApplyCurvilinearTransform(const BDSParticleCoordsFull& localIn) const;
 
  G4String name; 
  
  G4double X0;
  G4double Y0;
  G4double Z0;
  G4double S0;
  G4double T0; 
  G4double Xp0; 
  G4double Yp0;
  G4double Zp0;
  G4double E0;
  G4double P0;     
  G4double tilt;
  G4double sigmaT;
  G4double sigmaP;
  G4double sigmaE;
  G4double sigmaEk;
  
  bool useBunchTiming;
  G4int currentBunchIndex;
  G4int eventsPerBunch;
  G4double bunchPeriod;
  
  G4bool useCurvilinear;
 
  BDSParticleDefinition* particleDefinition;
 
  G4bool particleDefinitionHasBeenUpdated;
 
  G4bool finiteTilt; 
  G4bool finiteSigmaE;
  G4bool finiteSigmaT;
 
  G4bool generatePrimariesOnly;
  
private:
  G4Transform3D beamlineTransform;
 
  G4double beamlineS; 
  G4double mass2;     
  
  mutable const BDSBeamline* beamline;
};
 
#endif