BDSElement.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 "BDSAcceleratorModel.hh"
#include "BDSDebug.hh"
#include "BDSExtent.hh"
#include "BDSElement.hh"
#include "BDSException.hh"
#include "BDSGeometryExternal.hh"
#include "BDSGeometryFactory.hh"
#include "BDSSDType.hh"
 
#include "G4String.hh"
#include "G4Types.hh"
 
#include <iomanip>
#include <set>
#include <vector>
 
class G4LogicalVolume;
 
BDSElement::BDSElement(const G4String& nameIn,
                       G4double        arcLengthIn,
                       G4double        horizontalWidthIn,
                       const G4String& geometryIn,
                       G4double        angleIn,
                       std::vector<G4String>* namedVacuumVolumesIn,
                       G4bool          autoColourGeometryIn,
                       G4bool          markAsCollimatorIn,
                       G4bool          stripOuterVolumeIn):
  BDSAcceleratorComponent(nameIn, arcLengthIn, angleIn, markAsCollimatorIn ? "element-collimator" : "element"),
  horizontalWidth(horizontalWidthIn),
  geometryFileName(geometryIn),
  autoColourGeometry(autoColourGeometryIn),
  markAsCollimator(markAsCollimatorIn),
  stripOuterVolume(stripOuterVolumeIn),
  geometry(nullptr)
{
  if (namedVacuumVolumesIn)
    {namedVacuumVolumes = *namedVacuumVolumesIn;}
}
 
void BDSElement::Build()
{
  BuildUserLimits();
  BuildContainerLogicalVolume(); // pure virtual provided by derived class
  AttachUserLimits();
  // we purposively don't attach vis attributes to the container here as it would overwrite ones from geometry loading
}
 
void BDSElement::BuildContainerLogicalVolume()
{
  // The horizontalWidth here is a suggested horizontalWidth for the factory. Each sub-factory may treat this
  // differently.
  BDSSDType sensitivityToAttach = markAsCollimator ? BDSSDType::collimatorcomplete : BDSSDType::energydep;
  // The field isn't constructed here. It's registered through the base class SetField method in the component
  // factory and built and attached in the Initialise() method of the base class. However, before Initialise()
  // is called, the member fieldInfo will be set. We pass it in here to make sure we don't reuse the same
  // geometry when a different field is required.
  geometry = BDSGeometryFactory::Instance()->BuildGeometry(name,
                                                           geometryFileName,
                                                           nullptr,
                                                           autoColourGeometry,
                                                           chordLength,
                                                           horizontalWidth,
                                                           &namedVacuumVolumes,
                                                           true,
                                                           sensitivityToAttach,
                                                           BDSSDType::energydepvacuum,
                                                           stripOuterVolume,
                                                           userLimits);
  
  if (!geometry)
    {throw BDSException(__METHOD_NAME__, "Error loading geometry in component \"" + name + "\"");}
  
  // We don't register the geometry as a daughter as the geometry factory retains
  // ownership of the geometry and will clean it up at the end.
  
  // make the beam pipe container, this object's container
  containerLogicalVolume = geometry->GetContainerLogicalVolume();
  containerSolid         = geometry->GetContainerSolid();
  containerAssembly      = geometry->GetContainerAssemblyVolume();
  containerIsAssembly    = geometry->ContainerIsAssembly();
 
  // register named vacuum volumes that have been identified
  SetAcceleratorVacuumLogicalVolume(geometry->VacuumVolumes());
  
  if (markAsCollimator)
    {// label volumes as belonging to a collimator
      auto collimatorVolumeSet = BDSAcceleratorModel::Instance()->VolumeSet("collimators");
      for (auto vol : GetAcceleratorMaterialLogicalVolumes())
        {collimatorVolumeSet->insert(vol);}
    }
  
  // set placement offset from geom so it's placed correctly in the beam line
  SetPlacementOffset(geometry->GetPlacementOffset());
  
  // update extents
  InheritExtents(geometry);
 
  const BDSExtent geomExtent = geometry->GetExtent();
  BDSExtent nominalExt = BDSExtent(horizontalWidth*0.5, horizontalWidth*0.5, chordLength*0.5);
  if (nominalExt.TransverselyGreaterThan(geomExtent))
    {SetExtent(nominalExt);}
 
  // check extent of geometry as compared to user input length of component in
  // beam line. If longer (including some numerical tolerance), warn user
  G4double extLength = GetExtent().DZ();
  G4double tolerance = 1*CLHEP::micrometer;
  if ((extLength - chordLength) > tolerance)
    {
      auto flagsCache(G4cerr.flags());
      G4cerr << std::setprecision(15); // precise print out to aid user
      G4cerr.setf( std::ios::fixed, std:: ios::floatfield );
      G4cerr << "BDSElement> The loaded geometry is larger than the specified length"
             << " of the element, which will cause overlaps!" << G4endl
             << "Calculated extent along z of geometry: " << extLength << " mm" << G4endl;
      G4cerr << "Arc length    " << arcLength   << " mm"  << G4endl;
      G4cerr << "Bending angle " << angle       << " rad" << G4endl;
      G4cerr << "Chord length  " << chordLength << " mm"  << G4endl;
      G4cerr << "Chord length must be >= geometry length" << G4endl;
      G4cerr << "Possible overlaps in element \"" << name << "\"" << G4endl << G4endl << G4endl;
      // we don't force an exit here as our testing might not be exact for angled components
      // for now, we leave it to the user to ensure this is acceptable
      //throw BDSException(__METHOD_NAME__, "overlaps in element \"" + name + "\"");
      G4cerr.flags(flagsCache);
    }
}
 
std::set<G4VPhysicalVolume*> BDSElement::GetAllPhysicalVolumes()  const
{
  return geometry ? geometry->GetAllPhysicalVolumes() : std::set<G4VPhysicalVolume*>();
}
 
std::set<G4RotationMatrix*> BDSElement::GetAllRotationMatrices() const
{
  return geometry ? geometry->GetAllRotationMatrices() : std::set<G4RotationMatrix*>();
}
 
std::set<G4VisAttributes*> BDSElement::GetAllVisAttributes() const
{
  return geometry ? geometry->GetAllVisAttributes() : std::set<G4VisAttributes*>();
}
 
std::set<G4UserLimits*> BDSElement::GetAllUserLimits() const
{
  return geometry ? geometry->GetAllUserLimits() : std::set<G4UserLimits*>();
}
 
std::set<BDSGeometryComponent*> BDSElement::GetAllDaughters() const
{
  return geometry ? geometry->GetAllDaughters() : std::set<BDSGeometryComponent*>();
}
 
std::set<G4VSolid*> BDSElement::GetAllSolids() const
{
  return geometry ? geometry->GetAllSolids() : std::set<G4VSolid*>();
}
 
std::set<G4LogicalVolume*> BDSElement::GetAllLogicalVolumes() const
{
  return geometry ? geometry->GetAllLogicalVolumes() : std::set<G4LogicalVolume*>();
}
 
std::set<G4LogicalVolume*> BDSElement::GetAllBiasingVolumes() const
{
  return geometry ? geometry->GetAllBiasingVolumes() : std::set<G4LogicalVolume*>();
}
 
std::map<G4LogicalVolume*, BDSSDType> BDSElement::GetAllSensitiveVolumes() const
{
  return geometry ? geometry->GetAllSensitiveVolumes() : std::map<G4LogicalVolume*, BDSSDType>();
}
 
void BDSElement::ExcludeLogicalVolumeFromBiasing(G4LogicalVolume* lv)
{
  if (geometry)
    {geometry->ExcludeLogicalVolumeFromBiasing(lv);}
}
 
void BDSElement::AttachSensitiveDetectors()
{
  BDSGeometryComponent::AttachSensitiveDetectors();
  if (geometry)
    {geometry->AttachSensitiveDetectors();}
}