BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
|
Bunch halo distribution where the PDF is uniformly distribution in sigma. More...
#include <BDSBunchHaloFlatSigma.hh>
Public Member Functions | |
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 BDSParticleCoordsFull | GetNextParticleLocal () |
![]() | |
BDSBunch (const G4String &nameIn) | |
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 () |
Any initialisation - to be used after SetOptions, then CheckParameters. | |
BDSParticleCoordsFullGlobal | GetNextParticle () |
virtual G4bool | ExpectChangingParticleType () const |
A hint of whether we expect to require and extended particle set (ie pions, kaons, muons). | |
virtual BDSParticleCoordsFullGlobal | GetNextParticleValid (G4int maxTries=100) |
virtual void | BeginOfRunAction (G4int numberOfEvents, G4bool batchMode) |
virtual const BDSParticleDefinition * | ParticleDefinition () const |
Access the beam particle definition. | |
virtual void | SetGeneratePrimariesOnly (G4bool generatePrimariesOnlyIn) |
virtual BDSParticleCoordsFull | GetNextParticleLocal () |
G4bool | UseCurvilinearTransform () const |
Access whether there's a finite S offset and therefore we're using a CL transform. | |
virtual void | RecreateAdvanceToEvent (G4int eventOffset) |
G4bool | BeamParticleIsAnIon () const |
Access whether the beam particle is an ion or not. | |
virtual void | UpdateIonDefinition () |
G4bool | ParticleDefinitionHasBeenUpdated () const |
G4String | Name () const |
Distribution name. | |
G4int | CurrentBunchIndex () const |
Get the current bunch index for writing to output. | |
void | CalculateBunchIndex (G4int eventIndex) |
Calculate which bunch index we should be at given an event index. | |
Private Attributes | |
G4double | haloNSigmaXInner |
G4double | haloNSigmaXOuter |
G4double | haloNSigmaYInner |
G4double | haloNSigmaYOuter |
G4double | alphaX |
Twiss parameter. | |
G4double | alphaY |
Twiss parameter. | |
G4double | betaX |
Twiss parameter. | |
G4double | betaY |
Twiss parameter. | |
G4double | emitX |
Twiss parameter. | |
G4double | emitY |
Twiss parameter. | |
G4double | sigmaX |
Twiss parameter. | |
G4double | sigmaY |
Twiss parameter. | |
Additional Inherited Members | |
![]() | |
static G4double | CalculateZp (G4double xp, G4double yp, G4double Zp0) |
Calculate zp safely based on other components. | |
static void | SetEmittances (const BDSParticleDefinition *beamParticle, const GMAD::Beam &beam, G4double &emittGeometricX, G4double &emittGeometricY, G4double &emittNormalisedX, G4double &emittNormalisedY) |
![]() | |
BDSParticleCoordsFullGlobal | ApplyTransform (const BDSParticleCoordsFull &localIn) const |
void | ApplyTilt (BDSParticleCoordsFull &localIn) const |
Apply a rotation about unitZ for the local coordinates according to member variable tilt. | |
void | ApplyBunchTiming (BDSParticleCoordsFullGlobal &localIn) const |
Add on the offset in T for the current bunch number (i*bunchPeriod). | |
BDSParticleCoordsFullGlobal | ApplyCurvilinearTransform (const BDSParticleCoordsFull &localIn) const |
Calculate the global coordinates from curvilinear coordinates of a beam line. | |
![]() | |
G4String | name |
Name of distribution. | |
G4bool | useCurvilinear |
Whether to ignore z and use s and transform for curvilinear coordinates. | |
BDSParticleDefinition * | particleDefinition |
Particle definition for bunch - this class owns it. | |
G4bool | particleDefinitionHasBeenUpdated |
G4bool | finiteTilt |
G4bool | generatePrimariesOnly |
G4double | X0 |
Centre of distributions. | |
G4double | Y0 |
Centre of distributions. | |
G4double | Z0 |
Centre of distributions. | |
G4double | S0 |
Centre of distributions. | |
G4double | T0 |
Centre of distributions. | |
G4double | Xp0 |
Centre of distributions. | |
G4double | Yp0 |
Centre of distributions. | |
G4double | Zp0 |
Centre of distributions. | |
G4double | E0 |
Centre of distributions. | |
G4double | P0 |
central momentum | |
G4double | tilt |
Centre of distributions. | |
G4double | sigmaT |
Centre of distributions. | |
G4double | sigmaP |
Centre of distributions. | |
G4double | sigmaE |
Centre of distributions. | |
G4double | sigmaEk |
Centre of distributions. | |
bool | useBunchTiming |
Bunch offset in time parameters. | |
G4int | currentBunchIndex |
Bunch offset in time parameters. | |
G4int | eventsPerBunch |
Bunch offset in time parameters. | |
G4double | bunchPeriod |
Bunch offset in time parameters. | |
G4bool | finiteSigmaE |
Flags to ignore random number generator in case of no finite E or T. | |
G4bool | finiteSigmaT |
Flags to ignore random number generator in case of no finite E or T. | |
Bunch halo distribution where the PDF is uniformly distribution in sigma.
Definition at line 146 of file BDSBunchHaloFlatSigma.hh.
BDSBunchHaloFlatSigma::BDSBunchHaloFlatSigma | ( | ) |
Definition at line 110 of file BDSBunchHaloFlatSigma.cc.
|
inlinevirtual |
Definition at line 150 of file BDSBunchHaloFlatSigma.hh.
|
virtual |
Check the parameters for the given bunch distribution and exit if they're problematic or unphysical.
Reimplemented from BDSBunch.
Definition at line 180 of file BDSBunchHaloFlatSigma.cc.
References BDSBunch::CheckParameters(), emitX, and emitY.
Referenced by SetOptions().
|
virtual |
Each derived class can override this default method of reference position. If S0 > 0 or derived class changes member bool 'curvilinear' z0 will be treated as S and the global z0 be calculated.
Reimplemented from BDSBunch.
Definition at line 145 of file BDSBunchHaloFlatSigma.cc.
References alphaX, alphaY, betaX, betaY, BDSBunch::CalculateZp(), BDSBunch::E0, BDSBunch::S0, sigmaX, sigmaY, BDSBunch::T0, BDSBunch::X0, BDSBunch::Xp0, BDSBunch::Y0, BDSBunch::Yp0, and BDSBunch::Zp0.
|
virtual |
Extract and set the relevant options from the beam definition. The distribution type is explicitly required as this function may be used inside a nested bunch distribution. This argument is for the most part ignored, but there's no way to have a default for it. Also, some classes can cover multiple input distributions so need to know which one they're meant to be.
Reimplemented from BDSBunch.
Definition at line 120 of file BDSBunchHaloFlatSigma.cc.
References GMAD::BeamBase::alfx, GMAD::BeamBase::alfy, alphaX, alphaY, betaX, betaY, GMAD::BeamBase::betx, GMAD::BeamBase::bety, CheckParameters(), emitX, emitY, GMAD::BeamBase::haloNSigmaXInner, GMAD::BeamBase::haloNSigmaXOuter, GMAD::BeamBase::haloNSigmaYInner, GMAD::BeamBase::haloNSigmaYOuter, BDSBunch::SetEmittances(), BDSBunch::SetOptions(), sigmaX, and sigmaY.
|
private |
Twiss parameter.
Definition at line 161 of file BDSBunchHaloFlatSigma.hh.
Referenced by GetNextParticleLocal(), and SetOptions().
|
private |
Twiss parameter.
Definition at line 162 of file BDSBunchHaloFlatSigma.hh.
Referenced by GetNextParticleLocal(), and SetOptions().
|
private |
Twiss parameter.
Definition at line 163 of file BDSBunchHaloFlatSigma.hh.
Referenced by GetNextParticleLocal(), and SetOptions().
|
private |
Twiss parameter.
Definition at line 164 of file BDSBunchHaloFlatSigma.hh.
Referenced by GetNextParticleLocal(), and SetOptions().
|
private |
Twiss parameter.
Definition at line 165 of file BDSBunchHaloFlatSigma.hh.
Referenced by CheckParameters(), and SetOptions().
|
private |
Twiss parameter.
Definition at line 166 of file BDSBunchHaloFlatSigma.hh.
Referenced by CheckParameters(), and SetOptions().
|
private |
Definition at line 171 of file BDSBunchHaloFlatSigma.hh.
|
private |
Definition at line 172 of file BDSBunchHaloFlatSigma.hh.
|
private |
Definition at line 173 of file BDSBunchHaloFlatSigma.hh.
|
private |
Definition at line 174 of file BDSBunchHaloFlatSigma.hh.
|
private |
Twiss parameter.
Definition at line 167 of file BDSBunchHaloFlatSigma.hh.
Referenced by GetNextParticleLocal(), and SetOptions().
|
private |
Twiss parameter.
Definition at line 168 of file BDSBunchHaloFlatSigma.hh.
Referenced by GetNextParticleLocal(), and SetOptions().