g4system_options.cc

Go to the documentation of this file.

// g4system_options.cc : option definitions for the g4system module.
 
#include "g4system_options.h"
#include "gsystem_options.h"
 
// project goption to a system
namespace g4system {
// returns array of options definitions
GOptions defineOptions() {
    // Aggregate options from this module, factories, and the base gsystem module.
    GOptions goptions(G4SYSTEM_LOGGER);
    goptions += GOptions(G4SFACTORY_LOGGER);
 
    // Pull in shared system options (database, geometry system handling, etc.).
    goptions += gsystem::defineOptions();
 
    // Optional material used when a volume requests one that is not in the Geant4 material tables.
    std::string help =
        "Material to be used if some volume requested a non-defined material.\n\n";
    help += "By default GEMC will exit with error.\n";
    help += "Example: -useBackupMaterial=G4_Air\n";
    goptions.defineOption(GVariable("useBackupMaterial", std::nullopt, "Backup material"), help);
 
    // Human-readable switches used for diagnostics and validation.
    goptions.defineSwitch("showPredefinedMaterials", "log GEMC Predefined Materials");
    goptions.defineSwitch("printSystemsMaterials", "print the materials used in this simulation");
 
    // Overlap checking mode (the integer "check_overlaps" option below is the single control):
    // - 0 disables overlap checks
    // - 1 enables overlap checking at placement time
    // - 2 uses Geant4 overlap validator with default surface sampling
    // - N>100 uses Geant4 overlap validator with N surface points
    help = "Check for overlaps at physical volume construction.\n\n";
    help += "Possible values are:\n";
    help += " - 0 (default): no check.\n";
    help += " - 1: enable the G4PVPlacement surface overlap check (pSurfChk) at volume placement.\n";
    help += " - 2: use the geant4 overlap validator with the default number of points on the surface\n";
    help += " - Any N greater than 100: use the geant4 overlap validator with N points on the surface\n \n";
    help += "Example: -check_overlaps=1\n";
    goptions.defineOption(GVariable("check_overlaps", 0, "check overlaps"), help);
 
    return goptions;
}
}