BDSOutputStructures.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2023.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSOUTPUTSTRUCTURES_H
#define BDSOUTPUTSTRUCTURES_H
 
#include "globals.hh"
 
#include <map>
#include <string>
#include <utility>
#include <vector>
 
// forward declarations
class BDSGlobalConstants;
class BDSOutputROOTEventAperture;
class BDSOutputROOTEventBeam;
class BDSOutputROOTEventCavityInfo;
class BDSOutputROOTEventCollimator;
class BDSOutputROOTEventCollimatorInfo;
class BDSOutputROOTEventCoords;
class BDSOutputROOTEventHeader;
class BDSOutputROOTEventHistograms;
class BDSOutputROOTEventInfo;
class BDSOutputROOTEventLoss;
class BDSOutputROOTEventLossWorld;
class BDSOutputROOTEventModel;
class BDSOutputROOTEventOptions;
class BDSOutputROOTEventRunInfo;
template<class T> class BDSOutputROOTEventSampler;
class BDSOutputROOTEventSamplerC;
class BDSOutputROOTEventSamplerS;
class BDSOutputROOTEventTrajectory;
class BDSOutputROOTParticleData;
class G4Material;
 
class BDSOutputStructures
{
protected:
  explicit BDSOutputStructures(const BDSGlobalConstants* globals);
  virtual ~BDSOutputStructures();
 
  void InitialiseSamplers();
  
  void InitialiseMaterialMap();
  
  G4int UpdateSamplerStructures();
  
  void PrepareCollimatorInformation();
 
  void PrepareCavityInformation();
 
  void InitialiseCollimators();
 
  void ClearStructuresParticleData();
 
  void ClearStructuresHeader();
 
  void ClearStructuresModel();
 
  void ClearStructuresBeam();
 
  void ClearStructuresOptions();
  
  void ClearStructuresEventLevel();
 
  void ClearStructuresRunLevel();
  
  G4int Create1DHistogram(G4String name,
                          G4String title,
                          G4int    nbins,
                          G4double xmin,
                          G4double xmax);
  G4int Create1DHistogram(G4String name,
                          G4String title,
                          std::vector<double>& edges);
  G4int Create3DHistogram(G4String name,
                          G4String title,
                          G4int    nBinsX, G4double xMin, G4double xMax,
                          G4int    nBinsY, G4double yMin, G4double yMax,
                          G4int    nBinsZ, G4double zMin, G4double zMax);
  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);
 
  BDSOutputROOTParticleData* particleDataOutput; 
  BDSOutputROOTEventHeader*  headerOutput;     
  BDSOutputROOTEventBeam*    beamOutput;       
  BDSOutputROOTEventOptions* optionsOutput;    
  BDSOutputROOTEventModel*   modelOutput;      
 
#ifdef __ROOTDOUBLE__
  BDSOutputROOTEventSampler<double>* primary;
#else 
  BDSOutputROOTEventSampler<float>* primary;
#endif
  BDSOutputROOTEventCoords* primaryGlobal; 
#ifdef __ROOTDOUBLE__
  std::vector<BDSOutputROOTEventSampler<double>*> samplerTrees;
#else
  std::vector<BDSOutputROOTEventSampler<float>*> samplerTrees;
#endif
  std::vector<std::string> samplerNames; 
  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;
  
  BDSOutputROOTEventRunInfo*    runInfo;            
  BDSOutputROOTEventHistograms* runHistos;          
  BDSOutputROOTEventLoss*       eLoss;              
  BDSOutputROOTEventLoss*       pFirstHit;          
  BDSOutputROOTEventLoss*       pLastHit;           
  BDSOutputROOTEventLoss*       eLossVacuum;        
  BDSOutputROOTEventLoss*       eLossTunnel;        
  BDSOutputROOTEventLossWorld*  eLossWorld;         
  BDSOutputROOTEventLossWorld*  eLossWorldExit;     
  BDSOutputROOTEventLossWorld*  eLossWorldContents; 
  BDSOutputROOTEventAperture*   apertureImpacts;    
  BDSOutputROOTEventTrajectory* traj;               
  BDSOutputROOTEventHistograms* evtHistos;          
  BDSOutputROOTEventInfo*       evtInfo;            
 
  // collimator specific output
  std::vector<BDSOutputROOTEventCollimator*> collimators; 
  std::vector<G4String>     collimatorNames;         
  G4int                     nCollimators;            
  std::vector<G4int>        collimatorIndices;       
  std::map<G4String, G4int> collimatorIndicesByName; 
  std::vector<BDSOutputROOTEventCollimatorInfo> collimatorInfo; 
  std::vector<std::pair<G4double, G4double> >   collimatorDifferences;
 
  // cavity specific output
  std::vector<G4String>     cavityNames;         
  G4int                     nCavities;           
  std::vector<G4int>        cavityIndices;       
  std::map<G4String, G4int> cavityIndicesByName; 
  std::vector<BDSOutputROOTEventCavityInfo> cavityInfo; 
 
  std::map<G4Material*, short int> materialToID;
  std::map<short int, G4String>    materialIDToNameUnique;
  
private:
  G4bool localSamplersInitialised;
 
  G4bool localCollimatorsInitialised;
  
  BDSOutputStructures() = delete;
  BDSOutputStructures(const BDSOutputStructures&) = delete;
  BDSOutputStructures& operator=(const BDSOutputStructures&) = delete;
};
 
#endif