Options for a beam distribution. More...

#include <beamBase.h>

Inheritance diagram for GMAD::BeamBase:

Collaboration diagram for GMAD::BeamBase:

Data Fields
int	nlinesIgnore
	Ignore first lines in the input bunch file.

int	nlinesSkip
	Number of event lines to skip after the ignore lines.

double	tilt
	tilt of beam applied as rotation about unit local z

double	sigmaT
	bunch length

double	sigmaE
	for the gaussian, elliptic shell, ring distributions

double	sigmaEk

double	sigmaP

bool	offsetSampleMean

std::vector< std::string >	setKeys
	A list of all the keys that have been set in this instance.


std::string	particle
	beam parameters

std::string	beamParticleName
	beam parameters

double	beamEnergy
	beam parameters

double	beamKineticEnergy
	beam parameters

double	beamMomentum
	beam parameters

std::string	distrType
	beam parameters

std::string	xDistrType
	beam parameters

std::string	yDistrType
	beam parameters

std::string	zDistrType
	beam parameters

std::string	spaceDistrType
	beam parameters

std::string	directionDistrType
	beam parameters

std::string	energyDistrType
	beam parameters

std::string	distrFile
	beam parameters

std::string	distrFileFormat
	beam parameters

bool	distrFileFromExecOptions
	Required to know how to build the absolute path properly.

bool	distrFileMatchLength
	beam parameters

bool	distrFileLoop
	beam parameters

int	distrFileLoopNTimes
	beam parameters

bool	removeUnstableWithoutDecay
	beam parameters


double	bunchFrequency
	Bunch offsets in time.

double	bunchPeriod
	Bunch offsets in time.

int	eventsPerBunch
	Bunch offsets in time.


double	X0
	initial beam centroid

double	Y0
	initial beam centroid

double	Z0
	initial beam centroid

double	S0
	initial beam centroid

double	Xp0
	initial beam centroid

double	Yp0
	initial beam centroid

double	Zp0
	initial beam centroid

double	T0
	initial beam centroid

double	E0
	initial beam centroid

double	Ek0
	initial beam centroid

double	P0
	initial beam centroid


double	betx
	initial twiss parameters

double	bety
	initial twiss parameters

double	alfx
	initial twiss parameters

double	alfy
	initial twiss parameters

double	emitx
	initial twiss parameters

double	emity
	initial twiss parameters

double	dispx
	initial twiss parameters

double	dispy
	initial twiss parameters

double	dispxp
	initial twiss parameters

double	dispyp
	initial twiss parameters

double	emitNX
	initial twiss parameters

double	emitNY
	initial twiss parameters


double	sigmaX
	for the gaussian beam distribution

double	sigmaXp
	for the gaussian beam distribution

double	sigmaY
	for the gaussian beam distribution

double	sigmaYp
	for the gaussian beam distribution


double	envelopeX
	for the circle/square/box beam distribution

double	envelopeXp
	for the circle/square/box beam distribution

double	envelopeY
	for the circle/square/box beam distribution

double	envelopeYp
	for the circle/square/box beam distribution

double	envelopeZ
	for the circle/square/box beam distribution

double	envelopeZp
	for the circle/square/box beam distribution

double	envelopeT
	for the circle/square/box beam distribution

double	envelopeE
	for the circle/square/box beam distribution

double	envelopeR
	for the circle/square/box beam distribution

double	envelopeRp
	for the circle/square/box beam distribution

bool	zFromT
	for the circle/square/box beam distribution


double	sigma11
	for the gaussian sigma matrix distribution

double	sigma12
	for the gaussian sigma matrix distribution

double	sigma13
	for the gaussian sigma matrix distribution

double	sigma14
	for the gaussian sigma matrix distribution

double	sigma15
	for the gaussian sigma matrix distribution

double	sigma16
	for the gaussian sigma matrix distribution

double	sigma22
	for the gaussian sigma matrix distribution

double	sigma23
	for the gaussian sigma matrix distribution

double	sigma24
	for the gaussian sigma matrix distribution

double	sigma25
	for the gaussian sigma matrix distribution

double	sigma26
	for the gaussian sigma matrix distribution

double	sigma33
	for the gaussian sigma matrix distribution

double	sigma34
	for the gaussian sigma matrix distribution

double	sigma35
	for the gaussian sigma matrix distribution

double	sigma36
	for the gaussian sigma matrix distribution

double	sigma44
	for the gaussian sigma matrix distribution

double	sigma45
	for the gaussian sigma matrix distribution

double	sigma46
	for the gaussian sigma matrix distribution

double	sigma55
	for the gaussian sigma matrix distribution

double	sigma56
	for the gaussian sigma matrix distribution

double	sigma66
	for the gaussian sigma matrix distribution


double	shellX
	for the elliptic shell distribution

double	shellXp
	for the elliptic shell distribution

double	shellY
	for the elliptic shell distribution

double	shellYp
	for the elliptic shell distribution

double	shellXWidth
	for the elliptic shell distribution

double	shellXpWidth
	for the elliptic shell distribution

double	shellYWidth
	for the elliptic shell distribution

double	shellYpWidth
	for the elliptic shell distribution


double	Rmin
	for the ring beam distribution

double	Rmax
	for the ring beam distribution


double	haloNSigmaXInner
	for the halo distribution

double	haloNSigmaXOuter
	for the halo distribution

double	haloNSigmaYInner
	for the halo distribution

double	haloNSigmaYOuter
	for the halo distribution

double	haloXCutInner
	for the halo distribution

double	haloYCutInner
	for the halo distribution

double	haloXCutOuter
	for the halo distribution

double	haloYCutOuter
	for the halo distribution

double	haloXpCutInner
	for the halo distribution

double	haloYpCutInner
	for the halo distribution

double	haloXpCutOuter
	for the halo distribution

double	haloYpCutOuter
	for the halo distribution

double	haloPSWeightParameter
	for the halo distribution

std::string	haloPSWeightFunction
	for the halo distribution


int	eventGeneratorNEventsSkip
	Event generator file filter.

double	eventGeneratorMinX
	Event generator file filter.

double	eventGeneratorMaxX
	Event generator file filter.

double	eventGeneratorMinY
	Event generator file filter.

double	eventGeneratorMaxY
	Event generator file filter.

double	eventGeneratorMinZ
	Event generator file filter.

double	eventGeneratorMaxZ
	Event generator file filter.

double	eventGeneratorMinXp
	Event generator file filter.

double	eventGeneratorMaxXp
	Event generator file filter.

double	eventGeneratorMinYp
	Event generator file filter.

double	eventGeneratorMaxYp
	Event generator file filter.

double	eventGeneratorMinZp
	Event generator file filter.

double	eventGeneratorMaxZp
	Event generator file filter.

double	eventGeneratorMinRp
	Event generator file filter.

double	eventGeneratorMaxRp
	Event generator file filter.

double	eventGeneratorMinT
	Event generator file filter.

double	eventGeneratorMaxT
	Event generator file filter.

double	eventGeneratorMinEK
	Event generator file filter.

double	eventGeneratorMaxEK
	Event generator file filter.

std::string	eventGeneratorParticles
	Event generator file filter.

bool	eventGeneratorWarnSkippedParticles
	Event generator file filter.

Detailed Description

Options for a beam distribution.

This is the basic structure that can be serialised in an output file and only contains built in C++ types. No Geant4 types are to be used. The Beam class inherits this one.

Definition at line 34 of file beamBase.h.

Constructor & Destructor Documentation

◆ BeamBase()

BeamBase::BeamBase ( )

Definition at line 25 of file beamBase.cc.

Field Documentation

◆ alfx

double GMAD::BeamBase::alfx

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), BDSBunchHaloFlatSigma::SetOptions(), and BDSBunchTwiss::SetOptions().

◆ alfy

double GMAD::BeamBase::alfy

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), BDSBunchHaloFlatSigma::SetOptions(), and BDSBunchTwiss::SetOptions().

◆ beamEnergy

double GMAD::BeamBase::beamEnergy

beam parameters

Definition at line 42 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ beamKineticEnergy

double GMAD::BeamBase::beamKineticEnergy

beam parameters

Definition at line 43 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ beamMomentum

double GMAD::BeamBase::beamMomentum

beam parameters

Definition at line 44 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ beamParticleName

std::string GMAD::BeamBase::beamParticleName

beam parameters

Definition at line 41 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ betx

double GMAD::BeamBase::betx

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), BDSBunchHaloFlatSigma::SetOptions(), and BDSBunchTwiss::SetOptions().

◆ bety

double GMAD::BeamBase::bety

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), BDSBunchHaloFlatSigma::SetOptions(), and BDSBunchTwiss::SetOptions().

◆ bunchFrequency

double GMAD::BeamBase::bunchFrequency

Bunch offsets in time.

Definition at line 64 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetOptions().

◆ bunchPeriod

double GMAD::BeamBase::bunchPeriod

Bunch offsets in time.

Definition at line 65 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetOptions().

◆ directionDistrType

std::string GMAD::BeamBase::directionDistrType

beam parameters

Definition at line 50 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchCompositeSDE::SetOptions().

◆ dispx

double GMAD::BeamBase::dispx

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchTwiss::SetOptions().

◆ dispxp

double GMAD::BeamBase::dispxp

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchTwiss::SetOptions().

◆ dispy

double GMAD::BeamBase::dispy

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchTwiss::SetOptions().

◆ dispyp

double GMAD::BeamBase::dispyp

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchTwiss::SetOptions().

◆ distrFile

std::string GMAD::BeamBase::distrFile

beam parameters

Definition at line 52 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), GMAD::Beam::PublishMembers(), BDSBunchPtc::SetOptions(), BDSBunchSixTrack::SetOptions(), and BDSBunchUserFile< T >::SetOptions().

◆ distrFileFormat

std::string GMAD::BeamBase::distrFileFormat

beam parameters

Definition at line 53 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchUserFile< T >::SetOptions().

◆ distrFileFromExecOptions

bool GMAD::BeamBase::distrFileFromExecOptions

Required to know how to build the absolute path properly.

Definition at line 54 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), and GMAD::Beam::PublishMembers().

◆ distrFileLoop

bool GMAD::BeamBase::distrFileLoop

beam parameters

Definition at line 56 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), GMAD::Beam::PublishMembers(), and BDSBunchFileBased::SetOptions().

◆ distrFileLoopNTimes

int GMAD::BeamBase::distrFileLoopNTimes

beam parameters

Definition at line 57 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), GMAD::Beam::PublishMembers(), and BDSBunchFileBased::SetOptions().

◆ distrFileMatchLength

bool GMAD::BeamBase::distrFileMatchLength

beam parameters

Definition at line 55 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), GMAD::Beam::PublishMembers(), BDSBunchPtc::SetOptions(), and BDSBunchUserFile< T >::SetOptions().

◆ distrType

std::string GMAD::BeamBase::distrType

beam parameters

Definition at line 45 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), BDSBunchFactory::CreateBunch(), BDSIMLink::Initialise(), and GMAD::Beam::PublishMembers().

◆ E0

double GMAD::BeamBase::E0

initial beam centroid

Definition at line 73 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ Ek0

double GMAD::BeamBase::Ek0

initial beam centroid

Definition at line 74 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ emitNX

double GMAD::BeamBase::emitNX

initial twiss parameters

Definition at line 91 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetEmittances().

◆ emitNY

double GMAD::BeamBase::emitNY

initial twiss parameters

Definition at line 91 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetEmittances().

◆ emitx

double GMAD::BeamBase::emitx

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetEmittances().

◆ emity

double GMAD::BeamBase::emity

initial twiss parameters

Definition at line 90 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetEmittances().

◆ energyDistrType

std::string GMAD::BeamBase::energyDistrType

beam parameters

Definition at line 51 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchCompositeSDE::SetOptions().

◆ envelopeE

double GMAD::BeamBase::envelopeE

for the circle/square/box beam distribution

Definition at line 100 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchBox::SetOptions(), BDSBunchSquare::SetOptions(), and BDSBunchCircle::SetOptions().

◆ envelopeR

double GMAD::BeamBase::envelopeR

for the circle/square/box beam distribution

Definition at line 101 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchCircle::SetOptions().

◆ envelopeRp

double GMAD::BeamBase::envelopeRp

for the circle/square/box beam distribution

Definition at line 101 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchCircle::SetOptions().

◆ envelopeT

double GMAD::BeamBase::envelopeT

for the circle/square/box beam distribution

Definition at line 100 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchBox::SetOptions(), BDSBunchSquare::SetOptions(), and BDSBunchCircle::SetOptions().

◆ envelopeX

double GMAD::BeamBase::envelopeX

for the circle/square/box beam distribution

Definition at line 99 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchBox::SetOptions(), and BDSBunchSquare::SetOptions().

◆ envelopeXp

double GMAD::BeamBase::envelopeXp

for the circle/square/box beam distribution

Definition at line 99 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchBox::SetOptions(), and BDSBunchSquare::SetOptions().

◆ envelopeY

double GMAD::BeamBase::envelopeY

for the circle/square/box beam distribution

Definition at line 99 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchBox::SetOptions(), and BDSBunchSquare::SetOptions().

◆ envelopeYp

double GMAD::BeamBase::envelopeYp

for the circle/square/box beam distribution

Definition at line 99 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchBox::SetOptions(), and BDSBunchSquare::SetOptions().

◆ envelopeZ

double GMAD::BeamBase::envelopeZ

for the circle/square/box beam distribution

Definition at line 99 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchSquare::SetOptions().

◆ envelopeZp

double GMAD::BeamBase::envelopeZp

for the circle/square/box beam distribution

Definition at line 99 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers().

◆ eventGeneratorMaxEK

double GMAD::BeamBase::eventGeneratorMaxEK

Event generator file filter.

Definition at line 161 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxRp

double GMAD::BeamBase::eventGeneratorMaxRp

Event generator file filter.

Definition at line 157 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxT

double GMAD::BeamBase::eventGeneratorMaxT

Event generator file filter.

Definition at line 159 of file beamBase.h.

Referenced by BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxX

double GMAD::BeamBase::eventGeneratorMaxX

Event generator file filter.

Definition at line 145 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxXp

double GMAD::BeamBase::eventGeneratorMaxXp

Event generator file filter.

Definition at line 151 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxY

double GMAD::BeamBase::eventGeneratorMaxY

Event generator file filter.

Definition at line 147 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxYp

double GMAD::BeamBase::eventGeneratorMaxYp

Event generator file filter.

Definition at line 153 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxZ

double GMAD::BeamBase::eventGeneratorMaxZ

Event generator file filter.

Definition at line 149 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMaxZp

double GMAD::BeamBase::eventGeneratorMaxZp

Event generator file filter.

Definition at line 155 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinEK

double GMAD::BeamBase::eventGeneratorMinEK

Event generator file filter.

Definition at line 160 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinRp

double GMAD::BeamBase::eventGeneratorMinRp

Event generator file filter.

Definition at line 156 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinT

double GMAD::BeamBase::eventGeneratorMinT

Event generator file filter.

Definition at line 158 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinX

double GMAD::BeamBase::eventGeneratorMinX

Event generator file filter.

Definition at line 144 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinXp

double GMAD::BeamBase::eventGeneratorMinXp

Event generator file filter.

Definition at line 150 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinY

double GMAD::BeamBase::eventGeneratorMinY

Event generator file filter.

Definition at line 146 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinYp

double GMAD::BeamBase::eventGeneratorMinYp

Event generator file filter.

Definition at line 152 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinZ

double GMAD::BeamBase::eventGeneratorMinZ

Event generator file filter.

Definition at line 148 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorMinZp

double GMAD::BeamBase::eventGeneratorMinZp

Event generator file filter.

Definition at line 154 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorNEventsSkip

int GMAD::BeamBase::eventGeneratorNEventsSkip

Event generator file filter.

Definition at line 143 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorParticles

std::string GMAD::BeamBase::eventGeneratorParticles

Event generator file filter.

Definition at line 162 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEventGenerator::SetOptions().

◆ eventGeneratorWarnSkippedParticles

bool GMAD::BeamBase::eventGeneratorWarnSkippedParticles

Event generator file filter.

Definition at line 163 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), and GMAD::Beam::PublishMembers().

◆ eventsPerBunch

int GMAD::BeamBase::eventsPerBunch

Bunch offsets in time.

Definition at line 66 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunch::SetOptions().

◆ haloNSigmaXInner

double GMAD::BeamBase::haloNSigmaXInner

for the halo distribution

Definition at line 124 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), and BDSBunchHaloFlatSigma::SetOptions().

◆ haloNSigmaXOuter

double GMAD::BeamBase::haloNSigmaXOuter

for the halo distribution

Definition at line 125 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), and BDSBunchHaloFlatSigma::SetOptions().

◆ haloNSigmaYInner

double GMAD::BeamBase::haloNSigmaYInner

for the halo distribution

Definition at line 126 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), and BDSBunchHaloFlatSigma::SetOptions().

◆ haloNSigmaYOuter

double GMAD::BeamBase::haloNSigmaYOuter

for the halo distribution

Definition at line 127 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchHalo::SetOptions(), and BDSBunchHaloFlatSigma::SetOptions().

◆ haloPSWeightFunction

std::string GMAD::BeamBase::haloPSWeightFunction

for the halo distribution

Definition at line 137 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloPSWeightParameter

double GMAD::BeamBase::haloPSWeightParameter

for the halo distribution

Definition at line 136 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloXCutInner

double GMAD::BeamBase::haloXCutInner

for the halo distribution

Definition at line 128 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloXCutOuter

double GMAD::BeamBase::haloXCutOuter

for the halo distribution

Definition at line 130 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloXpCutInner

double GMAD::BeamBase::haloXpCutInner

for the halo distribution

Definition at line 132 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloXpCutOuter

double GMAD::BeamBase::haloXpCutOuter

for the halo distribution

Definition at line 134 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloYCutInner

double GMAD::BeamBase::haloYCutInner

for the halo distribution

Definition at line 129 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloYCutOuter

double GMAD::BeamBase::haloYCutOuter

for the halo distribution

Definition at line 131 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloYpCutInner

double GMAD::BeamBase::haloYpCutInner

for the halo distribution

Definition at line 133 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ haloYpCutOuter

double GMAD::BeamBase::haloYpCutOuter

for the halo distribution

Definition at line 135 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchHalo::SetOptions().

◆ nlinesIgnore

int GMAD::BeamBase::nlinesIgnore

Ignore first lines in the input bunch file.

Definition at line 60 of file beamBase.h.

Referenced by GMAD::Beam::Amalgamate(), GMAD::Beam::PublishMembers(), BDSBunchPtc::SetOptions(), and BDSBunchUserFile< T >::SetOptions().

◆ nlinesSkip

int GMAD::BeamBase::nlinesSkip

Number of event lines to skip after the ignore lines.

Definition at line 61 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), BDSBunchPtc::SetOptions(), and BDSBunchUserFile< T >::SetOptions().

◆ offsetSampleMean

bool GMAD::BeamBase::offsetSampleMean

Definition at line 140 of file beamBase.h.

◆ P0

double GMAD::BeamBase::P0

initial beam centroid

Definition at line 75 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ particle

std::string GMAD::BeamBase::particle

beam parameters

Definition at line 40 of file beamBase.h.

Referenced by BDS::ConstructDesignAndBeamParticle(), and GMAD::Beam::PublishMembers().

◆ removeUnstableWithoutDecay

bool GMAD::BeamBase::removeUnstableWithoutDecay

beam parameters

Definition at line 58 of file beamBase.h.

Referenced by BDSPrimaryGeneratorFile::ConstructGenerator(), and GMAD::Beam::PublishMembers().

◆ Rmax

double GMAD::BeamBase::Rmax

for the ring beam distribution

Definition at line 120 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchRing::SetOptions().

◆ Rmin

double GMAD::BeamBase::Rmin

for the ring beam distribution

Definition at line 120 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchRing::SetOptions().

◆ S0

double GMAD::BeamBase::S0

initial beam centroid

Definition at line 70 of file beamBase.h.

Referenced by BDSParser::CheckOptions(), GMAD::Beam::PublishMembers(), and BDSBunch::SetOptions().

◆ setKeys

std::vector<std::string> GMAD::BeamBase::setKeys

A list of all the keys that have been set in this instance.

Definition at line 167 of file beamBase.h.

Referenced by GMAD::Beam::Amalgamate(), GMAD::Beam::HasBeenSet(), and GMAD::Beam::set_value().

◆ shellX

double GMAD::BeamBase::shellX

for the elliptic shell distribution

Definition at line 115 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellXp

double GMAD::BeamBase::shellXp

for the elliptic shell distribution

Definition at line 115 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellXpWidth

double GMAD::BeamBase::shellXpWidth

for the elliptic shell distribution

Definition at line 116 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellXWidth

double GMAD::BeamBase::shellXWidth

for the elliptic shell distribution

Definition at line 116 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellY

double GMAD::BeamBase::shellY

for the elliptic shell distribution

Definition at line 115 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellYp

double GMAD::BeamBase::shellYp

for the elliptic shell distribution

Definition at line 115 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellYpWidth

double GMAD::BeamBase::shellYpWidth

for the elliptic shell distribution

Definition at line 116 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().

◆ shellYWidth

double GMAD::BeamBase::shellYWidth

for the elliptic shell distribution

Definition at line 116 of file beamBase.h.

Referenced by GMAD::Beam::PublishMembers(), and BDSBunchEShell::SetOptions().