BDSBeamlineBLMBuilder.cc

/* 
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/>.
*/
#include "BDSBeamline.hh"
#include "BDSBeamlineElement.hh"
#include "BDSBeamlineBLMBuilder.hh"
#include "BDSBLM.hh"
#include "BDSBLMFactory.hh"
#include "BDSBLMRegistry.hh"
#include "BDSDebug.hh"
#include "BDSDetectorConstruction.hh"
#include "BDSException.hh"
#include "BDSExtent.hh"
#include "BDSGeometryFactory.hh"
#include "BDSParser.hh"
#include "BDSScorerFactory.hh"
#include "BDSScorerInfo.hh"
#include "BDSSDManager.hh"
#include "BDSSimpleComponent.hh"
#include "BDSUtilities.hh"
 
#include "parser/blmplacement.h"
#include "parser/scorer.h"
 
#include "CLHEP/Units/SystemOfUnits.h"
 
#include "globals.hh"
#include "G4MultiFunctionalDetector.hh"
#include "G4RotationMatrix.hh"
#include "G4SDManager.hh"
#include "G4ThreeVector.hh"
#include "G4Transform3D.hh"
#include "G4VSensitiveDetector.hh"
 
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>
 
 
BDSBeamline* BDS::BuildBLMs(const std::vector<GMAD::BLMPlacement>& blmPlacements,
                            const BDSBeamline* parentBeamLine)
{
  if (blmPlacements.empty())
    {return nullptr;} // don't do anything - no placements
  
  // loop over blm placements - if any have external geometry, force the loading of it now so any materials
  // that could be used in the BDSScorerInfo filters will be defined first by the load. The geometry is cached
  // so it won't be loaded twice.
  for (const auto& bp : blmPlacements)
    {
      if (!bp.geometryFile.empty())
        {BDSGeometryFactory::Instance()->BuildGeometry(G4String(bp.name), G4String(bp.geometryFile));}
    }
  
  // we need to loop over all the blm definitions to work out the unique combinations of
  // scorers that need to be created. multiple scorers for a single blm ultimately have to be
  // in one G4MultiFunctionalSD sensitive detector.
  std::vector<GMAD::Scorer> scorers = BDSParser::Instance()->GetScorers();
  // convert all the parser scorer definitions into recipes (including parameter checking)
  std::map<G4String, BDSScorerInfo> scorerRecipes;
  for (const auto& scorer : scorers)
    {
      BDSScorerInfo si = BDSScorerInfo(scorer);
      scorerRecipes.insert(std::make_pair(si.name, si));
    }
  
  std::set<std::set<G4String> > scorerSetsToMake;
  // cache a map of set of scorers and combined name by BLM name so we don't have to do it later again
  std::map<std::string, std::pair<std::set<G4String>, G4String> >blmScoringInfo;
  for (const auto& bp : blmPlacements)
    {
      std::vector<G4String> scorersForThisBLM = BDS::SplitOnWhiteSpace(G4String(bp.scoreQuantity));
      std::set<G4String> requiredScorers;
      for (const auto& name : scorersForThisBLM)
        {
          auto search = scorerRecipes.find(name);
          if (search == scorerRecipes.end())
            {throw BDSException(__METHOD_NAME__, "scorerQuantity \"" + name + "\" for blm \"" + bp.name + "\" not found.");}
          else
            {requiredScorers.insert(name);}
        }
      // no BDS::Warning here as that slows down print out - could be all the blms turned off
      if (requiredScorers.empty())
        {G4cout << "Warning - no scoreQuantity specified for blm \"" << bp.name << "\" - it will only be passive material" << G4endl;}
      scorerSetsToMake.insert(requiredScorers);
      
      // the set by definition orders its contents, so we iterate through it to form a uniquely
      // ordered combined name for the set.
      G4String combinedName = "";
      for (const auto& n : requiredScorers)
        {combinedName += n;}
      blmScoringInfo[bp.name] = std::make_pair(requiredScorers, combinedName);
    }
#ifdef BDSDEBUG
  G4cout << "Unqiue combinations of scorers: " << scorerSetsToMake.size() << G4endl;
#endif
  if (scorerSetsToMake.empty())
    {G4cout << "Warning - all BLMs have no scoreQuantity specified so are only passive material." << G4endl;}
  
  // construct SDs
  BDSScorerFactory scorerFactory;
  std::map<G4String, G4MultiFunctionalDetector*> sensitiveDetectors;
  std::vector<G4String> uniquePrimitiveScorerNames;
  std::vector<G4double> scorerUnits;
  G4SDManager* SDMan = G4SDManager::GetSDMpointer();
  for (const auto& ssAndCombinedName : blmScoringInfo)
    {
      G4String combinedName = ssAndCombinedName.second.second;
#ifdef BDSDEBUG
      G4cout << __METHOD_NAME__ << "Making unique SD " << combinedName << G4endl;
#endif
      // If the sensitive detector with a unique combination of scorers is constructed already, skip
      if (sensitiveDetectors.count(combinedName) > 0)
        {continue;}
 
      G4MultiFunctionalDetector* sd = new G4MultiFunctionalDetector("blm_"+combinedName);
      for (const auto& name : ssAndCombinedName.second.first)
        {
          const auto& recipe = scorerRecipes.at(name); // safe as in previous loop we ensure it exists
          G4double unit = 1.0;
          G4VPrimitiveScorer* ps = scorerFactory.CreateScorer(&recipe, nullptr, &unit);
          sd->RegisterPrimitive(ps);
          // We rely on the prefix "blm_" here to intercept scorer hits in BDSOutput so if
          // this changes, that matching must be done there too. It's to distinguish them
          // from 3D mesh hits and put them in the BLM output.
          uniquePrimitiveScorerNames.emplace_back("blm_"+combinedName+"/"+name);
          scorerUnits.push_back(unit);
        }
      sensitiveDetectors[combinedName] = sd;
      SDMan->AddNewDetector(sd);
    }
  
  BDSSDManager::Instance()->RegisterPrimitiveScorerNames(uniquePrimitiveScorerNames, &scorerUnits);
  
  BDSBeamline* blms = new BDSBeamline();
  BDSBLMFactory factory;
  for (const auto& bp : blmPlacements)
    {
      // form a set of score quantities again
      const auto& v = blmScoringInfo.at(bp.name);
      std::set<G4String> requiredScorers = v.first;
      G4String combinedName = v.second;
 
      auto sdSearch = sensitiveDetectors.find(combinedName);
      if (sdSearch == sensitiveDetectors.end())
        {throw BDSException(__METHOD_NAME__, "unknown set of scorers");}
      G4MultiFunctionalDetector* sd = sdSearch->second;
      
      BDSBLM* blm = factory.CreateBLM(bp, sd);
      BDSExtent blmExtent = blm->GetExtent();
      G4double  length    = blmExtent.DZ();
      if (!BDS::IsFinite(length))
        {throw BDSException(__METHOD_NAME__, "BLM: " + bp.name + " has 0 extent");}
      BDSSimpleComponent* comp = new BDSSimpleComponent(blm->GetName(),
                                                        blm,
                                                        length);
      comp->Initialise();
      
      G4double S = -1000;
      G4Transform3D transform = BDSDetectorConstruction::CreatePlacementTransform(bp, parentBeamLine,
                                                                                  &S, &blmExtent);
      // do a little checking here as transform code in CreatePlacement can't
      // know who's calling it to warn
      if (BDS::IsFinite(bp.s) && transform == G4Transform3D::Identity)
        {
          G4String msg = "the S coordinate (" + std::to_string(bp.s) + " m) for blm \"" + bp.name;
          msg += "\" was not found in the beam line - please check";
          throw BDSException(__METHOD_NAME__, msg);
        }
      
      BDSBLMRegistry::Instance()->RegisterBLM(bp.name, blm, S);
      
      G4ThreeVector halfLengthBeg = G4ThreeVector(0,0,-length*0.5);
      G4ThreeVector halfLengthEnd = G4ThreeVector(0,0, length*0.5);
      G4ThreeVector midPos        = transform.getTranslation();
      G4ThreeVector startPos = midPos + transform * (HepGeom::Point3D<G4double>)halfLengthBeg;
      G4ThreeVector endPos   = midPos + transform * (HepGeom::Point3D<G4double>)halfLengthEnd;
      G4RotationMatrix* rm   = new G4RotationMatrix(transform.getRotation());
      
      BDSBeamlineElement* el = new BDSBeamlineElement(comp,
                                                      startPos,
                                                      midPos,
                                                      endPos,
                                                      rm,
                                                      new G4RotationMatrix(*rm),
                                                      new G4RotationMatrix(*rm),
                                                      startPos,
                                                      midPos,
                                                      endPos,
                                                      new G4RotationMatrix(*rm),
                                                      new G4RotationMatrix(*rm),
                                                      new G4RotationMatrix(*rm),
                                                      -1,-1,-1);
 
      blms->AddBeamlineElement(el);
    }
 
  return blms;
}