A 6D Gaussian distribution based on a covariance matrix. More...

#include <BDSBunchSigmaMatrix.hh>

Inheritance diagram for BDSBunchSigmaMatrix:

Collaboration diagram for BDSBunchSigmaMatrix:

Public Member Functions
virtual void	SetOptions (const BDSParticleDefinition *beamParticle, const GMAD::Beam &beam, const BDSBunchType &distrType, G4Transform3D beamlineTransformIn=G4Transform3D::Identity, const G4double beamlineS=0)

Public Member Functions inherited from BDSBunchGaussian
	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)

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. 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

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 BDSBunchGaussian
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. More...

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

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...

Protected Attributes inherited from BDSBunchGaussian
CLHEP::HepVector	meansGM

CLHEP::HepSymMatrix	sigmaGM

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

G4bool	offsetSampleMean
	Whether to offset the sample mean. More...

G4int	iPartIteration
	Iterator for reading out pre-calculate coordinates. More...

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

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

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

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

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

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

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

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

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

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

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...

Detailed Description

A 6D Gaussian distribution based on a covariance matrix.

Author: Stewart Boogert

Definition at line 37 of file BDSBunchSigmaMatrix.hh.

Constructor & Destructor Documentation

◆ BDSBunchSigmaMatrix()

BDSBunchSigmaMatrix::BDSBunchSigmaMatrix ( )

Definition at line 31 of file BDSBunchSigmaMatrix.cc.

◆ ~BDSBunchSigmaMatrix()

virtual BDSBunchSigmaMatrix::~BDSBunchSigmaMatrix ( )

inlinevirtual

Definition at line 41 of file BDSBunchSigmaMatrix.hh.

Member Function Documentation

◆ SetOptions()

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

Definition at line 35 of file BDSBunchSigmaMatrix.cc.

Here is the call graph for this function:

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

/Users/nevay/physics/reps/bdsim/include/BDSBunchSigmaMatrix.hh
/Users/nevay/physics/reps/bdsim/src/BDSBunchSigmaMatrix.cc