BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Public Member Functions
BDSOutputNone Class Reference

No output class. More...

#include <BDSOutputNone.hh>

Inheritance diagram for BDSOutputNone:
Inheritance graph
Collaboration diagram for BDSOutputNone:
Collaboration graph

Public Member Functions

 BDSOutputNone ()
 Default constructor. More...
 
- Public Member Functions inherited from BDSOutput
 BDSOutput (const G4String &baseFileNameIn, const G4String &fileExtentionIn, G4int fileNumberOffset)
 Constructor with base file name (without extension or number suffix). More...
 
virtual void NewFile ()=0
 Open a new file. This should call WriteHeader() in it. More...
 
virtual void CloseFile ()=0
 
virtual void InitialiseGeometryDependent ()
 
virtual void UpdateSamplers ()
 Interface to allow updating samplers with dynamic construction. Only for link - not for regular use. More...
 
void FillHeader ()
 Fill the local structure header with information - updates time stamp. More...
 
void FillParticleData (G4bool writeIons)
 Fill the local structure particle data with information. Also calls WriteParticleData(). More...
 
void FillBeam (const GMAD::BeamBase *beam)
 
void FillOptions (const GMAD::OptionsBase *options)
 
void FillModel ()
 
void FillEventPrimaryOnly (const BDSParticleCoordsFullGlobal &coords, const BDSParticleDefinition *particle)
 
void FillEvent (const BDSEventInfo *info, const G4PrimaryVertex *vertex, const std::vector< BDSHitsCollectionSampler * > &samplerHitsPlane, const std::vector< BDSHitsCollectionSamplerCylinder * > &samplerHitsCylinder, const std::vector< BDSHitsCollectionSamplerSphere * > &samplerHitsSphere, const BDSHitsCollectionSamplerLink *samplerHitsLink, const BDSHitsCollectionEnergyDeposition *energyLoss, const BDSHitsCollectionEnergyDeposition *energyLossFull, const BDSHitsCollectionEnergyDeposition *energyLossVacuum, const BDSHitsCollectionEnergyDeposition *energyLossTunnel, const BDSHitsCollectionEnergyDepositionGlobal *energyLossWorld, const BDSHitsCollectionEnergyDepositionGlobal *energyLossWorldContents, const BDSHitsCollectionEnergyDepositionGlobal *worldExitHits, const std::vector< const BDSTrajectoryPointHit * > &primaryHits, const std::vector< const BDSTrajectoryPointHit * > &primaryLosses, const BDSTrajectoriesToStore *trajectories, const BDSHitsCollectionCollimator *collimatorHits, const BDSHitsCollectionApertureImpacts *apertureImpactHits, const std::map< G4String, G4THitsMap< G4double > * > &scorerHitsMap, const G4int turnsTaken)
 Copy event information from Geant4 simulation structures to output structures. More...
 
void CloseAndOpenNewFile ()
 Close a file and open a new one. More...
 
void FillRun (const BDSEventInfo *info)
 Copy run information to output structure. More...
 
virtual void NewFile ()
 No action. More...
 
virtual void CloseFile ()
 No action. More...
 
virtual void WriteHeader ()
 No action. More...
 
virtual void WriteParticleData ()
 No action. More...
 
virtual void WriteBeam ()
 No action. More...
 
virtual void WriteOptions ()
 No action. More...
 
virtual void WriteModel ()
 No action. More...
 
virtual void WriteFileEventLevel ()
 No action. More...
 
virtual void WriteFileRunLevel ()
 No action. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BDSOutput
static G4bool InvalidSamplerName (const G4String &samplerName)
 Test whether a sampler name is invalid or not. More...
 
static void PrintProtectedNames (std::ostream &out)
 Feedback for protected names. More...
 
- Protected Member Functions inherited from BDSOutput
G4String GetNextFileName ()
 Get the next file name based on the base file name and the accrued number of files. More...
 
G4bool CreateCollimatorOutputStructures () const
 Whether to create the collimator structures in the output or not. More...
 
- Protected Member Functions inherited from BDSOutputStructures
 BDSOutputStructures (const BDSGlobalConstants *globals)
 
void InitialiseSamplers ()
 Construct samplers. More...
 
void InitialiseMaterialMap ()
 Construct a map of material pointer to integer ID and name. More...
 
G4int UpdateSamplerStructures ()
 Interface to allow setting up samplers later for dynamic geometry construction a la SixTrack. Not for regular use. More...
 
void PrepareCollimatorInformation ()
 
void InitialiseCollimators ()
 Construct collimtors. More...
 
void ClearStructuresParticleData ()
 Clear the local particle data structure. More...
 
void ClearStructuresHeader ()
 Clear the local header structure. More...
 
void ClearStructuresModel ()
 Clear the local model structure. More...
 
void ClearStructuresBeam ()
 Clear the local beam structure. More...
 
void ClearStructuresOptions ()
 Clear the local options structure. More...
 
void ClearStructuresEventLevel ()
 Clear the local structures in this class in preparation for a new event. More...
 
void ClearStructuresRunLevel ()
 Clear the local structures in this class in preparation for a new run. More...
 
G4int Create1DHistogram (G4String name, G4String title, G4int nbins, G4double xmin, G4double xmax)
 Create histograms for both evtHistos and runHistos. Return index from evtHistos. More...
 
G4int Create1DHistogram (G4String name, G4String title, std::vector< double > &edges)
 Create histograms for both evtHistos and runHistos. Return index from evtHistos. More...
 
G4int Create3DHistogram (G4String name, G4String title, G4int nBinsX, G4double xMin, G4double xMax, G4int nBinsY, G4double yMin, G4double yMax, G4int nBinsZ, G4double zMin, G4double zMax)
 Create histograms for both evtHistos and runHistos. Return index from evtHistos. More...
 
G4int Create4DHistogram (const G4String &name, const G4String &title, const G4String &eScale, const std::vector< double > &eBinsEdges, G4int nBinsX, G4double xMin, G4double xMax, G4int nBinsY, G4double yMin, G4double yMax, G4int nBinsZ, G4double zMin, G4double zMax, G4int nBinsE, G4double eMin, G4double eMax)
 Create histograms for both evtHistos and runHistos. Return index from evtHistos. More...
 
- Protected Attributes inherited from BDSOutput
std::map< G4String, G4int > blmCollectionNameToHistogramID
 
G4bool storeELoss
 Options for dynamic bits of output. More...
 
G4bool storeELossTunnel
 Options for dynamic bits of output. More...
 
G4bool storeELossVacuum
 Options for dynamic bits of output. More...
 
G4bool storeELossWorld
 Options for dynamic bits of output. More...
 
G4bool storeELossWorldContents
 Options for dynamic bits of output. More...
 
G4bool storeApertureImpacts
 Options for dynamic bits of output. More...
 
G4bool storeApertureImpactsHistograms
 Options for dynamic bits of output. More...
 
G4bool storePrimaries
 Options for dynamic bits of output. More...
 
G4bool storeTrajectory
 Options for dynamic bits of output. More...
 
- Protected Attributes inherited from BDSOutputStructures
BDSOutputROOTParticleDataparticleDataOutput
 Geant4 information / particle tables. More...
 
BDSOutputROOTEventHeaderheaderOutput
 Information about the file. More...
 
BDSOutputROOTEventBeambeamOutput
 Beam output. More...
 
BDSOutputROOTEventOptionsoptionsOutput
 Options output. More...
 
BDSOutputROOTEventModelmodelOutput
 Model output. More...
 
BDSOutputROOTEventSampler< double > * primary
 Primary sampler structure. More...
 
BDSOutputROOTEventSampler< float > * primary
 
BDSOutputROOTEventCoordsprimaryGlobal
 
std::vector< BDSOutputROOTEventSampler< double > * > samplerTrees
 Sampler structures. More...
 
std::vector< BDSOutputROOTEventSampler< float > * > samplerTrees
 
std::vector< std::string > samplerNames
 Sampler names to use. More...
 
std::vector< BDSOutputROOTEventSamplerC * > samplerCTrees
 
std::vector< BDSOutputROOTEventSamplerS * > samplerSTrees
 
std::vector< std::string > samplerCNames
 
std::vector< std::string > samplerSNames
 
std::map< G4int, G4int > samplerIDToIndexPlane
 
std::map< G4int, G4int > samplerIDToIndexCylinder
 
std::map< G4int, G4int > samplerIDToIndexSphere
 
BDSOutputROOTEventRunInforunInfo
 Run information. More...
 
BDSOutputROOTEventHistogramsrunHistos
 Run level histograms. More...
 
BDSOutputROOTEventLosseLoss
 General energy deposition. More...
 
BDSOutputROOTEventLosspFirstHit
 Primary hit point. More...
 
BDSOutputROOTEventLosspLastHit
 Primary loss point. More...
 
BDSOutputROOTEventLosseLossVacuum
 General energy deposition. More...
 
BDSOutputROOTEventLosseLossTunnel
 Tunnel energy deposition. More...
 
BDSOutputROOTEventLossWorldeLossWorld
 World energy deposition. More...
 
BDSOutputROOTEventLossWorldeLossWorldExit
 World exit hits. More...
 
BDSOutputROOTEventLossWorldeLossWorldContents
 Externally supplied world contents hits. More...
 
BDSOutputROOTEventApertureapertureImpacts
 Impacts on the aperture. More...
 
BDSOutputROOTEventTrajectorytraj
 Trajectories. More...
 
BDSOutputROOTEventHistogramsevtHistos
 Event level histograms. More...
 
BDSOutputROOTEventInfoevtInfo
 Event information. More...
 
std::vector< BDSOutputROOTEventCollimator * > collimators
 Collimator output structures. More...
 
std::vector< G4String > collimatorNames
 Names of collimators in output structures. More...
 
G4int nCollimators
 Number of collimators in beam line. More...
 
std::vector< G4int > collimatorIndices
 Indices in beam line that are collimators. More...
 
std::map< G4String, G4int > collimatorIndicesByName
 Indices mapped to their name. More...
 
std::vector< BDSOutputROOTEventCollimatorInfocollimatorInfo
 
std::vector< std::pair< G4double, G4double > > collimatorDifferences
 
std::map< G4Material *, short int > materialToID
 
std::map< short int, G4String > materialIDToNameUnique
 

Detailed Description

No output class.

Write no output

Author
Jochem Snuverink

Definition at line 32 of file BDSOutputNone.hh.

Constructor & Destructor Documentation

◆ BDSOutputNone()

BDSOutputNone::BDSOutputNone ( )
inline

Default constructor.

Definition at line 35 of file BDSOutputNone.hh.

◆ ~BDSOutputNone()

virtual BDSOutputNone::~BDSOutputNone ( )
inlinevirtual

Definition at line 36 of file BDSOutputNone.hh.

Member Function Documentation

◆ CloseFile()

virtual void BDSOutputNone::CloseFile ( )
inlinevirtual

No action.

Implements BDSOutput.

Definition at line 40 of file BDSOutputNone.hh.

◆ NewFile()

virtual void BDSOutputNone::NewFile ( )
inlinevirtual

No action.

Implements BDSOutput.

Definition at line 39 of file BDSOutputNone.hh.

◆ WriteBeam()

virtual void BDSOutputNone::WriteBeam ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 44 of file BDSOutputNone.hh.

◆ WriteFileEventLevel()

virtual void BDSOutputNone::WriteFileEventLevel ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 47 of file BDSOutputNone.hh.

◆ WriteFileRunLevel()

virtual void BDSOutputNone::WriteFileRunLevel ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 48 of file BDSOutputNone.hh.

◆ WriteHeader()

virtual void BDSOutputNone::WriteHeader ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 42 of file BDSOutputNone.hh.

◆ WriteModel()

virtual void BDSOutputNone::WriteModel ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 46 of file BDSOutputNone.hh.

◆ WriteOptions()

virtual void BDSOutputNone::WriteOptions ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 45 of file BDSOutputNone.hh.

◆ WriteParticleData()

virtual void BDSOutputNone::WriteParticleData ( )
inlineprivatevirtual

No action.

Implements BDSOutput.

Definition at line 43 of file BDSOutputNone.hh.


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