G4INCL::Config Class Reference

#include <G4INCLConfig.hh>

Public Member Functions
	Config ()
	Default constructor.
	Config (G4int, G4int, ParticleSpecies, G4double)
	Config (G4int argc, char *argv[], G4bool isFullRun)
	Constructor based on command-line and config-file options.
	~Config ()
	Default destructor.
void	init ()
	Initialise the members.
std::string	summary ()
	Return a summary of the run configuration.
G4int	getVerbosity () const
	Get the verbosity.
std::string const &	getCalculationTitle () const
	Get the run title.
std::string const &	getOutputFileRoot () const
	Get the output file root.
G4int	getNumberOfShots () const
	Get the number of shots.
G4bool	isNaturalTarget () const
	Natural targets.
G4int	getTargetA () const
	Get the target mass number.
G4int	getTargetZ () const
	Get the target charge number.
void	setTargetA (G4int A)
	Set target mass number.
void	setTargetZ (G4int Z)
	Set target charge number.
ParticleType	getProjectileType () const
	Get the projectile type.
ParticleSpecies	getProjectileSpecies () const
	Get the projectile species.
void	setProjectileSpecies (ParticleSpecies const &ps)
	Set the projectile species.
G4float	getProjectileKineticEnergy () const
	Get the projectile kinetic energy.
void	setProjectileKineticEnergy (G4float const kinE)
	Set the projectile kinetic energy.
G4int	getVerboseEvent () const
	Get the number of the verbose event.
SeedVector const	getRandomSeeds () const
	Get the seeds for the random-number generator.
PauliType	getPauliType () const
	Get the Pauli-blocking algorithm.
G4bool	getCDPP () const
	Do we want CDPP?
G4bool	getPionPotential () const
	Do we want the pion potential?
CoulombType	getCoulombType () const
	Get the Coulomb-distortion algorithm.
PotentialType	getPotentialType () const
	Get the type of the potential for nucleons.
void	setPotentialType (PotentialType type)
	Set the type of the potential for nucleons.
void	setPionPotential (const G4bool pionPot)
	Set the type of the potential for nucleons.
LocalEnergyType	getLocalEnergyBBType () const
	Get the type of local energy for N-N avatars.
LocalEnergyType	getLocalEnergyPiType () const
	Get the type of local energy for pi-N and decay avatars.
void	setLocalEnergyBBType (const LocalEnergyType t)
	Set the type of local energy for N-N avatars.
void	setLocalEnergyPiType (const LocalEnergyType t)
	Set the type of local energy for N-N avatars.
std::string const &	getLogFileName () const
	Get the log file name.
DeExcitationType	getDeExcitationType () const
	Get the de-excitation model.
ClusterAlgorithmType	getClusterAlgorithm () const
	Get the clustering algorithm.
G4int	getClusterMaxMass () const
	Get the maximum mass for production of clusters.
void	setClusterMaxMass (const G4int m)
	Set the maximum mass for production of clusters.
G4bool	getBackToSpectator () const
	Get back-to-spectator.
G4bool	getUseRealMasses () const
	Whether to use real masses.
void	setUseRealMasses (G4bool use)
	Set whether to use real masses.
std::string const	echo () const
	Echo the input options.
std::string const &	getINCLXXDataFilePath () const
G4double	getImpactParameter () const
SeparationEnergyType	getSeparationEnergyType () const
	Get the separation-energy type.

Static Public Member Functions
static std::string const	getVersionID ()
	Get the INCL version ID.

Detailed Description

The INCL configuration object

The Config object keeps track of various INCL physics options (e.g. which Pauli blocking scheme to use, whether to use local energy option or not, etc.

Definition at line 58 of file G4INCLConfig.hh.

Constructor & Destructor Documentation

Config() [1/3]

G4INCL::Config::Config

(

)

Default constructor.

Definition at line 58 of file G4INCLConfig.cc.

  {
    init();
  }

Config() [2/3]

G4INCL::Config::Config	(	G4int	,
		G4int	,
		G4INCL::ParticleSpecies	proj,
		G4double	projectileE
	)

Constructor for INCL++ with specified target A, Z, projectile type and energy. All other options are the default ones.

Definition at line 63 of file G4INCLConfig.cc.

  {
    init();
    projectileSpecies = proj;
    projectileKineticEnergy = projectileE;
  }

Config() [3/3]

G4INCL::Config::Config	(	G4int	argc,
		char *	argv[],
		G4bool	isFullRun
	)

Constructor based on command-line and config-file options.

Parameters

argc	command-line parameters
argv	command-line parameters
isFullRun	is this a real calculation: true = yes; false = no, it's just a unit test

Definition at line 633 of file G4INCLConfig.cc.

    {
      init();
    }

~Config()

G4INCL::Config::~Config

(

)

Default destructor.

Definition at line 639 of file G4INCLConfig.cc.

  {}

Member Function Documentation

echo()

std::string const G4INCL::Config::echo

(

)

const

Echo the input options.

Definition at line 694 of file G4INCLConfig.cc.

                                     {
    std::stringstream ss;
    ss << std::boolalpha;
    ss << "###########################" << std::endl
      << "### Start of input echo ###" << std::endl
      << "###########################" << std::endl << std::endl
      << " # You may re-use this snippet of the log file as an input file!" << std::endl
      << " # Options marked with a * are compulsory." << std::endl
      << std::endl
      << "# Run options" << std::endl
      << "title = " << title << "\t# run title" << std::endl
      << "output = " << outputFileRoot << "\t# root for generating output file names. Suffixes (.root, .out, etc.) will be appended to this root. Defaults to the input file name, if given; otherwise, defaults to a string composed of the explicitly specified options" << std::endl
      << "logfile = " << logFileName << "\t# log file name. Defaults to `<output_root>.log'. Use `-' if you want to redirect logging to stdout" << std::endl
      << "number-shots = " << nShots << "\t# * number of shots" << std::endl
      << "inclxx-datafile-path = " << INCLXXDataFilePath << std::endl
#ifdef INCL_DEEXCITATION_ABLAXX
      << "ablav3p-cxx-datafile-path = " << ablav3pCxxDataFilePath << std::endl
#endif
#ifdef INCL_DEEXCITATION_ABLA07
      << "abla07-datafile-path = " << abla07DataFilePath << std::endl
#endif
#ifdef INCL_DEEXCITATION_GEMINIXX
      << "geminixx-datafile-path = " << geminixxDataFilePath << std::endl
#endif
      << std::endl << "# Projectile and target definitions" << std::endl
      << "target = " << targetString << "\t# * target nuclide. Can be specified as Fe56, 56Fe, Fe-56, 56-Fe, Fe_56, 56_Fe or Fe. If the mass number is omitted, natural target composition is assumed." << std::endl
      << "         " << "# the target nuclide was parsed as Z=" << targetSpecies.theZ;
    if(targetSpecies.theA>0)
      ss << ", A=" << targetSpecies.theA;
    else
      ss << ", natural target";
    ss << std::endl
      << "projectile = " << projectileString << "\t# * projectile name (proton, neutron, pi+, pi0, pi-, d, t, a, He-4...)" << std::endl
      << "         " << "# the projectile nuclide was parsed as Z=" << projectileSpecies.theZ << ", A=" << projectileSpecies.theA << std::endl
      << "energy = " << projectileKineticEnergy << "\t# * total kinetic energy of the projectile, in MeV" << std::endl
      << std::endl << "# Physics options " << std::endl
      << "pauli = " << pauliString << "\t# Pauli-blocking algorithm. Must be one of: strict-statistical (default), strict, statistical, global, none" << std::endl
      << "cdpp = " << CDPP << "\t# whether to apply CDPP after collisions" << std::endl
      << "coulomb = " << coulombString << "\t# Coulomb-distortion algorithm. Must be one of: non-relativistic (default), none" << std::endl
      << "potential = " << potentialString << "\t# nucleon potential. Must be one of: isospin-energy-smooth, isospin-energy (default), isospin, constant" << std::endl
      << "pion-potential = " << pionPotential << "\t# whether to use a pion potential" << std::endl
      << "local-energy-BB = " << localEnergyBBString << "\t# local energy in baryon-baryon collisions. Must be one of: always, first-collision (default), never" << std::endl
      << "local-energy-pi = " << localEnergyPiString << "\t# local energy in pi-N collisions and in delta decays. Must be one of: always, first-collision (default), never" << std::endl
      << "de-excitation = " << deExcitationString << "\t # which de-excitation model to use. Must be one of:"
      " none (default)"
#ifdef INCL_DEEXCITATION_ABLAXX
      ", ABLAv3p"
#endif
#ifdef INCL_DEEXCITATION_ABLA07
      ", ABLA07"
#endif
#ifdef INCL_DEEXCITATION_SMM
      ", SMM"
#endif
#ifdef INCL_DEEXCITATION_GEMINIXX
      ", GEMINIXX"
#endif
      << std::endl
      << "cluster-algorithm = " << clusterAlgorithmString << "\t# clustering algorithm for production of composites. Must be one of: intercomparison (default), none" << std::endl
      << "cluster-max-mass = " << clusterMaxMass << "\t# maximum mass of produced composites. Must be between 2 and 12 (included)" << std::endl
      << "back-to-spectator = " << backToSpectator << "\t# whether to use back-to-spectator" << std::endl
      << "use-real-masses = " << useRealMasses << "\t# whether to use real masses for the outgoing particle energies" << std::endl
      << "separation-energies = " << separationEnergyString << "\t# how to assign the separation energies of the INCL nucleus. Must be one of: INCL (default), real, real-light" << std::endl
      << std::endl << "# Technical options " << std::endl
      << "verbosity = " << verbosity << "\t# from 0 (quiet) to 10 (most verbose)" << std::endl
      << "verbose-event = " << verboseEvent << "\t# request verbose logging for the specified event only" << std::endl
      << "random-seed-1 = " << randomSeed1 << "\t# first seed for the random-number generator" << std::endl
      << "random-seed-2 = " << randomSeed2 << "\t# second seed for the random-number generator" << std::endl
      << std::endl << "#########################" << std::endl
      << "### End of input echo ###" << std::endl
      << "#########################" << std::endl;
 
    return ss.str();
  }

Referenced by G4INCL::INCL::configToString(), and G4INCL::INCL::INCL().

getBackToSpectator()

G4bool G4INCL::Config::getBackToSpectator ( ) const

inline

Get back-to-spectator.

Definition at line 195 of file G4INCLConfig.hh.

{ return backToSpectator; }

Referenced by G4INCL::InteractionAvatar::postInteraction().

getCalculationTitle()

std::string const & G4INCL::Config::getCalculationTitle ( ) const

inline

Get the run title.

Definition at line 90 of file G4INCLConfig.hh.

{ return title; }

getCDPP()

G4bool G4INCL::Config::getCDPP ( ) const

inline

Do we want CDPP?

Definition at line 150 of file G4INCLConfig.hh.

{ return CDPP; }

Referenced by G4INCL::INCL::INCL().

getClusterAlgorithm()

ClusterAlgorithmType G4INCL::Config::getClusterAlgorithm ( ) const

inline

Get the clustering algorithm.

Definition at line 186 of file G4INCLConfig.hh.

{ return clusterAlgorithmType; }

Referenced by G4INCL::INCL::INCL().

getClusterMaxMass()

G4int G4INCL::Config::getClusterMaxMass ( ) const

inline

Get the maximum mass for production of clusters.

Definition at line 189 of file G4INCLConfig.hh.

{ return clusterMaxMass; }

Referenced by G4INCL::ClusteringModelIntercomparison::getCluster().

getCoulombType()

CoulombType G4INCL::Config::getCoulombType ( ) const

inline

Get the Coulomb-distortion algorithm.

Definition at line 156 of file G4INCLConfig.hh.

{ return coulombType; }

Referenced by G4INCL::INCL::INCL().

getDeExcitationType()

DeExcitationType G4INCL::Config::getDeExcitationType ( ) const

inline

Get the de-excitation model.

Definition at line 183 of file G4INCLConfig.hh.

{ return deExcitationType; }

getImpactParameter()

G4double G4INCL::Config::getImpactParameter ( ) const

inline

Definition at line 227 of file G4INCLConfig.hh.

{ return impactParameter; }

Referenced by G4INCL::INCL::INCL().

getINCLXXDataFilePath()

std::string const & G4INCL::Config::getINCLXXDataFilePath ( ) const

inline

Definition at line 206 of file G4INCLConfig.hh.

                                                   {
      return INCLXXDataFilePath;
    }

Referenced by G4INCL::ParticleTable::initialize().

getLocalEnergyBBType()

LocalEnergyType G4INCL::Config::getLocalEnergyBBType ( ) const

inline

Get the type of local energy for N-N avatars.

Definition at line 168 of file G4INCLConfig.hh.

{ return localEnergyBBType; }

Referenced by G4INCL::INCL::INCL(), and G4INCL::InteractionAvatar::shouldUseLocalEnergy().

getLocalEnergyPiType()

LocalEnergyType G4INCL::Config::getLocalEnergyPiType ( ) const

inline

Get the type of local energy for pi-N and decay avatars.

Definition at line 171 of file G4INCLConfig.hh.

{ return localEnergyPiType; }

Referenced by G4INCL::INCL::INCL(), and G4INCL::InteractionAvatar::shouldUseLocalEnergy().

getLogFileName()

std::string const & G4INCL::Config::getLogFileName ( ) const

inline

Get the log file name.

Definition at line 180 of file G4INCLConfig.hh.

{ return logFileName; }

Referenced by G4INCL::INCL::INCL().

getNumberOfShots()

G4int G4INCL::Config::getNumberOfShots ( ) const

inline

Get the number of shots.

Definition at line 96 of file G4INCLConfig.hh.

{ return nShots; }

getOutputFileRoot()

std::string const & G4INCL::Config::getOutputFileRoot ( ) const

inline

Get the output file root.

Definition at line 93 of file G4INCLConfig.hh.

{ return outputFileRoot; }

getPauliType()

PauliType G4INCL::Config::getPauliType ( ) const

inline

Get the Pauli-blocking algorithm.

Definition at line 147 of file G4INCLConfig.hh.

{ return pauliType; }

Referenced by G4INCL::INCL::INCL().

getPionPotential()

G4bool G4INCL::Config::getPionPotential ( ) const

inline

Do we want the pion potential?

Definition at line 153 of file G4INCLConfig.hh.

{ return pionPotential; }

Referenced by G4INCL::Nucleus::Nucleus().

getPotentialType()

PotentialType G4INCL::Config::getPotentialType ( ) const

inline

Get the type of the potential for nucleons.

Definition at line 159 of file G4INCLConfig.hh.

{ return potentialType; }

Referenced by G4INCL::Nucleus::Nucleus().

getProjectileKineticEnergy()

G4float G4INCL::Config::getProjectileKineticEnergy ( ) const

inline

Get the projectile kinetic energy.

Definition at line 127 of file G4INCLConfig.hh.

{ return projectileKineticEnergy; }

Referenced by G4INCL::INCL::INCL(), and G4INCL::INCL::processEvent().

getProjectileSpecies()

ParticleSpecies G4INCL::Config::getProjectileSpecies ( ) const

inline

Get the projectile species.

Definition at line 121 of file G4INCLConfig.hh.

{ return projectileSpecies; }

Referenced by G4INCL::INCL::INCL(), and G4INCL::INCL::processEvent().

getProjectileType()

ParticleType G4INCL::Config::getProjectileType ( ) const

inline

Get the projectile type.

Definition at line 118 of file G4INCLConfig.hh.

{ return projectileSpecies.theType; }

getRandomSeeds()

SeedVector const G4INCL::Config::getRandomSeeds ( ) const

inline

Get the seeds for the random-number generator.

Definition at line 139 of file G4INCLConfig.hh.

                                            {
      SeedVector s;
      s.push_back(randomSeed1);
      s.push_back(randomSeed2);
      return s;
    }

Referenced by G4INCL::INCL::INCL().

getSeparationEnergyType()

SeparationEnergyType G4INCL::Config::getSeparationEnergyType ( ) const

inline

Get the separation-energy type.

Definition at line 230 of file G4INCLConfig.hh.

{ return separationEnergyType; }

Referenced by G4INCL::ParticleTable::initialize().

getTargetA()

G4int G4INCL::Config::getTargetA ( ) const

inline

Get the target mass number.

Note that A==0 means natural target. You should first check the isNaturalTarget() method.

Definition at line 106 of file G4INCLConfig.hh.

{ return targetSpecies.theA; }

Referenced by G4INCL::INCL::INCL(), and G4INCL::INCL::processEvent().

getTargetZ()

G4int G4INCL::Config::getTargetZ ( ) const

inline

Get the target charge number.

Definition at line 109 of file G4INCLConfig.hh.

{ return targetSpecies.theZ; }

Referenced by G4INCL::INCL::INCL(), and G4INCL::INCL::processEvent().

getUseRealMasses()

G4bool G4INCL::Config::getUseRealMasses ( ) const

inline

Whether to use real masses.

Definition at line 198 of file G4INCLConfig.hh.

{ return useRealMasses; }

Referenced by G4INCL::ParticleTable::initialize().

getVerboseEvent()

G4int G4INCL::Config::getVerboseEvent ( ) const

inline

Get the number of the verbose event.

Definition at line 133 of file G4INCLConfig.hh.

{ return verboseEvent; }

getVerbosity()

G4int G4INCL::Config::getVerbosity ( ) const

inline

Get the verbosity.

Definition at line 87 of file G4INCLConfig.hh.

{ return verbosity; }

Referenced by G4INCL::INCL::INCL().

getVersionID()

std::string const G4INCL::Config::getVersionID ( )

static

Get the INCL version ID.

Definition at line 55 of file G4INCLConfigVersion.cc.

{ return G4INCL_VERSION_ID; }

Referenced by G4INCL::INCL::INCL(), and summary().

init()

void G4INCL::Config::init

(

)

Initialise the members.

Definition at line 642 of file G4INCLConfig.cc.

                    {
      verbosity = 1;
      inputFileName = "";
      title = "INCL default run title";
      nShots = 1000;
      naturalTarget = false;
      projectileString = "proton";
      projectileSpecies = G4INCL::Proton;
      projectileKineticEnergy = 1000.0;
      verboseEvent = -1;
      randomSeed1 = 666;
      randomSeed2 = 777;
      pauliString = "strict-statistical";
      pauliType = StrictStatisticalPauli;
      CDPP = true;
      coulombString = "non-relativistic";
      coulombType = NonRelativisticCoulomb;
      potentialString = "isospin-energy";
      potentialType = IsospinEnergyPotential;
      pionPotential = true;
      localEnergyBBString = "first-collision";
      localEnergyBBType = FirstCollisionLocalEnergy;
      localEnergyPiString = "first-collision";
      localEnergyPiType = FirstCollisionLocalEnergy;
      deExcitationString = "none";
      deExcitationType = DeExcitationNone;
      clusterAlgorithmString = "intercomparison";
      clusterAlgorithmType = IntercomparisonClusterAlgorithm;
      clusterMaxMass = 8;
      backToSpectator = true;
      useRealMasses = true;
      impactParameter = -1.;
      separationEnergyString = "INCL";
      separationEnergyType = INCLSeparationEnergy;
  }

Referenced by Config().

isNaturalTarget()

G4bool G4INCL::Config::isNaturalTarget ( ) const

inline

Natural targets.

Definition at line 99 of file G4INCLConfig.hh.

{ return naturalTarget; }

Referenced by G4INCL::INCL::prepareReaction().

setClusterMaxMass()

void G4INCL::Config::setClusterMaxMass ( const G4int  m )

inline

Set the maximum mass for production of clusters.

Definition at line 192 of file G4INCLConfig.hh.

{ clusterMaxMass=m; }

Referenced by G4INCLXXInterfaceStore::GetINCLModel().

setLocalEnergyBBType()

void G4INCL::Config::setLocalEnergyBBType ( const LocalEnergyType  t )

inline

Set the type of local energy for N-N avatars.

Definition at line 174 of file G4INCLConfig.hh.

{ localEnergyBBType=t; }

setLocalEnergyPiType()

void G4INCL::Config::setLocalEnergyPiType ( const LocalEnergyType  t )

inline

Set the type of local energy for N-N avatars.

Definition at line 177 of file G4INCLConfig.hh.

{ localEnergyPiType=t; }

setPionPotential()

void G4INCL::Config::setPionPotential ( const G4bool  pionPot )

inline

Set the type of the potential for nucleons.

Definition at line 165 of file G4INCLConfig.hh.

{ pionPotential = pionPot; }

setPotentialType()

void G4INCL::Config::setPotentialType ( PotentialType  type )

inline

Set the type of the potential for nucleons.

Definition at line 162 of file G4INCLConfig.hh.

{ potentialType = type; }

setProjectileKineticEnergy()

void G4INCL::Config::setProjectileKineticEnergy ( G4float const  kinE )

inline

Set the projectile kinetic energy.

Definition at line 130 of file G4INCLConfig.hh.

{ projectileKineticEnergy=kinE; }

setProjectileSpecies()

void G4INCL::Config::setProjectileSpecies ( ParticleSpecies const &  ps )

inline

Set the projectile species.

Definition at line 124 of file G4INCLConfig.hh.

{ projectileSpecies=ps; }

setTargetA()

void G4INCL::Config::setTargetA ( G4int  A )

inline

Set target mass number.

Definition at line 112 of file G4INCLConfig.hh.

{ targetSpecies.theA = A; }

setTargetZ()

void G4INCL::Config::setTargetZ ( G4int  Z )

inline

Set target charge number.

Definition at line 115 of file G4INCLConfig.hh.

{ targetSpecies.theZ = Z; }

setUseRealMasses()

void G4INCL::Config::setUseRealMasses ( G4bool  use )

inline

Set whether to use real masses.

Definition at line 201 of file G4INCLConfig.hh.

{ useRealMasses = use; }

summary()

std::string G4INCL::Config::summary

(

)

Return a summary of the run configuration.

Definition at line 678 of file G4INCLConfig.cc.

                            {
    std::stringstream message;
    message << "INCL++ version " << getVersionID() << std::endl;
    if(projectileSpecies.theType != Composite)
      message << "Projectile: " << ParticleTable::getName(projectileSpecies) << std::endl;
    else
      message << "Projectile: composite, A=" << projectileSpecies.theA << ", Z=" << projectileSpecies.theZ << std::endl;
    message << "  energy = " << projectileKineticEnergy << std::endl;
    if(targetSpecies.theA>0)
      message << "Target: A = " << targetSpecies.theA << " Z = " << targetSpecies.theZ << std::endl;
    else
      message << "Target: natural isotopic composition, Z = " << targetSpecies.theZ << std::endl;
    message << "Number of requested shots = " << nShots << std::endl;
    return message.str();
  }

---

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

• G4INCLConfig.hh
• G4INCLConfig.cc
• G4INCLConfigVersion.cc