gworld.cc

Go to the documentation of this file.

// gemc
#include "gfactory.h"
#include "gutilities.h"
 
// gsystem
#include "gsystemConventions.h"
#include "gworld.h"
#include "gmodifier.h"
#include "gsystemFactories/systemFactory.h"
#include "gsystemFactories/text/systemTextFactory.h"
#include "gsystemFactories/cad/systemCadFactory.h"
#include "gsystemFactories/gdml/systemGdmlFactory.h"
#include "gsystemFactories/sqlite/systemSqliteFactory.h"
 
// See gworld.h for API docs.
 
// TODO: have getSystems returns the map directly instead of going through the vector
GWorld::GWorld(const std::shared_ptr<GOptions>& g)
    : GBase(g, GWORLD_LOGGER),
      gopts(g) {
    log->debug(NORMAL, SFUNCTION_NAME, "New");
 
    // 1. Load system descriptors from options and build the internal map.
    auto gsystems = gsystem::getSystems(gopts);
    create_gsystemsMap(gsystems);
 
    // 2. Load volumes/materials through factories, then apply modifiers, then finalize names.
    load_systems();    // build factories, load volumes
    load_gmodifiers(); // load & apply modifiers
    assignG4Names();   // final bookkeeping
}
 
 
// Constructor with rvalue reference: perfect for taking ownership of move-only types
GWorld::GWorld(const std::shared_ptr<GOptions>& g, SystemList gsystems)
    : GBase(g, GWORLD_LOGGER),
      gopts(g) {
    log->debug(NORMAL, SFUNCTION_NAME, "From SystemList");
 
    // 1. Adopt external systems and build internal map.
    create_gsystemsMap(gsystems);
 
    // 2. Finish world construction as in the main ctor.
    load_systems();    // instantiate factories, load volumes
    load_gmodifiers(); // load modifiers
    assignG4Names();   // apply modifiers & set G4 names
}
 
 
// See gworld.h for API docs.
std::map<std::string, std::unique_ptr<GSystemFactory>> GWorld::createSystemFactory() {
    GManager manager(gopts);
 
    std::map<std::string, std::unique_ptr<GSystemFactory>> factoryMap;
 
    // Always register & create the SQLite factory (needed for ROOT volumes)
    manager.RegisterObjectFactory<GSystemSQLiteFactory>(gsystem::GSYSTEMSQLITETFACTORYLABEL, gopts);
    auto sqliteFactory = std::unique_ptr<GSystemFactory>(
        manager.CreateObject<GSystemFactory>(gsystem::GSYSTEMSQLITETFACTORYLABEL));
 
    if (!sqliteFactory) {
        log->error(gfactory::ERR_FACTORYNOTFOUND,
                   "Failed to create factory <", gsystem::GSYSTEMSQLITETFACTORYLABEL, ">");
    }
    factoryMap.emplace(gsystem::GSYSTEMSQLITETFACTORYLABEL, std::move(sqliteFactory));
 
 
    // Scan all systems and create any missing factories
    for (auto& [sysName, sysPtr] : *gsystemsMap) {
        const std::string& facName = sysPtr->getFactoryName();
 
        if (facName.empty()) {
            log->error(gfactory::ERR_FACTORYNOTFOUND,
                       "Factory name for system <", sysName,
                       "> is empty!  This system will not be loaded.");
        }
 
        // Already have it?  Move on.
        if (factoryMap.count(facName)) continue;
 
        //------------------ register the correct concrete class ----------------
        if (facName == gsystem::GSYSTEMCADTFACTORYLABEL)
            manager.RegisterObjectFactory<GSystemCADFactory>(facName, gopts);
        else if (facName == gsystem::GSYSTEMGDMLTFACTORYLABEL)
            manager.RegisterObjectFactory<GSystemGDMLFactory>(facName, gopts);
        else if (facName == gsystem::GSYSTEMSQLITETFACTORYLABEL)
            manager.RegisterObjectFactory<GSystemSQLiteFactory>(facName, gopts);
        else if (facName == gsystem::GSYSTEMASCIIFACTORYLABEL)
            manager.RegisterObjectFactory<GSystemTextFactory>(facName, gopts);
        else {
            log->error(gfactory::ERR_FACTORYNOTFOUND,
                       "Unrecognized factory name <", facName,
                       "> for system <", sysName, ">");
        }
 
        //------------------ create the factory object --------------------------
        auto facPtr = std::unique_ptr<GSystemFactory>(manager.CreateObject<GSystemFactory>(facName));
 
        if (!facPtr) {
            log->error(gfactory::ERR_FACTORYNOTFOUND,
                       "Failed to create factory <", facName,
                       "> for system <", sysName, ">");
        }
 
        factoryMap.emplace(facName, std::move(facPtr));
    }
 
    // Clean up any temporarily loaded shared libraries
    manager.clearDLMap();
 
    // Return by value (NRVO/move) – no leaks, no manual delete
    return factoryMap;
}
 
 
// See gworld.h for API docs.
GVolume* GWorld::searchForVolume(const std::string& volumeName, const std::string& purpose) const {
    for (auto& systemPair : *gsystemsMap) {
        GVolume* thisVolume = systemPair.second->getGVolume(volumeName);
        if (thisVolume != nullptr) {
            log->info(1, "gvolume named <", volumeName, "> found with purpose: ", purpose);
            return thisVolume;
        }
    }
    // If volume not found, print error and exit.
    log->error(gsystem::ERR_GVOLUMENOTFOUND,
               "gvolume named <", volumeName, "> (", purpose, ") not found in gsystemsMap ", purpose);
}
 
 
// See gworld.h for API docs.
std::vector<std::string> GWorld::getSensitiveDetectorsList() {
    std::vector<std::string> snames;
 
    // Walk all volumes and collect digitization identifiers, de-duplicating them.
    for (auto& systemPair : *gsystemsMap) {
        for (auto& gvolumePair : systemPair.second->getGVolumesMap()) {
            const auto& digitization = gvolumePair.second->getDigitization();
            if (digitization && find(snames.begin(), snames.end(), *digitization) == snames.end()) {
                snames.push_back(*digitization);
            }
        }
    }
    return snames;
}
 
 
// See gworld.h for API docs.
void GWorld::create_gsystemsMap(SystemList systems) {
    // Clearing the map before using it ensures this method can be called by both constructors.
    gsystemsMap->clear();
 
    for (auto& sysPtr : systems) {
        // Keying by filename (without path) keeps map keys stable across different path prefixes.
        std::string key = gutilities::getFileFromPath(sysPtr->getName());
        gsystemsMap->emplace(key, sysPtr);
    }
}
 
 
// See gworld.h for API docs.
void GWorld::load_systems() {
    const std::string dbhost = gopts->getRequiredScalarString("sql");
 
    auto systemFactories = createSystemFactory();
    const bool no_systems_defined = gsystemsMap->empty();
 
    // For every system, find / create its factory and load volumes
    const auto yamlFiles = gopts->getYamlFiles();
 
    for (auto& [sysName, sysPtr] : *gsystemsMap) {
        const std::string& factoryName = sysPtr->getFactoryName();
 
        if (factoryName.empty()) {
            log->error(gfactory::ERR_FACTORYNOTFOUND,
                       "Factory name for system <", sysName, "> is empty!");
        }
 
        auto facIt = systemFactories.find(factoryName);
        if (facIt == systemFactories.end()) {
            log->error(gfactory::ERR_FACTORYNOTFOUND,
                       "Factory <", factoryName, "> not found for system <", sysName, ">");
        }
 
        auto& factory = facIt->second; // std::unique_ptr<GSystemFactory>&
        if (!factory) {
            log->error(gfactory::ERR_FACTORYNOTFOUND,
                       "Factory pointer <", factoryName, "> is nullptr");
        }
 
        // Feed YAML directories as possible file locations.
        // This allows factories to find external assets alongside YAML configurations.
        for (const auto& yaml : yamlFiles) {
            std::string dir = gutilities::getDirFromPath(yaml);
            if (dir.empty())
                log->warning("Directory extracted from YAML <", yaml, "> is empty.");
            factory->addPossibleFileLocation(dir);
        }
 
        // Load & close the system.
        factory->loadSystem(sysPtr.get());
        factory->closeSystem();
    }
 
 
    // loop over gsystemsMap looking for gsystem::ROOTWORLDGVOLUMENAME
    auto world_is_defined = false;
    for (auto& [sysName, sysPtr] : *gsystemsMap) {
        // for each system run getGVolume(gsystem::ROOTWORLDGVOLUMENAME)
        if (sysPtr->getGVolume(gsystem::ROOTWORLDGVOLUMENAME) != nullptr) {
            log->info(1, "ROOT world volume found in system <", sysName, ">");
            world_is_defined = true;
        }
    }
 
    if (!world_is_defined) {
        // Inject the ROOT “world” volume, if not already present.
        // This ensures downstream volume placement always has a valid top-level mother.
        const std::string worldVolumeDefinition =
            gopts->getRequiredScalarString(gsystem::ROOTWORLDGVOLUMENAME);
 
        auto rootSystem = std::make_shared<GSystem>(
            gopts, // logger
            dbhost,
            gsystem::ROOTWORLDGVOLUMENAME, // name + path
            gsystem::GSYSTEMSQLITETFACTORYLABEL,
            "all",    // experiment
            1,        // runNo
            "default" // variation
        );
        rootSystem->addROOTVolume(worldVolumeDefinition);
 
        if (no_systems_defined) {
            std::vector<std::string> viewerBoxPars = {
                "viewer_box",                  // 01 name
                "G4Box",                       // 02 type
                "1*m, 1*m, 1*m",               // 03 parameters
                "G4_AIR",                      // 04 material
                gsystem::ROOTWORLDGVOLUMENAME,          // 05 mother
                gsystem::DEFAULTPOSITION,               // 06 position
                gsystem::DEFAULTROTATION,               // 07 rotation
                gsystem::DEFAULTG4PLACEMENTTYPE,        // 08 Geant4 placement
                guts::SERIALIZED_NULL_TOKEN,          // 09 electromagnetic field
                "1",                           // 10 visible
                "0",                           // 11 style: wireframe
                "ffcc33",                      // 12 color
                "1",                           // 13 opacity
                guts::SERIALIZED_NULL_TOKEN,          // 14 digitization
                guts::SERIALIZED_NULL_TOKEN,          // 15 gidentity
                guts::SERIALIZED_NULL_TOKEN,          // 16 copyOf
                guts::SERIALIZED_NULL_TOKEN,          // 17 solidsOpr
                guts::SERIALIZED_NULL_TOKEN,          // 18 mirror
                "1",                           // 19 exist flag
                "default visible volume for field-only visualization"
            };
            rootSystem->addGVolume(viewerBoxPars);
        }
 
        (*gsystemsMap)[gsystem::ROOTWORLDGVOLUMENAME] = rootSystem;
    }
 
    // systemFactories goes out of scope -> all factories destroyed cleanly
}
 
 
// See gworld.h for API docs.
void GWorld::load_gmodifiers() {
    // Build the map <volumeName → shared_ptr<GModifier>>
    for (const auto& mod : gsystem::getModifiers(gopts)) // returns vector<GModifier>
    {
        auto modPtr = std::make_shared<GModifier>(mod);
        gmodifiersMap.emplace(modPtr->getName(), modPtr);
    }
 
    // Apply every modifier to its target volume
    for (auto& [volumeName, modPtr] : gmodifiersMap) // modPtr is shared_ptr<GModifier>
    {
        // Will exit if not found:
        GVolume* vol = searchForVolume(volumeName,
                                       " is marked for modifications");
 
        vol->applyShift(modPtr->getShift());
        vol->applyTilt(modPtr->getTilts());
        vol->modifyExistence(modPtr->getExistence());
 
        log->info(2, "g-modifying volume <", volumeName,
                  "> with modifier: ", *modPtr);
        log->info(2, "After modifications:", *vol);
    }
}
 
 
// See gworld.h for API docs.
void GWorld::assignG4Names() {
    for (auto& systemPair : *gsystemsMap) {
        for (auto& [volumeName, gvolume] : systemPair.second->getGVolumesMap()) {
            // Skip if the volume's mother is "akasha" (top-level marker) or if this is the ROOT world volume itself.
            std::string motherVolumeName = gvolume->getMotherName();
            if (motherVolumeName != gsystem::MOTHEROFUSALL && volumeName != gsystem::ROOTWORLDGVOLUMENAME) {
                // Mother lookup is required to build fully-qualified mother name.
                auto        motherVolume = searchForVolume(motherVolumeName, "mother of <" + gvolume->getName() + ">");
                std::string g4name       = gvolume->getSystem() + gsystem::GSYSTEM_DELIMITER + volumeName;
                std::string g4motherName = motherVolume->getSystem() + gsystem::GSYSTEM_DELIMITER + motherVolumeName;
 
                // ROOT mother is a special case: its Geant4 name is exactly gsystem::ROOTWORLDGVOLUMENAME.
                if (motherVolumeName == gsystem::ROOTWORLDGVOLUMENAME) { g4motherName = gsystem::ROOTWORLDGVOLUMENAME; }
 
                gvolume->assignG4Names(g4name, g4motherName);
            }
            else {
                // Top-level volumes are assigned ROOT/world and akasha markers.
                gvolume->assignG4Names(gsystem::ROOTWORLDGVOLUMENAME, gsystem::MOTHEROFUSALL);
            }
        }
    }
}