checkAndReturnParameters.cc

Go to the documentation of this file.

 
// g4system
#include "g4NativeObjectsFactory.h"
#include "g4systemConventions.h"
 
// Validate and parse the constructor parameter list for native Geant4 solids.
// Header documentation is authoritative; this implementation comment is intentionally brief.
std::vector<double> G4NativeSystemFactory::checkAndReturnParameters(const GVolume* s) {
    // PRAGMA TODO: check non-zero pars for various constructors
    // Example: G4Box should not have any dimension equal to zero.
    //
    //  for(unsigned i=0; i<parameters.size(); ++i) {
    //      if(getG4Number(parameters[i]) == 0) {
    //          cout << guts::GWARNING << " Warning: G4Box has one side null!" << endl;
    //      }
    //  }
 
    std::set<int> possibleNumberOfParameters;
    std::string   type = s->getType();
    std::string   name = s->getName();
 
    // Convert comma-/space-separated string into a vector<double>.
    if (!s->getParameters()) {
        log->error(
            g4system::ERR_G4VOLUMEBUILDFAILED, "Native solid <%1> has no constructor parameters",
            s->getG4Name());
    }
    std::vector<double> parameters = gutilities::getG4NumbersFromString(*s->getParameters());
    int                 actualNumberOfParameters = static_cast<int>(parameters.size());
 
    // Table of valid counts for each primitive.
    if (type == "G4Box") possibleNumberOfParameters = {3};
    else if (type == "G4Tubs") possibleNumberOfParameters = {5};
    else if (type == "G4CutTubs") possibleNumberOfParameters = {11};
    else if (type == "G4Cons") possibleNumberOfParameters = {7};
    else if (type == "G4Para") possibleNumberOfParameters = {6};
    else if (type == "G4Trd") possibleNumberOfParameters = {5};
    else if (type == "G4Trap") possibleNumberOfParameters = {4, 11};
    else if (type == "G4Sphere") possibleNumberOfParameters = {6};
    else if (type == "G4Orb") possibleNumberOfParameters = {1};
    else if (type == "G4Torus") possibleNumberOfParameters = {5};
 
    // Polycones: special rule supporting multiple constructor layouts.
    else if (type == "G4Polycone" || type == "G4GenericPolycone") {
        // first constructor -> (nPars mod 3) == 0
        // second constructor -> ((nPars-3) mod 2) == 0
        if (actualNumberOfParameters % 3 != 0 &&
            (actualNumberOfParameters - 3) % 2 != 0) {
            log->error(
                g4system::ERR_G4PARAMETERSMISMATCH,
                "Wrong number of parameters in the constructor of <%1> of solid type <%2>: %3", name, type,
                *s->getParameters());
        }
        return parameters; // valid - return early
    }
 
    // Polyhedra: special rule supporting multiple constructor layouts.
    else if (type == "G4Polyhedra") {
        // first constructor -> ((nPars-4) mod 3) == 0
        // second constructor -> ((nPars-4) mod 2) == 0
        if ((actualNumberOfParameters - 4) % 3 != 0 &&
            (actualNumberOfParameters - 4) % 2 != 0) {
            log->error(
                g4system::ERR_G4PARAMETERSMISMATCH,
                "Wrong number of parameters in the constructor of <%1> of solid type <%2>: %3", name, type,
                *s->getParameters());
        }
        return parameters; // valid - return early
    }
 
    else if (type == "G4EllipticalTube") possibleNumberOfParameters = {3};
    else if (type == "G4Ellipsoid") possibleNumberOfParameters = {5};
    else if (type == "G4EllipticalCone") possibleNumberOfParameters = {4};
    else if (type == "G4Paraboloid") possibleNumberOfParameters = {3};
    else if (type == "G4Hype") possibleNumberOfParameters = {5};
    else if (type == "G4Tet") possibleNumberOfParameters = {12, 13};
    else if (type == "G4TwistedBox") possibleNumberOfParameters = {4};
    else if (type == "G4TwistedTrap") possibleNumberOfParameters = {5, 11};
    else if (type == "G4TwistedTrd") possibleNumberOfParameters = {6};
    else if (type == "G4TwistedTubs") possibleNumberOfParameters = {5};
    else {
        log->error(
            g4system::ERR_G4SOLIDTYPENOTFOUND, "The constructor of <%1> uses an unknown solid type <%2>", name,
            type);
    }
 
    // Generic count check for fixed-count solids.
    if (possibleNumberOfParameters.find(actualNumberOfParameters)
        == possibleNumberOfParameters.end()) {
        log->error(
            g4system::ERR_G4PARAMETERSMISMATCH,
            "Wrong number of parameters in the constructor of <%1> of solid type <%2>: %3", name, type,
            *s->getParameters());
    }
 
    return parameters;
}