G4INCLConfig.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4INCLConfig.hh

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// INCL++ intra-nuclear cascade model
// Alain Boudard, CEA-Saclay, France
// Joseph Cugnon, University of Liege, Belgium
// Jean-Christophe David, CEA-Saclay, France
// Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
// Sylvie Leray, CEA-Saclay, France
// Davide Mancusi, CEA-Saclay, France
//
#define INCLXX_IN_GEANT4_MODE 1

#include "globals.hh"

#ifndef G4INCLConfig_hh
#define G4INCLConfig_hh 1

#include "G4INCLParticleSpecies.hh"
#include "G4INCLConfigEnums.hh"
#include "G4INCLRandomSeedVector.hh"
#include <iostream>
#include <string>
#include <sstream>
// #include <cassert>

class ConfigParser;

namespace G4INCL {

  class Config {
  public:
    Config();

    ~Config();

    void init();

    std::string summary();

    G4int getVerbosity() const { return verbosity; }

    std::string const &getCalculationTitle() const { return title; }

    std::string const &getOutputFileRoot() const { return outputFileRoot; }

    G4int getNumberOfShots() const { return nShots; }

    G4bool isNaturalTarget() const { return naturalTarget; }

    G4int getTargetA() const { return targetSpecies.theA; }

    G4int getTargetZ() const { return targetSpecies.theZ; }

    G4int getTargetS() const { return targetSpecies.theS; }

    void setTargetA(G4int A) { targetSpecies.theA = A; }

    void setTargetZ(G4int Z) { targetSpecies.theZ = Z; }

    void setTargetS(G4int S) { targetSpecies.theS = S; }

    ParticleType getProjectileType() const { return projectileSpecies.theType; }

    ParticleSpecies getProjectileSpecies() const { return projectileSpecies; }

    void setProjectileSpecies(ParticleSpecies const &ps) { projectileSpecies=ps; }

    G4double getProjectileKineticEnergy() const { return projectileKineticEnergy; }

    void setProjectileKineticEnergy(G4double const kinE) { projectileKineticEnergy=kinE; }

    G4int getVerboseEvent() const { return verboseEvent; }

    static std::string const getVersionID();

    static std::string const getVersionHash();

    static std::string const getVersionString() {
      std::stringstream ss;
      ss << getVersionID() << "-" << getVersionHash();
      return ss.str();
    }

    Random::SeedVector getRandomSeeds() const {
      return randomSeedVector;
    }

    PauliType getPauliType() const { return pauliType; }

    G4bool getCDPP() const { return CDPP; }

    CoulombType getCoulombType() const { return coulombType; }

    void setCoulombType(CoulombType const c) { coulombType = c; }

    PotentialType getPotentialType() const { return potentialType; }

    void setPotentialType(PotentialType type) { potentialType = type; }

    G4bool getPionPotential() const { return pionPotential; }

    void setPionPotential(const G4bool pionPot) { pionPotential = pionPot; }

    LocalEnergyType getLocalEnergyBBType() const { return localEnergyBBType; }

    void setLocalEnergyBBType(const LocalEnergyType t) { localEnergyBBType=t; }

    LocalEnergyType getLocalEnergyPiType() const { return localEnergyPiType; }

    void setLocalEnergyPiType(const LocalEnergyType t) { localEnergyPiType=t; }

    std::string const &getLogFileName() const { return logFileName; }

    DeExcitationType getDeExcitationType() const { return deExcitationType; }

    std::string getDeExcitationString() const { return deExcitationString; }

    ClusterAlgorithmType getClusterAlgorithm() const { return clusterAlgorithmType; }

    void setClusterAlgorithm(ClusterAlgorithmType const c) { clusterAlgorithmType = c; }

    G4int getClusterMaxMass() const { return clusterMaxMass; }

    void setClusterMaxMass(const G4int m){ clusterMaxMass=m; }

    G4bool getBackToSpectator() const { return backToSpectator; }

    void setBackToSpectator(const G4bool b) { backToSpectator = b; }

    G4bool getUseRealMasses() const { return useRealMasses; }

    void setUseRealMasses(G4bool use) { useRealMasses = use; }

    void setINCLXXDataFilePath(std::string const &s) { INCLXXDataFilePath=s; }

    std::string const &getINCLXXDataFilePath() const {
      return INCLXXDataFilePath;
    }

#ifdef INCL_DEEXCITATION_ABLAXX
    std::string const &getABLAv3pCxxDataFilePath() const {
      return ablav3pCxxDataFilePath;
    }
#endif

#ifdef INCL_DEEXCITATION_ABLACXX
    std::string const &getABLAXXDataFilePath() const {
      return ablaxxDataFilePath;
    }
#endif

#ifdef INCL_DEEXCITATION_ABLA07
    std::string const &getABLA07DataFilePath() const {
      return abla07DataFilePath;
    }
#endif
#ifdef INCL_DEEXCITATION_GEMINIXX
    std::string const &getGEMINIXXDataFilePath() const {
      return geminixxDataFilePath;
    }
#endif

    G4double getImpactParameter() const { return impactParameter; }

    SeparationEnergyType getSeparationEnergyType() const { return separationEnergyType; }

    FermiMomentumType getFermiMomentumType() const { return fermiMomentumType; }

    void setFermiMomentumType(FermiMomentumType const f) { fermiMomentumType=f; }

    G4double getFermiMomentum() const { return fermiMomentum; }

    void setFermiMomentum(const G4double p) { fermiMomentum = p; }

    G4double getCutNN() const { return cutNN; }

#ifdef INCL_ROOT_USE
    std::string const &getROOTSelectionString() const {
      return rootSelectionString;
    }
#endif

#ifdef INCL_DEEXCITATION_FERMI_BREAKUP
    G4int getMaxMassFermiBreakUp() const {
      return maxMassFermiBreakUp;
    }

    G4int getMaxChargeFermiBreakUp() const {
      return maxChargeFermiBreakUp;
    }
#endif

    G4double getRPCorrelationCoefficient(const ParticleType t) const {
// assert(t==Proton || t==Neutron);
      return ((t==Proton) ? rpCorrelationCoefficientProton : rpCorrelationCoefficientNeutron);
    }

    void setRPCorrelationCoefficient(const ParticleType t, const G4double corrCoeff) {
// assert(t==Proton || t==Neutron);
      if(t==Proton)
        rpCorrelationCoefficientProton=corrCoeff;
      else
        rpCorrelationCoefficientNeutron=corrCoeff;
    }

    void setRPCorrelationCoefficient(const G4double corrCoeff) {
      setRPCorrelationCoefficient(Proton,corrCoeff);
      setRPCorrelationCoefficient(Neutron,corrCoeff);
    }

    G4double getNeutronSkin() const { return neutronSkin; }

    void setNeutronSkin(const G4double d) { neutronSkin=d; }

    G4double getNeutronHalo() const { return neutronHalo; }

    void setNeutronHalo(const G4double d) { neutronHalo=d; }

    G4bool getRefraction() const { return refraction; }

    void setRefraction(const G4bool r) { refraction = r; }

    RNGType getRNGType() const { return rngType; }

    void setRNGType(RNGType const r) { rngType=r; }

    PhaseSpaceGeneratorType getPhaseSpaceGeneratorType() const { return phaseSpaceGeneratorType; }

    void setPhaseSpaceGeneratorType(PhaseSpaceGeneratorType const p) { phaseSpaceGeneratorType=p; }

    CascadeActionType getCascadeActionType() const { return cascadeActionType; }

    void setCascadeActionType(CascadeActionType const c) { cascadeActionType=c; }

    unsigned int getAutosaveFrequency() const { return autosaveFrequency; }

    void setAutosaveFrequency(const unsigned int f) { autosaveFrequency=f; }

    CrossSectionsType getCrossSectionsType() const { return crossSectionsType; }

    G4int getMaxNumberMultipions() const { return maxNumberMultipions; }

    void setMaxNumberMultipions(const G4int n) { maxNumberMultipions=n; }

    void setCrossSectionsType(CrossSectionsType const c) { crossSectionsType=c; }

    G4double getHadronizationTime() const { return hadronizationTime; }

    void setHadronizationTime(const G4double t) { hadronizationTime=t; }

#ifdef INCL_ROOT_USE
    G4bool getConciseROOTTree() const { return conciseROOTTree; }
#endif

    G4bool getInverseKinematics() const { return inverseKinematics; }

    G4double getDecayTimeThreshold() const { return decayTimeThreshold; }

    void setDecayTimeThreshold(const G4double t) { decayTimeThreshold=t; }

    G4double getBias() const { return bias; }

  private:

    G4int verbosity;
    std::string inputFileName;
    std::string title;
    std::string outputFileRoot;
    std::string fileSuffix;
    std::string logFileName;

    G4int nShots;

    std::string targetString;
    ParticleSpecies targetSpecies;
    G4bool naturalTarget;

    std::string projectileString;
    ParticleSpecies projectileSpecies;
    G4double projectileKineticEnergy;

    G4int verboseEvent;

    std::string randomSeeds;
    Random::SeedVector randomSeedVector;

    std::string pauliString;
    PauliType pauliType;
    G4bool CDPP;

    std::string coulombString;
    CoulombType coulombType;

    std::string potentialString;
    PotentialType potentialType;
    G4bool pionPotential;

    std::string localEnergyBBString;
    LocalEnergyType localEnergyBBType;

    std::string localEnergyPiString;
    LocalEnergyType localEnergyPiType;

    std::string deExcitationModelList;
    std::string deExcitationOptionDescription;
    std::string deExcitationString;
    DeExcitationType deExcitationType;
#ifdef INCL_DEEXCITATION_ABLAXX
    std::string ablav3pCxxDataFilePath;
#endif
#ifdef INCL_DEEXCITATION_ABLACXX
    std::string ablaxxDataFilePath;
#endif
#ifdef INCL_DEEXCITATION_ABLA07
    std::string abla07DataFilePath;
#endif
#ifdef INCL_DEEXCITATION_GEMINIXX
    std::string geminixxDataFilePath;
#endif
    std::string INCLXXDataFilePath;

    std::string clusterAlgorithmString;
    ClusterAlgorithmType clusterAlgorithmType;

    G4int clusterMaxMass;

    G4bool backToSpectator;

    G4bool useRealMasses;

    G4double impactParameter;

    std::string separationEnergyString;
    SeparationEnergyType separationEnergyType;

    std::string fermiMomentumString;
    FermiMomentumType fermiMomentumType;

    G4double fermiMomentum;

    G4double cutNN;
    
    G4double bias;

#ifdef INCL_ROOT_USE
    std::string rootSelectionString;
#endif

#ifdef INCL_DEEXCITATION_FERMI_BREAKUP
    G4int maxMassFermiBreakUp;
    G4int maxChargeFermiBreakUp;
#endif

    G4double rpCorrelationCoefficient;
    G4double rpCorrelationCoefficientProton;
    G4double rpCorrelationCoefficientNeutron;

    G4double neutronSkin;
    G4double neutronHalo;

    G4bool refraction;

    std::string randomNumberGenerator;
    RNGType rngType;

    std::string phaseSpaceGenerator;
    PhaseSpaceGeneratorType phaseSpaceGeneratorType;

    unsigned int autosaveFrequency;

    std::string crossSectionsString;
    CrossSectionsType crossSectionsType;
    G4int maxNumberMultipions;

    std::string cascadeAction;
    CascadeActionType cascadeActionType;

    G4double hadronizationTime;

#ifdef INCL_ROOT_USE
    G4bool conciseROOTTree;
#endif

    G4bool inverseKinematics;

    G4double decayTimeThreshold;

    friend class ::ConfigParser;
  };

}

#endif