A bunch distribution that produces an uncorrelated uniform random distribution within a square in phase space. More...

#include <BDSBunchSquare.hh>

Inheritance diagram for BDSBunchSquare:

Collaboration diagram for BDSBunchSquare:

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.

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.

Protected Attributes
G4double	envelopeX

G4double	envelopeY

G4double	envelopeXp

G4double	envelopeYp

G4double	envelopeT

G4double	envelopeE

G4double	envelopeZ

G4bool	correlatedZWithT

Protected Attributes inherited from BDSBunch
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.

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.

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.

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.

Detailed Description

A bunch distribution that produces an uncorrelated uniform random distribution within a square in phase space.

Author: Stewart Boogert

Definition at line 31 of file BDSBunchSquare.hh.

Constructor & Destructor Documentation

◆ BDSBunchSquare()

BDSBunchSquare::BDSBunchSquare ( )

Definition at line 29 of file BDSBunchSquare.cc.

◆ ~BDSBunchSquare()

BDSBunchSquare::~BDSBunchSquare ( )

virtual

Definition at line 41 of file BDSBunchSquare.cc.

Member Function Documentation

◆ CheckParameters()

void BDSBunchSquare::CheckParameters ( )

virtual

Check the parameters for the given bunch distribution and exit if they're problematic or unphysical.

Reimplemented from BDSBunch.

Definition at line 61 of file BDSBunchSquare.cc.

References BDSBunch::CheckParameters().

Here is the call graph for this function:

◆ GetNextParticleLocal()

BDSParticleCoordsFull BDSBunchSquare::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 80 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.

Here is the call graph for this function:

◆ SetOptions()

void BDSBunchSquare::SetOptions	(	const BDSParticleDefinition *	beamParticle,
		const GMAD::Beam &	beam,
		const BDSBunchType &	distrType,
		G4Transform3D	beamlineTransformIn = `G4Transform3D::Identity`,
		const G4double	beamlineS = `0`
	)

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 44 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, BDSBunch::SetOptions(), and GMAD::BeamBase::zFromT.

Here is the call graph for this function:

Field Documentation

◆ correlatedZWithT

G4bool BDSBunchSquare::correlatedZWithT

protected

Definition at line 56 of file BDSBunchSquare.hh.

◆ envelopeE

G4double BDSBunchSquare::envelopeE

protected

Definition at line 54 of file BDSBunchSquare.hh.

◆ envelopeT

G4double BDSBunchSquare::envelopeT

protected

Definition at line 53 of file BDSBunchSquare.hh.

◆ envelopeX

G4double BDSBunchSquare::envelopeX

protected

Definition at line 49 of file BDSBunchSquare.hh.

◆ envelopeXp

G4double BDSBunchSquare::envelopeXp

protected

Definition at line 51 of file BDSBunchSquare.hh.

◆ envelopeY

G4double BDSBunchSquare::envelopeY

protected

Definition at line 50 of file BDSBunchSquare.hh.

◆ envelopeYp

G4double BDSBunchSquare::envelopeYp

protected

Definition at line 52 of file BDSBunchSquare.hh.

◆ envelopeZ

G4double BDSBunchSquare::envelopeZ

protected

Definition at line 55 of file BDSBunchSquare.hh.

The documentation for this class was generated from the following files:

/Users/lnevay/physics/reps/bdsim/include/BDSBunchSquare.hh
/Users/lnevay/physics/reps/bdsim/src/BDSBunchSquare.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BDSBunchSquare()

◆ ~BDSBunchSquare()

Member Function Documentation

◆ CheckParameters()

◆ GetNextParticleLocal()

◆ SetOptions()

Field Documentation

◆ correlatedZWithT

◆ envelopeE

◆ envelopeT

◆ envelopeX

◆ envelopeXp

◆ envelopeY

◆ envelopeYp

◆ envelopeZ