A bunch distribution that produces an uncorrelated uniform random distribution within a square in phase space. More...
#include <BDSBunchSquare.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 () |
| BDSBunchSquare & | operator= (const BDSBunchSquare &)=delete |
| Assignment and copy constructor not implemented nor used. | |
| BDSBunchSquare (BDSBunchSquare &)=delete | |
| Assignment and copy constructor not implemented nor used. | |
 Public Member Functions inherited from BDSBunch | |
| 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. More... | |
| BDSParticleCoordsFullGlobal | GetNextParticle () |
| virtual G4bool | ExpectChangingParticleType () const |
| A hint of whether we expect to require and extended particle set (ie pions, kaons, muons). More... | |
| virtual BDSParticleCoordsFullGlobal | GetNextParticleValid (G4int maxTries=100) |
| virtual void | BeginOfRunAction (G4int numberOfEvents) |
| virtual const BDSParticleDefinition * | ParticleDefinition () const |
| Access the beam particle definition. More... | |
| 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. More... | |
| virtual void | RecreateAdvanceToEvent (G4int) |
| G4bool | BeamParticleIsAnIon () const |
| Access whether the beam particle is an ion or not. More... | |
| virtual void | UpdateIonDefinition () |
| G4bool | ParticleDefinitionHasBeenUpdated () const |
| G4String | Name () const |
Protected Attributes | |
| G4double | envelopeX |
| G4double | envelopeY |
| G4double | envelopeXp |
| G4double | envelopeYp |
| G4double | envelopeT |
| G4double | envelopeE |
| G4double | envelopeZ |
| G4bool | useEnvelopeZ |
| CLHEP::RandFlat * | flatGen |
| Protected Attributes inherited from BDSBunch | |
| G4String | name |
| Name of distribution. More... | |
| G4bool | useCurvilinear |
| Whether to ignore z and use s and transform for curvilinear coordinates. More... | |
| BDSParticleDefinition * | particleDefinition |
| Particle definition for bunch - this class owns it. More... | |
| G4bool | particleDefinitionHasBeenUpdated |
| G4bool | finiteTilt |
| G4bool | generatePrimariesOnly |
| G4double | X0 |
| Centre of distributions. More... | |
| G4double | Y0 |
| Centre of distributions. More... | |
| G4double | Z0 |
| Centre of distributions. More... | |
| G4double | S0 |
| Centre of distributions. More... | |
| G4double | T0 |
| Centre of distributions. More... | |
| G4double | Xp0 |
| Centre of distributions. More... | |
| G4double | Yp0 |
| Centre of distributions. More... | |
| G4double | Zp0 |
| Centre of distributions. More... | |
| G4double | E0 |
| Centre of distributions. More... | |
| G4double | P0 |
| central momentum More... | |
| G4double | tilt |
| Centre of distributions. More... | |
| G4double | sigmaT |
| Centre of distributions. More... | |
| G4double | sigmaP |
| Centre of distributions. More... | |
| G4double | sigmaE |
| Centre of distributions. More... | |
| G4double | sigmaEk |
| Centre of distributions. More... | |
| G4bool | finiteSigmaE |
| Flags to ignore random number generator in case of no finite E or T. More... | |
| G4bool | finiteSigmaT |
| Flags to ignore random number generator in case of no finite E or T. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from BDSBunch | |
| static G4double | CalculateZp (G4double xp, G4double yp, G4double Zp0) |
| Calculate zp safely based on other components. More... | |
| static void | SetEmittances (const BDSParticleDefinition *beamParticle, const GMAD::Beam &beam, G4double &emittGeometricX, G4double &emittGeometricY, G4double &emittNormalisedX, G4double &emittNormalisedY) |
| Protected Member Functions inherited from BDSBunch | |
| 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. More... | |
| BDSParticleCoordsFullGlobal | ApplyCurvilinearTransform (const BDSParticleCoordsFull &localIn) const |
| Calculate the global coordinates from curvilinear coordinates of a beam line. More... | |
Detailed Description
A bunch distribution that produces an uncorrelated uniform random distribution within a square in phase space.
Definition at line 35 of file BDSBunchSquare.hh.
Constructor & Destructor Documentation
◆ BDSBunchSquare()
| BDSBunchSquare::BDSBunchSquare | ( | ) |
Definition at line 29 of file BDSBunchSquare.cc.
◆ ~BDSBunchSquare()
|
virtual |
Definition at line 43 of file BDSBunchSquare.cc.
Member Function Documentation
◆ CheckParameters()
|
virtual |
Check the parameters for the given bunch distribution and exit if they're problematic or unphysical.
Reimplemented from BDSBunch.
Definition at line 65 of file BDSBunchSquare.cc.
References BDSBunch::CheckParameters().
◆ GetNextParticleLocal()
|
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 84 of file BDSBunchSquare.cc.
References BDSBunch::CalculateZp(), BDSBunch::E0, BDSBunch::S0, BDSBunch::T0, BDSBunch::X0, BDSBunch::Xp0, BDSBunch::Y0, BDSBunch::Yp0, BDSBunch::Z0, and BDSBunch::Zp0.
◆ SetOptions()
|
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 48 of file BDSBunchSquare.cc.
References GMAD::BeamBase::envelopeE, GMAD::BeamBase::envelopeT, GMAD::BeamBase::envelopeX, GMAD::BeamBase::envelopeXp, GMAD::BeamBase::envelopeY, GMAD::BeamBase::envelopeYp, GMAD::BeamBase::envelopeZ, GMAD::Beam::HasBeenSet(), and BDSBunch::SetOptions().
Field Documentation
◆ envelopeE
|
protected |
Definition at line 58 of file BDSBunchSquare.hh.
◆ envelopeT
|
protected |
Definition at line 57 of file BDSBunchSquare.hh.
◆ envelopeX
|
protected |
Definition at line 53 of file BDSBunchSquare.hh.
◆ envelopeXp
|
protected |
Definition at line 55 of file BDSBunchSquare.hh.
◆ envelopeY
|
protected |
Definition at line 54 of file BDSBunchSquare.hh.
◆ envelopeYp
|
protected |
Definition at line 56 of file BDSBunchSquare.hh.
◆ envelopeZ
|
protected |
Definition at line 59 of file BDSBunchSquare.hh.
◆ flatGen
|
protected |
Definition at line 62 of file BDSBunchSquare.hh.
◆ useEnvelopeZ
|
protected |
Definition at line 60 of file BDSBunchSquare.hh.
The documentation for this class was generated from the following files:
- /Users/nevay/physics/reps/bdsim/include/BDSBunchSquare.hh
- /Users/nevay/physics/reps/bdsim/src/BDSBunchSquare.cc
