Class to manage the creation and conversion of the geometry. More...

#include <GeometryManager.h>

Collaboration diagram for GeometryManager:

[legend]

Public Member Functions
G4VPhysicalVolume *	getTopVolume ()
	Return a pointer to the top volume.

void	createGeometry (const GearDir &params, GeometryTypes type=FullGeometry)
	Create Geometry.

void	createGeometry (const GeoConfiguration &params, GeometryTypes type=FullGeometry, bool useDB=true)
	Create Geometry.

GeoConfiguration	createGeometryConfig (const GearDir &detectorDir, const IntervalOfValidity &iov)
	Create Geometry configuration object.

void	setDetectorComponents (const std::vector< std::string > &components)
	Set the names of the components to create.

void	setExcludedComponents (const std::vector< std::string > &components)
	Set the names of the components to exclude from creation.

void	setAdditionalComponents (const std::vector< std::string > &components)
	Set the names of addtional components to be added to the default set.

void	setDensityScaling (const std::map< std::string, double > &components)
	Set the density scaling: This is intended for systematic studies only and will scale the density of all materials for each component in the map by the given factor.

void	setAssignRegions (bool assignRegions)
	Choose whether a region should be assigned to each creator.

void	clear ()
	Delete the existing Geant4 Geometry.

void	createTGeoRepresentation ()
	Create a TGeo representation of the native geometry description.

G4VisAttributes *	newVisAttributes ()
	Create an anonymous G4VisAttributes for an existing G4LogicalVolume.

Static Public Member Functions
static GeometryManager &	getInstance ()
	Return a reference to the instance.

Private Member Functions
	GeometryManager ()
	Default constructor declared private since class is a Singleton.

	GeometryManager (const GeometryManager &)=delete
	Copy constructor declared private since class is a Singleton.

GeometryManager &	operator= (const GeometryManager &)=delete
	Assignment operator declared private since class is a Singleton.

	~GeometryManager ()
	Destructor: make sure we clean up memory at the end.

Private Attributes
G4VPhysicalVolume *	m_topVolume
	Pointer to the top volume of the native geometry description.

std::vector< CreatorBase * >	m_creators
	List of all creators, to be freed when geometry is destucted.

std::set< std::string >	m_components
	List of names of components to be created, all other components will be ignored.

std::set< std::string >	m_excluded
	List of names of components to be excluded from creation.

std::set< std::string >	m_additional
	List of additional components to be added to the default set of components.

std::map< std::string, double >	m_densityScaling
	Scaling factors for densities.

bool	m_assignRegions {false}
	Bool to indicate whether we automatically assign a region with the creator name to all volumes created by that creator.

std::vector< G4VisAttributes * >	m_VisAttributes
	List of visualization attributes.

Friends
struct	std::default_delete< GeometryManager >
	Allow destruction of instance.

Detailed Description

Class to manage the creation and conversion of the geometry.

This class is a singleton

Definition at line 47 of file GeometryManager.h.

Constructor & Destructor Documentation

◆ GeometryManager()

GeometryManager ( )

inlineprivate

Default constructor declared private since class is a Singleton.

Definition at line 171 of file GeometryManager.h.

171: m_topVolume(0) {};

Belle2::geometry::GeometryManager::m_topVolume

G4VPhysicalVolume * m_topVolume

Pointer to the top volume of the native geometry description.

Definition: GeometryManager.h:180

◆ ~GeometryManager()

~GeometryManager ( )

inlineprivate

Destructor: make sure we clean up memory at the end.

Definition at line 177 of file GeometryManager.h.

177{}

Member Function Documentation

◆ clear()

void clear ( )

Delete the existing Geant4 Geometry.

Definition at line 102 of file GeometryManager.cc.

    {
      B2DEBUG(50, "Cleaning up Geometry");
      for (G4VisAttributes* visAttr : m_VisAttributes) delete visAttr;
      m_VisAttributes.clear();
      for (CreatorBase* creator : m_creators) delete creator;
      m_creators.clear();
      m_topVolume = nullptr;
      //Clean up existing Geometry
      G4GeometryManager::GetInstance()->OpenGeometry();
      G4PhysicalVolumeStore::Clean();
      G4LogicalVolumeStore::Clean();
      G4SolidStore::Clean();
      G4LogicalBorderSurface::CleanSurfaceTable();
      G4LogicalSkinSurface::CleanSurfaceTable();
      G4SurfaceProperty::CleanSurfacePropertyTable();
      //And finally clean up materials
      Materials::getInstance().clear();
    }

◆ createGeometry() [1/2]

void createGeometry	(	const GearDir &	params,
		GeometryTypes	type = `FullGeometry`
	)

Create Geometry.

This function will create the geometry representation. First the Materials will be created, than the top volume will be defined and all components of the detector will be built by calling the corresponding creator

Parameters

params	GearDir pointing to the top element of the geometry parameters
type	Type of the geometry to be built

Definition at line 219 of file GeometryManager.cc.

    {
      GeoConfiguration config = createGeometryConfig(detectorDir, IntervalOfValidity());
      createGeometry(config, type, false);
    }

◆ createGeometry() [2/2]

void createGeometry	(	const GeoConfiguration &	params,
		GeometryTypes	type = `FullGeometry`,
		bool	useDB = `true`
	)

Create Geometry.

This function will create the geometry representation from an existing configuration object. First the Materials will be created, than the top volume will be defined and all components of the detector will be built by calling the corresponding creator

Parameters

params	geometry configuration object
type	Type of the geometry to be built
useDB	whether the creators should be using the Database or Gearbox

Definition at line 225 of file GeometryManager.cc.

    {
      // remove the old geometry
      clear();
 
      // if we don't use the DB make sure the magnetic field is properly set
      // by adding it as a fake database payload
      BFieldMap::Instance().clear();
      if (!useDB) {
        auto* fieldmap = new MagneticField();
        fieldmap->addComponent(new BFieldFrameworkInterface());
        DBStore::Instance().addConstantOverride("MagneticField", fieldmap, false);
      }
 
      //Let Geant4 know that we "modified" the geometry
      G4RunManager* runManager = G4RunManager::GetRunManager();
      if (runManager) runManager->ReinitializeGeometry(true, true);
 
      // create new geometry
      B2DEBUG(10, "Creating geometry for detector: " << config.getName());
 
      // create Materials
      Materials& materials = Materials::getInstance();
      for (const GeoMaterial& mat : config.getMaterials()) {
        materials.createMaterial(mat);
      }
 
      //Now set Top volume. Be aware that Geant4 uses "half size" so the size
      //will be in each direction even though the member name suggests a total size
      G4Material*      top_mat = Materials::get(config.getGlobalMaterial());
      double xHalfLength = config.getGlobalWidth() / Unit::cm * CLHEP::cm;
      double yHalfLength = config.getGlobalHeight() / Unit::cm * CLHEP::cm;
      double zHalfLength = config.getGlobalLength() / Unit::cm * CLHEP::cm;
      //Geant4 doesn't like negative dimensions so lets make sure it gets at
      //least a positive value. We'll rezize the box anyway if the length is
      //zero so this is not important now
      G4Box*           top_box = new G4Box("Top", xHalfLength > 0 ? xHalfLength : 1,
                                           yHalfLength > 0 ? yHalfLength : 1,
                                           zHalfLength > 0 ? zHalfLength : 1);
      G4LogicalVolume* top_log = new G4LogicalVolume(top_box, top_mat, "Top", nullptr, nullptr, nullptr);
      setVisibility(*top_log, false);
      m_topVolume = new G4PVPlacement(nullptr, G4ThreeVector(), top_log, "Top", nullptr, false, 0);
      B2DEBUG(10, "Created top volume with x= +-" << config.getGlobalWidth() << " cm, y= +-"
              << config.getGlobalHeight() << " cm, z= +-" << config.getGlobalLength() << " cm");
 
 
      auto getDensityScale = [this](const std::string & name) {
        std::optional<double> scale;
        if (auto it = m_densityScaling.find(name); it != m_densityScaling.end()) {
          scale = it->second;
        }
        return scale;
      };
      auto globalScale = getDensityScale("*");
 
      for (const GeoComponent& component : config.getComponents()) {
        CreatorBase* creator = CreatorManager::getCreator(component.getCreator(), component.getLibrary());
        if (creator) {
          // Do we want to scale the density for this or all components?
          auto componentScale = getDensityScale(component.getName());
          if (componentScale or globalScale) {
            double scale = globalScale ? *globalScale : 1.0;
            if (componentScale) scale *= *componentScale;
            Materials::getInstance().setDensityScale(scale);
          }
          // remember how many we had to print the difference
          int oldSolids = G4SolidStore::GetInstance()->size();
          int oldLogical = G4LogicalVolumeStore::GetInstance()->size();
          int oldPhysical = G4PhysicalVolumeStore::GetInstance()->size();
          try {
            if (!useDB) throw CreatorBase::DBNotImplemented();
            creator->createFromDB(component.getName(), *top_log, type);
            B2DEBUG(50, "called creator " << component.getCreator() << " to create component " << component.getName() << " from DB");
 
          } catch (CreatorBase::DBNotImplemented& e) {
            GearDir parameters = Gearbox::getInstance().getDetectorComponent(component.getName());
            creator->create(parameters, *top_log, type);
            B2DEBUG(50, "called creator " << component.getCreator() << " to create component " << component.getName() << " from Gearbox");
          }
          int newSolids = G4SolidStore::GetInstance()->size() - oldSolids;
          int newLogical = G4LogicalVolumeStore::GetInstance()->size() - oldLogical;
          int newPhysical = G4PhysicalVolumeStore::GetInstance()->size() - oldPhysical;
          B2DEBUG(50, "DetectorComponent " << component.getName() << " created " << newSolids
                  << " solids, " << newLogical << " logical volumes and "
                  << newPhysical << " physical volumes");
          m_creators.push_back(creator);
          //Done creating things, please reset density scaling
          Materials::getInstance().resetDensityScale();
          if (m_assignRegions) {
            //Automatically assign a region with the creator name to all volumes
            G4Region* region {nullptr};
            //We loop over all children of the top volume and check whether they
            //have the correct region assigned
            for (size_t i = 0; i < top_log->GetNoDaughters(); ++i) {
              G4LogicalVolume* vol = top_log->GetDaughter(i)->GetLogicalVolume();
              //We only assign a region if there is not already one
              if (!vol->GetRegion()) {
                //Ok, new region, create or get one if not already done and assign it
                if (!region) region = G4RegionStore::GetInstance()->FindOrCreateRegion(component.getName());
                vol->SetRegion(region);
                //And propagate the region to all child volumes
                region->AddRootLogicalVolume(vol);
              }
            }
          }
        }
      }
 
      int newSolids = G4SolidStore::GetInstance()->size();
      int newLogical = G4LogicalVolumeStore::GetInstance()->size();
      int newPhysical = G4PhysicalVolumeStore::GetInstance()->size();
      B2DEBUG(50, "Created a total of " << newSolids << " solids, " << newLogical
              << " logical volumes and " << newPhysical << " physical volumes");
 
      //Enlarge top volume to always encompass all volumes
      top_box->SetXHalfLength(getTopMinSize("x", kXAxis, top_log, xHalfLength));
      top_box->SetYHalfLength(getTopMinSize("y", kYAxis, top_log, yHalfLength));
      top_box->SetZHalfLength(getTopMinSize("z", kZAxis, top_log, zHalfLength));
 
      B2DEBUG(50, "Optimizing geometry and creating lookup tables ...");
      G4GeometryManager::GetInstance()->CloseGeometry(true, LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 200, PACKAGENAME()));
    }

◆ createGeometryConfig()

GeoConfiguration createGeometryConfig	(	const GearDir &	detectorDir,
		const IntervalOfValidity &	iov
	)

Create Geometry configuration object.

This function will convert a Gearbox representation of the geometry to an object containing all necessary parameters

Parameters

detectorDir	GearDir pointing to the top element of the geometry parameters
iov	Interval of validity for the created object

Definition at line 122 of file GeometryManager.cc.

    {
      std::string detectorName;
      try {
        detectorName = detectorDir.getString("Name");
        B2DEBUG(50, "Creating geometry for detector: " << detectorName);
      } catch (gearbox::PathEmptyError& e) {
        B2FATAL("Could not read detector name, make sure gearbox is connected and "
                << detectorDir.getPath() << " points to the geometry description");
      }
 
      const double globalWidth  = detectorDir.getLength("Global/width",  0);
      const double globalHeight = detectorDir.getLength("Global/height", 0);
      const double globalLength = detectorDir.getLength("Global/length", 0);
      const std::string globalMaterial = detectorDir.getString("Global/material", "Air");
 
      GeoConfiguration config(detectorName, globalWidth, globalHeight, globalLength, globalMaterial);
 
      // Add materials
      Materials& materials = Materials::getInstance();
      for (const GearDir& matlist : detectorDir.getNodes("Materials")) {
        for (const GearDir& mat : matlist.getNodes("Material")) {
          GeoMaterial material = materials.createMaterialConfig(mat);
          config.addMaterial(material);
        }
      }
 
      std::set<std::string> componentNames = m_components;
      std::set<std::string> excludedNames = m_excluded;
      std::set<std::string> additionalNames = m_additional;
      if (!m_components.empty() && !m_additional.empty()) {
        B2WARNING("Additional components are ignored when a list of components is provided.");
      }
 
      //Now create all subcomponents
      for (const GearDir& component : detectorDir.getNodes("DetectorComponent")) {
        string name;
        string creatorName;
        try {
          name        = component.getString("@name");
          creatorName = component.getString("Creator");
        } catch (gearbox::PathEmptyError& e) {
          B2ERROR("Could not find required element Name or Creator for " << component.getPath());
          continue;
        }
        const bool isDefault = component.getBool("@isDefault", true);
        //Remove this name from the list of selected, excluded or additional components. At
        //the end there should be nothing left in these lists
        componentNames.erase(name);
        excludedNames.erase(name);
        additionalNames.erase(name);
        if (!m_components.empty() && m_components.count(name) == 0) {
          B2DEBUG(50, "DetectorComponent " << name << " not in list of components, skipping");
          continue;
        }
        if (m_components.empty() && !isDefault) {
          if (m_additional.count(name) == 0) {
            B2DEBUG(50, "DectorComponent " << name << " is not enabled by default, skipping");
            continue;
          } else {
            B2DEBUG(50, "DectorComponent " << name << " is enabled in addition to the default components");
          }
        }
        if (!m_excluded.empty() && m_excluded.count(name) > 0) {
          B2DEBUG(10, "DetectorComponent " << name << " in list of excluded components, skipping");
          continue;
        }
 
        string libraryName = component.getString("Creator/@library", "");
        if (!iov.empty()) {
          CreatorBase* creator = CreatorManager::getCreator(creatorName, libraryName);
          if (creator) {
            creator->createPayloads(GearDir(component, "Content"), iov);
          } else {
            B2ERROR("Could not load creator " << creatorName << " from " << libraryName);
          }
        }
        config.addComponent({name, creatorName, libraryName});
      }
 
      //If there are still names left in the componentNames, excludedNames or
      //additionalNames there is probably an typo in the respective component
      //list. Throw an error for each name left using a small lambda function
      auto checkRemaining = [](const std::string & type, const std::set<std::string>& remainingNames) {
        for (const std::string& name : remainingNames) {
          B2ERROR("Geometry '" << name << "' is specified in list of "
                  << type << " but could not be found");
        }
      };
 
      checkRemaining("components", componentNames);
      checkRemaining("excluded components", excludedNames);
      checkRemaining("additional components", additionalNames);
 
      return config;
    }

◆ createTGeoRepresentation()

void createTGeoRepresentation ( )

Create a TGeo representation of the native geometry description.

This method will convert the existing Geometry to a ROOT TGeo representation which can be accessed using the global gGeoManager provided by ROOT.

Definition at line 348 of file GeometryManager.cc.

    {
      if (!m_topVolume) {
        B2ERROR("No Geometry found, please create a geometry before converting it to ROOT::TGeo");
        return;
      }
 
      Geant4GM::Factory g4Factory;
      if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 200, PACKAGENAME())) {
        g4Factory.SetDebug(1);
      }
      g4Factory.Import(m_topVolume);
      RootGM::Factory rtFactory;
      rtFactory.SetIgnore(1);
      if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 200, PACKAGENAME())) {
        rtFactory.SetDebug(1);
      }
      g4Factory.Export(&rtFactory);
      gGeoManager->CloseGeometry();
      delete g4Factory.Top();
      delete rtFactory.Top();
    }

◆ getInstance()

GeometryManager & getInstance ( )

static

Return a reference to the instance.

Definition at line 96 of file GeometryManager.cc.

    {
      static unique_ptr<GeometryManager> instance(new GeometryManager());
      return *instance;
    }

◆ getTopVolume()

G4VPhysicalVolume * getTopVolume ( )

inline

Return a pointer to the top volume.

Returns 0 if no geometry has been created so far

Definition at line 56 of file GeometryManager.h.

56{ return m_topVolume; }

◆ newVisAttributes()

G4VisAttributes * newVisAttributes ( )

Create an anonymous G4VisAttributes for an existing G4LogicalVolume.

Returns: Pointer to the new G4VisAttributes object

Definition at line 371 of file GeometryManager.cc.

    {
      m_VisAttributes.push_back(new G4VisAttributes());
      return m_VisAttributes.back();
    }

◆ setAdditionalComponents()

void setAdditionalComponents ( const std::vector< std::string > & components )

inline

Set the names of addtional components to be added to the default set.

This member allows to set a list of component names. When creating the the geometry, components matching names in the list will be added if they are not disabled by default. If a list of components is already provided this list is ignored.

Parameters

components List of detector components to be added in addition

Definition at line 125 of file GeometryManager.h.

      {
        m_additional.clear();
        m_additional.insert(components.begin(), components.end());
      }

◆ setAssignRegions()

void setAssignRegions ( bool assignRegions )

inline

Choose whether a region should be assigned to each creator.

If set to true, all volumes created by each creator are assigned a region with the name of the creator

Definition at line 143 of file GeometryManager.h.

      {
        m_assignRegions = assignRegions;
      }

◆ setDensityScaling()

void setDensityScaling ( const std::map< std::string, double > & components )

inline

Set the density scaling: This is intended for systematic studies only and will scale the density of all materials for each component in the map by the given factor.

Definition at line 134 of file GeometryManager.h.

      {
        m_densityScaling = components;
      }

◆ setDetectorComponents()

void setDetectorComponents ( const std::vector< std::string > & components )

inline

Set the names of the components to create.

This member allows to set a list of component names. When creating the the geometry, only components matching names in the list will be created. All other components found in the parameters will be ignored

Parameters

components List of detector components to be created

Definition at line 98 of file GeometryManager.h.

      {
        m_components.clear();
        m_components.insert(components.begin(), components.end());
      }

◆ setExcludedComponents()

void setExcludedComponents ( const std::vector< std::string > & components )

inline

Set the names of the components to exclude from creation.

This member allows to set a list of component names. When creating the the geometry, components matching names in the list will be ignored

Parameters

components List of detector components to be excluded

Definition at line 110 of file GeometryManager.h.

      {
        m_excluded.clear();
        m_excluded.insert(components.begin(), components.end());
      }

Friends And Related Function Documentation

◆ std::default_delete< GeometryManager >

friend struct std::default_delete< GeometryManager >

friend

Allow destruction of instance.

Definition at line 196 of file GeometryManager.h.

Member Data Documentation

◆ m_additional

std::set<std::string> m_additional

private

List of additional components to be added to the default set of components.

Definition at line 188 of file GeometryManager.h.

◆ m_assignRegions

bool m_assignRegions {false}

private

Bool to indicate whether we automatically assign a region with the creator name to all volumes created by that creator.

Definition at line 194 of file GeometryManager.h.

◆ m_components

std::set<std::string> m_components

private

List of names of components to be created, all other components will be ignored.

Definition at line 184 of file GeometryManager.h.

◆ m_creators

std::vector<CreatorBase*> m_creators

private

List of all creators, to be freed when geometry is destucted.

Definition at line 182 of file GeometryManager.h.

◆ m_densityScaling

std::map<std::string, double> m_densityScaling

private

Scaling factors for densities.

Definition at line 190 of file GeometryManager.h.

◆ m_excluded

std::set<std::string> m_excluded

private

List of names of components to be excluded from creation.

Definition at line 186 of file GeometryManager.h.

◆ m_topVolume

G4VPhysicalVolume* m_topVolume

private

Pointer to the top volume of the native geometry description.

Definition at line 180 of file GeometryManager.h.

◆ m_VisAttributes

std::vector<G4VisAttributes*> m_VisAttributes

private

List of visualization attributes.

Definition at line 196 of file GeometryManager.h.

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

geometry/include/GeometryManager.h
geometry/src/GeometryManager.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GeometryManager()

◆ ~GeometryManager()

Member Function Documentation

◆ clear()

◆ createGeometry() [1/2]

◆ createGeometry() [2/2]

◆ createGeometryConfig()

◆ createTGeoRepresentation()

◆ getInstance()

◆ getTopVolume()

◆ newVisAttributes()

◆ setAdditionalComponents()

◆ setAssignRegions()

◆ setDensityScaling()

◆ setDetectorComponents()

◆ setExcludedComponents()

Friends And Related Function Documentation

◆ std::default_delete< GeometryManager >

Member Data Documentation

◆ m_additional

◆ m_assignRegions

◆ m_components

◆ m_creators

◆ m_densityScaling

◆ m_excluded

◆ m_topVolume

◆ m_VisAttributes