Common functionality for a 6D Gaussian distribution. More...

#include <BDSBunchGaussian.hh>

Inheritance diagram for BDSBunchGaussian:

Collaboration diagram for BDSBunchGaussian:

Public Member Functions
	BDSBunchGaussian (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	BeginOfRunAction (G4int numberOfEvents, G4bool batchMode)

virtual BDSParticleCoordsFull	GetNextParticleLocal ()

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 Member Functions
CLHEP::RandMultiGauss *	CreateMultiGauss (CLHEP::HepRandomEngine &anEngine, const CLHEP::HepVector &mu, CLHEP::HepSymMatrix &sigma)

void	PreGenerateEvents (G4int nGenerate)
	Pre-generate all the particle coordinates and subtract the sample mean.

virtual BDSParticleCoordsFull	GetNextParticleLocalCoords ()
	Fire random number generator and get coordinates. Can be overloaded if required.

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.

Protected Attributes
CLHEP::HepVector	meansGM

CLHEP::HepSymMatrix	sigmaGM

CLHEP::RandMultiGauss *	gaussMultiGen
	Randon number generator with sigma matrix and mean.

G4bool	offsetSampleMean
	Whether to offset the sample mean.

G4int	iPartIteration
	Iterator for reading out pre-calculate coordinates.

std::vector< std::vector< G4double > * >	coordinates
	Convenience vector of vectors for clearing up.


std::vector< G4double >	x0_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	xp_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	y0_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	yp_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	z0_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	zp_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	E_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	t_v
	Holder for pre-calculated coordinates.

std::vector< G4double >	weight_v
	Holder for pre-calculated coordinates.

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)

Detailed Description

Common functionality for a 6D Gaussian distribution.

Author: Stewart Boogert

Definition at line 49 of file BDSBunchGaussian.hh.

Constructor & Destructor Documentation

◆ BDSBunchGaussian()

BDSBunchGaussian::BDSBunchGaussian ( const G4String & nameIn )

explicit

Definition at line 54 of file BDSBunchGaussian.cc.

◆ ~BDSBunchGaussian()

BDSBunchGaussian::~BDSBunchGaussian ( )

virtual

Definition at line 65 of file BDSBunchGaussian.cc.

Member Function Documentation

◆ BeginOfRunAction()

void BDSBunchGaussian::BeginOfRunAction	(	G4int	numberOfEvents,
		G4bool	batchMode
	)

virtual

Called at the beginning of a run. Override here to call PreGenerateEvents that will generate all coordinates and subtract the sample mean.

clear previous means

Reimplemented from BDSBunch.

Definition at line 98 of file BDSBunchGaussian.cc.

References coordinates, iPartIteration, offsetSampleMean, and PreGenerateEvents().

Here is the call graph for this function:

◆ CreateMultiGauss()

CLHEP::RandMultiGauss * BDSBunchGaussian::CreateMultiGauss	(	CLHEP::HepRandomEngine &	anEngine,
		const CLHEP::HepVector &	mu,
		CLHEP::HepSymMatrix &	sigma
	)

protected

Create multidimensional Gaussian random number generator for Twiss and Gauss. Can change sigma matrix to make non-definite.

check if sigma matrix is positive definite if not add small offset and cout warning

Definition at line 111 of file BDSBunchGaussian.cc.

Referenced by BDSBunchSigmaMatrix::SetOptions(), and BDSBunchTwiss::SetOptions().

Here is the caller graph for this function:

◆ GetNextParticleLocal()

BDSParticleCoordsFull BDSBunchGaussian::GetNextParticleLocal ( )

virtual

Either draw from the vector of already created points or fire fresh from the matrix.

Reimplemented from BDSBunch.

Definition at line 229 of file BDSBunchGaussian.cc.

References E_v, GetNextParticleLocalCoords(), iPartIteration, offsetSampleMean, BDSBunch::S0, t_v, weight_v, x0_v, xp_v, y0_v, yp_v, z0_v, and zp_v.

Here is the call graph for this function:

◆ GetNextParticleLocalCoords()

BDSParticleCoordsFull BDSBunchGaussian::GetNextParticleLocalCoords ( )

protectedvirtual

Fire random number generator and get coordinates. Can be overloaded if required.

Definition at line 253 of file BDSBunchGaussian.cc.

References BDSBunch::CalculateZp(), BDSBunch::E0, BDSBunch::finiteSigmaE, BDSBunch::finiteSigmaT, gaussMultiGen, BDSBunch::S0, BDSBunch::T0, BDSBunch::Z0, and BDSBunch::Zp0.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PreGenerateEvents()

void BDSBunchGaussian::PreGenerateEvents ( G4int nGenerate )

protected

Pre-generate all the particle coordinates and subtract the sample mean.

Definition at line 164 of file BDSBunchGaussian.cc.

References BDSBunch::E0, E_v, GetNextParticleLocalCoords(), BDSBunch::T0, t_v, weight_v, BDSBunch::X0, x0_v, BDSBunch::Xp0, xp_v, BDSBunch::Y0, y0_v, BDSBunch::Yp0, yp_v, BDSBunch::Z0, z0_v, BDSBunch::Zp0, and zp_v.

Referenced by BeginOfRunAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOptions()

void BDSBunchGaussian::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.

Reimplemented in BDSBunchSigmaMatrix, and BDSBunchTwiss.

Definition at line 70 of file BDSBunchGaussian.cc.

References BDSBunch::finiteSigmaE, BDSBunch::finiteSigmaT, iPartIteration, offsetSampleMean, BDSBunch::SetOptions(), BDSBunch::sigmaE, BDSBunch::sigmaT, BDSBunch::T0, BDSBunch::X0, BDSBunch::Xp0, BDSBunch::Y0, and BDSBunch::Yp0.

Referenced by BDSBunchSigmaMatrix::SetOptions(), and BDSBunchTwiss::SetOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ coordinates

std::vector<std::vector<G4double>* > BDSBunchGaussian::coordinates

protected

Convenience vector of vectors for clearing up.

Definition at line 98 of file BDSBunchGaussian.hh.

Referenced by BeginOfRunAction().

◆ E_v

std::vector<G4double> BDSBunchGaussian::E_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ gaussMultiGen

CLHEP::RandMultiGauss* BDSBunchGaussian::gaussMultiGen

protected

Randon number generator with sigma matrix and mean.

Definition at line 88 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocalCoords(), BDSBunchSigmaMatrix::SetOptions(), and BDSBunchTwiss::SetOptions().

◆ iPartIteration

G4int BDSBunchGaussian::iPartIteration

protected

Iterator for reading out pre-calculate coordinates.

Definition at line 95 of file BDSBunchGaussian.hh.

Referenced by BeginOfRunAction(), GetNextParticleLocal(), and SetOptions().

◆ meansGM

CLHEP::HepVector BDSBunchGaussian::meansGM

protected

Definition at line 84 of file BDSBunchGaussian.hh.

◆ offsetSampleMean

G4bool BDSBunchGaussian::offsetSampleMean

protected

Whether to offset the sample mean.

Definition at line 90 of file BDSBunchGaussian.hh.

Referenced by BeginOfRunAction(), GetNextParticleLocal(), and SetOptions().

◆ sigmaGM

CLHEP::HepSymMatrix BDSBunchGaussian::sigmaGM

protected

Definition at line 85 of file BDSBunchGaussian.hh.

◆ t_v

std::vector<G4double> BDSBunchGaussian::t_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ weight_v

std::vector<G4double> BDSBunchGaussian::weight_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ x0_v

std::vector<G4double> BDSBunchGaussian::x0_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ xp_v

std::vector<G4double> BDSBunchGaussian::xp_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ y0_v

std::vector<G4double> BDSBunchGaussian::y0_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ yp_v

std::vector<G4double> BDSBunchGaussian::yp_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ z0_v

std::vector<G4double> BDSBunchGaussian::z0_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

◆ zp_v

std::vector<G4double> BDSBunchGaussian::zp_v

protected

Holder for pre-calculated coordinates.

Definition at line 93 of file BDSBunchGaussian.hh.

Referenced by GetNextParticleLocal(), and PreGenerateEvents().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BDSBunchGaussian()

◆ ~BDSBunchGaussian()

Member Function Documentation

◆ BeginOfRunAction()

◆ CreateMultiGauss()

◆ GetNextParticleLocal()

◆ GetNextParticleLocalCoords()

◆ PreGenerateEvents()

◆ SetOptions()

Field Documentation

◆ coordinates

◆ E_v

◆ gaussMultiGen

◆ iPartIteration

◆ meansGM

◆ offsetSampleMean

◆ sigmaGM

◆ t_v

◆ weight_v

◆ x0_v

◆ xp_v

◆ y0_v

◆ yp_v

◆ z0_v

◆ zp_v