Config Class Reference

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

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

Private Attributes
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
G4int	randomSeed1
G4int	randomSeed2
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
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	cutNN
G4double	rpCorrelationCoefficient
G4double	rpCorrelationCoefficientProton
G4double	rpCorrelationCoefficientNeutron
G4double	neutronSkinThickness
G4double	neutronSkinAdditionalDiffuseness
G4bool	refraction

Static Private Attributes
static const G4int	randomSeedMin
static const G4int	randomSeedMax

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.

Constructor & Destructor Documentation

Config

(

)

Default constructor.

Config	(	G4int	,
		G4int	,
		ParticleSpecies	,
		G4double
	)

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

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

~Config

(

)

Default destructor.

Member Function Documentation

void init

(

)

Initialise the members.

std::string summary

(

)

Return a summary of the run configuration.

G4int getVerbosity

(

)

const

Get the verbosity.

References Config::verbosity.

std::string const& getCalculationTitle

(

)

const

Get the run title.

References Config::title.

std::string const& getOutputFileRoot

(

)

const

Get the output file root.

References Config::outputFileRoot.

G4int getNumberOfShots

(

)

const

Get the number of shots.

References Config::nShots.

G4bool isNaturalTarget

(

)

const

Natural targets.

References Config::naturalTarget.

G4int getTargetA

(

)

const

Get the target mass number.

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

References Config::targetSpecies, and ParticleSpecies::theA.

Referenced by INCL::processEvent().

G4int getTargetZ

(

)

const

Get the target charge number.

References Config::targetSpecies, and ParticleSpecies::theZ.

Referenced by INCL::processEvent().

void setTargetA

(

G4int

A

)

Set target mass number.

References Config::targetSpecies, and ParticleSpecies::theA.

void setTargetZ

(

G4int

Z

)

Set target charge number.

References Config::targetSpecies, and ParticleSpecies::theZ.

ParticleType getProjectileType

(

)

const

Get the projectile type.

References Config::projectileSpecies, and ParticleSpecies::theType.

ParticleSpecies getProjectileSpecies

(

)

const

Get the projectile species.

References Config::projectileSpecies.

Referenced by INCL::processEvent().

void setProjectileSpecies

(

ParticleSpecies const &

ps

)

Set the projectile species.

References Config::projectileSpecies.

G4double getProjectileKineticEnergy

(

)

const

Get the projectile kinetic energy.

References Config::projectileKineticEnergy.

Referenced by INCL::processEvent().

void setProjectileKineticEnergy

(

G4double const

kinE

)

Set the projectile kinetic energy.

References Config::projectileKineticEnergy.

G4int getVerboseEvent

(

)

const

Get the number of the verbose event.

References Config::verboseEvent.

static std::string const getVersionID ( )

static

Get the INCL version ID.

Referenced by Config::getVersionString().

static std::string const getVersionHash ( )

static

Get the INCL version hash.

Referenced by Config::getVersionString().

static std::string const getVersionString ( )

static

Get the INCL version string.

References Config::getVersionHash(), and Config::getVersionID().

Random::SeedVector getRandomSeeds

(

)

const

Get the seeds for the random-number generator.

References SeedVector::push_back(), Config::randomSeed1, and Config::randomSeed2.

PauliType getPauliType

(

)

const

Get the Pauli-blocking algorithm.

References Config::pauliType.

G4bool getCDPP

(

)

const

Do we want CDPP?

References Config::CDPP.

G4bool getPionPotential

(

)

const

Do we want the pion potential?

References Config::pionPotential.

CoulombType getCoulombType

(

)

const

Get the Coulomb-distortion algorithm.

References Config::coulombType.

PotentialType getPotentialType

(

)

const

Get the type of the potential for nucleons.

References Config::potentialType.

void setPotentialType

(

PotentialType

type

)

Set the type of the potential for nucleons.

References Config::potentialType.

void setPionPotential

(

const G4bool

pionPot

)

Set the type of the potential for nucleons.

References Config::pionPotential.

LocalEnergyType getLocalEnergyBBType

(

)

const

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

References Config::localEnergyBBType.

Referenced by InteractionAvatar::shouldUseLocalEnergy().

LocalEnergyType getLocalEnergyPiType

(

)

const

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

References Config::localEnergyPiType.

Referenced by InteractionAvatar::shouldUseLocalEnergy().

void setLocalEnergyBBType

(

const LocalEnergyType

t

)

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

References Config::localEnergyBBType.

void setLocalEnergyPiType

(

const LocalEnergyType

t

)

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

References Config::localEnergyPiType.

std::string const& getLogFileName

(

)

const

Get the log file name.

References Config::logFileName.

DeExcitationType getDeExcitationType

(

)

const

Get the de-excitation model.

References Config::deExcitationType.

std::string getDeExcitationString

(

)

const

Get the de-excitation string.

References Config::deExcitationString.

ClusterAlgorithmType getClusterAlgorithm

(

)

const

Get the clustering algorithm.

References Config::clusterAlgorithmType.

G4int getClusterMaxMass

(

)

const

Get the maximum mass for production of clusters.

References Config::clusterMaxMass.

void setClusterMaxMass

(

const G4int

m

)

Set the maximum mass for production of clusters.

References Config::clusterMaxMass, and m.

G4bool getBackToSpectator

(

)

const

Get back-to-spectator.

References Config::backToSpectator.

G4bool getUseRealMasses

(

)

const

Whether to use real masses.

References Config::useRealMasses.

void setUseRealMasses

(

G4bool

use

)

Set whether to use real masses.

References Config::useRealMasses.

std::string const& getINCLXXDataFilePath

(

)

const

References Config::INCLXXDataFilePath.

G4double getImpactParameter

(

)

const

References Config::impactParameter.

SeparationEnergyType getSeparationEnergyType

(

)

const

Get the separation-energy type.

References Config::separationEnergyType.

FermiMomentumType getFermiMomentumType

(

)

const

Get the Fermi-momentum type.

References Config::fermiMomentumType.

void setFermiMomentumType

(

FermiMomentumType const

f

)

Set the Fermi-momentum type.

References Config::fermiMomentumType.

G4double getCutNN

(

)

const

References Config::cutNN.

G4double getRPCorrelationCoefficient

(

const ParticleType

t

)

const

Get the r-p correlation coefficient.

References G4INCL::Proton, Config::rpCorrelationCoefficientNeutron, and Config::rpCorrelationCoefficientProton.

void setRPCorrelationCoefficient	(	const ParticleType	t,
		const G4double	corrCoeff
	)

Set the r-p correlation coefficient.

References G4INCL::Proton, Config::rpCorrelationCoefficientNeutron, and Config::rpCorrelationCoefficientProton.

Referenced by Config::setRPCorrelationCoefficient().

void setRPCorrelationCoefficient

(

const G4double

corrCoeff

)

Set the r-p correlation coefficient.

References G4INCL::Neutron, G4INCL::Proton, and Config::setRPCorrelationCoefficient().

G4double getNeutronSkinThickness

(

)

const

Get the neutron-skin thickness.

References Config::neutronSkinThickness.

void setNeutronSkinThickness

(

const G4double

d

)

Set the neutron-skin thickness.

References Config::neutronSkinThickness.

G4double getNeutronSkinAdditionalDiffuseness

(

)

const

Get the neutron-skin additional diffuseness.

References Config::neutronSkinAdditionalDiffuseness.

void setNeutronSkinAdditionalDiffuseness

(

const G4double

d

)

Set the neutron-skin additional diffuseness.

References Config::neutronSkinAdditionalDiffuseness.

G4bool getRefraction

(

)

const

True if we should use refraction.

References Config::refraction.

void setRefraction

(

const G4bool

r

)

Set the refraction variable.

References Config::refraction.

Member Data Documentation

G4int verbosity

private

Referenced by Config::getVerbosity().

std::string inputFileName

private

std::string title

private

Referenced by Config::getCalculationTitle().

std::string outputFileRoot

private

Referenced by Config::getOutputFileRoot().

std::string fileSuffix

private

std::string logFileName

private

Referenced by Config::getLogFileName().

G4int nShots

private

Referenced by Config::getNumberOfShots().

std::string targetString

private

ParticleSpecies targetSpecies

private

Referenced by Config::getTargetA(), Config::getTargetZ(), Config::setTargetA(), and Config::setTargetZ().

G4bool naturalTarget

private

Referenced by Config::isNaturalTarget().

std::string projectileString

private

ParticleSpecies projectileSpecies

private

Referenced by Config::getProjectileSpecies(), Config::getProjectileType(), and Config::setProjectileSpecies().

G4double projectileKineticEnergy

private

Referenced by Config::getProjectileKineticEnergy(), and Config::setProjectileKineticEnergy().

G4int verboseEvent

private

Referenced by Config::getVerboseEvent().

G4int randomSeed1

private

Referenced by Config::getRandomSeeds().

G4int randomSeed2

private

Referenced by Config::getRandomSeeds().

const G4int randomSeedMin

staticprivate

const G4int randomSeedMax

staticprivate

std::string pauliString

private

PauliType pauliType

private

Referenced by Config::getPauliType().

G4bool CDPP

private

Referenced by Config::getCDPP().

std::string coulombString

private

CoulombType coulombType

private

Referenced by Config::getCoulombType().

std::string potentialString

private

PotentialType potentialType

private

Referenced by Config::getPotentialType(), and Config::setPotentialType().

G4bool pionPotential

private

Referenced by Config::getPionPotential(), and Config::setPionPotential().

std::string localEnergyBBString

private

LocalEnergyType localEnergyBBType

private

Referenced by Config::getLocalEnergyBBType(), and Config::setLocalEnergyBBType().

std::string localEnergyPiString

private

LocalEnergyType localEnergyPiType

private

Referenced by Config::getLocalEnergyPiType(), and Config::setLocalEnergyPiType().

std::string deExcitationModelList

private

std::string deExcitationOptionDescription

private

std::string deExcitationString

private

Referenced by Config::getDeExcitationString().

DeExcitationType deExcitationType

private

Referenced by Config::getDeExcitationType().

std::string INCLXXDataFilePath

private

Referenced by Config::getINCLXXDataFilePath().

std::string clusterAlgorithmString

private

ClusterAlgorithmType clusterAlgorithmType

private

Referenced by Config::getClusterAlgorithm().

G4int clusterMaxMass

private

Referenced by Config::getClusterMaxMass(), and Config::setClusterMaxMass().

G4bool backToSpectator

private

Referenced by Config::getBackToSpectator().

G4bool useRealMasses

private

Referenced by Config::getUseRealMasses(), and Config::setUseRealMasses().

G4double impactParameter

private

Referenced by Config::getImpactParameter().

std::string separationEnergyString

private

SeparationEnergyType separationEnergyType

private

Referenced by Config::getSeparationEnergyType().

std::string fermiMomentumString

private

FermiMomentumType fermiMomentumType

private

Referenced by Config::getFermiMomentumType(), and Config::setFermiMomentumType().

G4double cutNN

private

Referenced by Config::getCutNN().

G4double rpCorrelationCoefficient

private

G4double rpCorrelationCoefficientProton

private

Referenced by Config::getRPCorrelationCoefficient(), and Config::setRPCorrelationCoefficient().

G4double rpCorrelationCoefficientNeutron

private

Referenced by Config::getRPCorrelationCoefficient(), and Config::setRPCorrelationCoefficient().

G4double neutronSkinThickness

private

Referenced by Config::getNeutronSkinThickness(), and Config::setNeutronSkinThickness().

G4double neutronSkinAdditionalDiffuseness

private

Referenced by Config::getNeutronSkinAdditionalDiffuseness(), and Config::setNeutronSkinAdditionalDiffuseness().

G4bool refraction

private

Referenced by Config::getRefraction(), and Config::setRefraction().