BDSIM Data Structures

Here are the data structures with brief descriptions:
BDSAcceleratorComponentAbstract class that represents a component of an accelerator. It must be constructed with a name, length (arc), angle it induces (x,z plane in the local coordinates of the component) in the reference trajectory and a string representing its type. The class has no concept of its position in the beamline or in global coordinates. This information is contained in an instance of BDSBeamlineElement
BDSAcceleratorModelA holder class for all representations of the accelerator model created in BDSIM. Can be extend to allow inspection of the model. Holds the readout geometry physical world in a location independent of detector construction
BDSAnalysisManagerAnalysis interface class. Create, store and access histograms
BDSAwakeMultilayerScreen
BDSAwakeScintillatorScreen
BDSBackScatterBias
BDSBeamline
BDSBeamlineElementA class that holds a fully constructed BDSAcceleratorComponent as well as any information relevant to its position within the beamline. For example, position information as curvilinear s position coordinate as these are only defined with respect to the components position in the beamline / lattice
BDSBeamPipeA holder class for all information required for a piece of beampipe. This does not implement the construction of the beampipe
BDSBeamPipeFactory
BDSBeamPipeFactoryBaseAbstract base class for beampipe factory classes
BDSBeamPipeFactoryCircularFactory for circular beam pipes
BDSBeamPipeFactoryEllipticalFactory for elliptical beam pipes
BDSBeamPipeFactoryLHCFactory for simple lhc aperture model beam pipes
BDSBeamPipeFactoryLHCDetailedFactory for detailed lhc aperture model beam pipes
BDSBeamPipeFactoryRectangularFactory for rectangular beam pipes
BDSBeamPipeFactoryRectEllipseFactory for rectellipse aperture model beampipes
BDSBeamPipeInfoHolder struct of all information required to create a beam pipe. This reduces the number of argument to all magnet constructors plus aggregates common tasks in the component factory
BDSBinA histogram bin
BDSBunchParticle generator
BDSBunchCircle
BDSBunchComposite
BDSBunchEShell
BDSBunchFactoryFactory class for BDSBunch
BDSBunchGaussian
BDSBunchGP
BDSBunchHalo
BDSBunchInterface
BDSBunchPtc
BDSBunchRing
BDSBunchSquare
BDSBunchTwiss
BDSBunchUserFile
BDSBunchUserFile::Doublet
BDSCCDCamera
BDSCCDChip
BDSCCDPixel
BDSCCDPixelHit
BDSCCDPixelSD
BDSCollimatorBase
BDSCollimatorElliptical
BDSCollimatorRectangular
BDSComponentFactory
BDSComptonEngine
BDSContinuousSR
BDSCutsAndLimits
BDSDecapole
BDSDecMagField
BDSDecStepper
BDSDetectorConstruction
BDSDetectorSolenoidMagField
BDSDipoleStepper
BDSDrift
BDSDriftStepper
BDSDump
BDSDumpSD
BDSElement
BDSEnergyCounterHit
BDSEnergyCounterSD
BDSEventAction
BDSExecOptions
BDSGeometryComponentA generic geometry component for a bdsim model
BDSGeometryGDML
BDSGeometryInterfaceA class of functions to output Geant4/Mokka/BDSIM parameters for elements to include geometry, optics, fields, etc
BDSGeometryLCDD
BDSGeometrySQL
BDSGlobalConstantsClass that holds global options and constants
BDSHistogram1D1d-histogram class
BDSKicker
BDSLaserCompton
BDSLaserWire
BDSLens
BDSLensFacet
BDSLineClass that hold multiple accelerator components
BDSLogicalVolumeInfo
BDSLWCalorimeter
BDSLWCalorimeterHit
BDSLWCalorimeterSD
BDSMagField
BDSMagFieldSQL
BDSMagnet
BDSMagnetColours
BDSMagnetOuterFactory
BDSMagnetOuterFactoryBaseAbstract base class for magnet outer volume factories
BDSMagnetOuterFactoryCylindrical
BDSMagnetOuterFactoryLHCThe base factory for the LHC magnet geometry factory
BDSMagnetOuterFactoryLHCLeftLHC outer magnet geometry offset to the left
BDSMagnetOuterFactoryLHCRightLHC outer magnet geometry offset to the right
BDSMagnetOuterFactoryNone
BDSMagnetOuterFactoryPolesBaseFactory class for outer volume of magnets. Produces magnets with 2N-poles around the beampipe with a yoke of various shapes
BDSMagnetOuterFactoryPolesCircularFactory class for outer volume of magnets. Produces magnets with 2N-poles around the beampipe with a circular yoke
BDSMagnetOuterFactoryPolesFacetFactory class for outer volume of magnets. Produces magnets with 2N-poles around the beampipe with a faceted yoke - the yoke is perpendiular to the pole direction where the pole joins the yoke
BDSMagnetOuterFactoryPolesFacetCropFactory class for outer volume of magnets. Produces magnets with 2N-poles around the beampipe with a faceted yoke - the yoke is perpendiular to the pole direction where the pole joins the yoke. Between each pole there is a flat section angled between the two poles
BDSMagnetOuterFactoryPolesSquareFactory class for outer volume of magnets. Produces magnets with 2N-poles around the beampipe with a square yoke
BDSMagnetOuterInfoHolder struct of all information required to create the outer geometry of a magnet. This reduces the number of argument to all magnet constructors plus aggregates common tasks in the component factory
BDSMaterials
BDSModularPhysicsList
BDSMultiFacetLayer
BDSMultilayerScreen
BDSMultipole
BDSMultipoleMagField
BDSMultipoleOuterMagField
BDSMuonPhysics
BDSMuSpoiler
BDSMuSpoilerMagField
BDSMySQLTable
BDSMySQLVariable
BDSMySQLWrapper
BDSOctMagField
BDSOctStepper
BDSOctupole
BDSOutputASCIIASCII output class
BDSOutputBase
BDSOutputFactoryFactory class for BDSOutput
BDSOutputFormatDef
BDSOutputNoneNo output class
BDSOutputROOTROOT output class
BDSOutputVector
BDSParameterisationPhysics
BDSParticleParticle definition
BDSPCLTubePostCollisionLine Tube
BDSPhotonCounter
BDSPhysicsList
BDSPlanckEngine
BDSPlanckScatter
BDSPlanckScatterBuilder
BDSPrimaryGeneratorAction
BDSQuadMagField
BDSQuadrupole
BDSQuadStepper
BDSRBend
BDSReadOutGeometryClass that generates readout geometry for enegy counter sensitive detectors. A la Geant4, this would actually construct a 'parallel' (not to be confused with the G4ParallelWorld class, which is unrelated) world separately and after the main 'mass' world. However, this is really quite inconvenient so both are constructed at the same time from the same accelerator components and this is a dummy class required by Geant4 that simply gets the already constructed world and returns it
BDSRfCavity
BDSRunAction
BDSRunManager
BDSSampler
BDSSamplerCylinder
BDSSamplerHit
BDSSamplerSD
BDSSbendMagField
BDSScintillatorScreen
BDSScreenLayer
BDSScreenLayer::InternalMirror
BDSSDManagerA singleton class that holds all required sensitive detector class instances. Each sensitive detector class need only be instantiated once and attached to the relevant volume. More factorised geometry construction will mean SDs will be assigned in construction and not in detector construciton afterwards as a post processing step. This instantiates all necessary SDs and holds them
BDSSectorBend
BDSSextMagField
BDSSextStepper
BDSSextupole
BDSShowerModel
BDSSolenoid
BDSSolenoidMagField
BDSSolenoidStepper
BDSSpoiler
BDSStackingAction
BDSSteppingAction
BDSSynchRadPhysics
BDSSynchrotronRadiation
BDSTeleporter
BDSTeleporterStepper
BDSTerminator
BDSTerminatorSD
BDSTerminatorUserLimits
BDSTiltOffsetA holder for any placement offsets and rotations for a BDSAcceleratorComponent
BDSTrajectory
BDSTrajectoryPoint
BDSTransform3D
BDSTunnelInfoHolder struct of all information required to create the a section of tunnel. This reduces the number of argument to all constructors plus aggregates common tasks in the component factory
BDSTypeSafeEnum< def, inner >Improve type-safety of native enum data type in C++
BDSUserTrackingAction
BDSVProcess
BDSXSBias
BDSXSBiasPhysics
BDSXYMagField
beampipetypes_defType definition for beampipes - used for comparison in factory methods
CONST_REF
eBremsstrahlung_LPB
eBremsstrahlung_LPB_v2
GammaConversion_LPB
GammaConversion_LPB_v2
GGmadDriver
GZSTREAM_NAMESPACE::gzstreambase
GZSTREAM_NAMESPACE::gzstreambuf
GZSTREAM_NAMESPACE::igzstream
magnetgeometrytypes_defGeometry type definition for magnets - used for comparison in factory methods
magnettypes_defType definition for everything that inherits BDSMagnet - ie is a magnet
BDS::non_alphaLogical not for isalpha predictator as needed for string manipulations
GZSTREAM_NAMESPACE::ogzstream
POS_REF
ROT_REF
STANDALONE
strCmp
tunneltypes_defGeometry type definition for tunnel segments - used for comparison in factory methods
VIS_REF
XYFieldRecord

Generated on 28 Jun 2015 for BDSIM by  doxygen 1.4.7