Singleton class for configuring the INCL++ Geant4 interface. More...

#include <G4INCLXXInterfaceStore.hh>

Public Member Functions
G4INCL::INCL *	GetINCLModel ()
	Get the cached INCL model engine. More...

void	constructINCLXXVersionName ()

const std::string &	getINCLXXVersionName ()

void	SetAccurateProjectile (const G4bool b)
	Setter for accurateProjectile. More...

void	SetMaxClusterMass (const G4int aMass)
	Setter for the maximum cluster mass. More...

void	SetCascadeMinEnergyPerNucleon (const G4double anEnergy)
	Setter for cascadeMinEnergyPerNucleon. More...

void	SetConservationTolerance (const G4double aTolerance)
	Setter for conservationTolerance. More...

G4bool	GetAccurateProjectile () const
	Getter for accurateProjectile. More...

G4double	GetCascadeMinEnergyPerNucleon () const
	Getter for cascadeMinEnergyPerNucleon. More...

G4INCL::Config &	GetINCLConfig ()
	Getter for theConfig. More...

G4int	GetMaxProjMassINCL () const
	Getter for theMaxProjMassINCL. More...

G4double	GetConservationTolerance () const
	Getter for conservationTolerance. More...

void	EmitWarning (const G4String &message)
	Emit a warning to G4cout. More...

void	EmitBigWarning (const G4String &message) const
	Emit a BIG warning to G4cout. More...

Static Public Member Functions
static G4INCLXXInterfaceStore *	GetInstance ()
	Get the singleton instance. More...

static void	DeleteInstance ()
	Delete the singleton instance. More...

Detailed Description

Singleton class for configuring the INCL++ Geant4 interface.

This class also contains a single cached instance of the INCL model (

See also: {G4INCL::INCL}).

Definition at line 62 of file G4INCLXXInterfaceStore.hh.

Member Function Documentation

void G4INCLXXInterfaceStore::constructINCLXXVersionName ( )

Definition at line 91 of file G4INCLXXInterfaceStore.cc.

References G4INCL_VERSION_ID.

                                                         {
   const std::string versionID = G4INCL_VERSION_ID;
   const size_t lastDash = versionID.find_last_of("-");
   versionName = "INCL++ " + versionID.substr(0,lastDash);
 }

void G4INCLXXInterfaceStore::DeleteInstance ( )

static

Delete the singleton instance.

Definition at line 77 of file G4INCLXXInterfaceStore.cc.

                                             {
   delete theInstance;
   theInstance = NULL;
 }

void G4INCLXXInterfaceStore::EmitBigWarning ( const G4String & message ) const

Emit a BIG warning to G4cout.

There is no limit on the number of BIG warnings emitted.

Definition at line 167 of file G4INCLXXInterfaceStore.cc.

References G4cout, and G4endl.

Referenced by G4INCLXXInterface::ApplyYourself(), SetAccurateProjectile(), SetCascadeMinEnergyPerNucleon(), and SetMaxClusterMass().

                                                                          {
   G4cout
     << G4endl
     << "================================================================================"
     << G4endl
     << "                                 INCL++ WARNING                                 "
     << G4endl
     << message
     << G4endl
     << "================================================================================"
     << G4endl
     << G4endl;
 }

void G4INCLXXInterfaceStore::EmitWarning ( const G4String & message )

Emit a warning to G4cout.

The InterfaceStore will not emit more than maxWarnings warnings.

Definition at line 158 of file G4INCLXXInterfaceStore.cc.

References G4cout, and G4endl.

Referenced by G4INCLXXInterface::ApplyYourself(), and G4INCLXXInterface::G4INCLXXInterface().

                                                                 {
   if(++nWarnings<=maxWarnings) {
     G4cout << "[INCL++] Warning: " << message << G4endl;
     if(nWarnings==maxWarnings) {
       G4cout << "[INCL++] INCL++ has already emitted " << maxWarnings << " warnings and will emit no more." << G4endl;
     }
   }
 }

G4bool G4INCLXXInterfaceStore::GetAccurateProjectile ( ) const

Getter for accurateProjectile.

The

See also: {G4INCLXXInterfaceMessenger} class provides a UI command to set this parameter.

Definition at line 145 of file G4INCLXXInterfaceStore.cc.

145 { return accurateProjectile; }

G4double G4INCLXXInterfaceStore::GetCascadeMinEnergyPerNucleon ( ) const

Getter for cascadeMinEnergyPerNucleon.

The

See also: {G4INCLXXInterfaceMessenger} class provides a UI command to set this parameter.

Definition at line 147 of file G4INCLXXInterfaceStore.cc.

Referenced by G4INCLXXInterface::ApplyYourself().

147 { return cascadeMinEnergyPerNucleon; }

G4double G4INCLXXInterfaceStore::GetConservationTolerance ( ) const

Getter for conservationTolerance.

Definition at line 151 of file G4INCLXXInterfaceStore.cc.

151 { return conservationTolerance; }

G4INCL::Config & G4INCLXXInterfaceStore::GetINCLConfig ( )

Getter for theConfig.

Definition at line 149 of file G4INCLXXInterfaceStore.cc.

149 { return theConfig; }

G4INCL::INCL * G4INCLXXInterfaceStore::GetINCLModel ( )

Get the cached INCL model engine.

Definition at line 82 of file G4INCLXXInterfaceStore.cc.

Referenced by G4INCLXXInterface::ApplyYourself().

                                                  {
   if(!theINCLModel) {
     G4INCL::Config *aConfig = new G4INCL::Config(theConfig);
     theINCLModel = new G4INCL::INCL(aConfig);
     // ownership of the aConfig object is taken over by the INCL model engine
   }
   return theINCLModel;
 }

const std::string & G4INCLXXInterfaceStore::getINCLXXVersionName ( )

Definition at line 97 of file G4INCLXXInterfaceStore.cc.

                                                               {
   return versionName;
 }

G4INCLXXInterfaceStore * G4INCLXXInterfaceStore::GetInstance ( void )

static

Get the singleton instance.

Definition at line 71 of file G4INCLXXInterfaceStore.cc.

Referenced by G4INCLXXInterface::ApplyYourself().

                                                             {
   if(!theInstance)
     theInstance = new G4INCLXXInterfaceStore;
   return theInstance;
 }

G4int G4INCLXXInterfaceStore::GetMaxProjMassINCL ( ) const

Getter for theMaxProjMassINCL.

Definition at line 156 of file G4INCLXXInterfaceStore.cc.

Referenced by G4INCLXXInterface::ApplyYourself().

156 { return theMaxProjMassINCL; }

void G4INCLXXInterfaceStore::SetAccurateProjectile ( const G4bool b )

Setter for accurateProjectile.

Definition at line 103 of file G4INCLXXInterfaceStore.cc.

References test::b, EmitBigWarning(), and G4endl.

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

                                                                  {
   if(accurateProjectile!=b) {
     // Parameter is changed, emit a big warning message
     std::stringstream ss;
     ss << "Switching from "
       << (accurateProjectile ? "\"accurate projectile\" mode to \"accurate target\"" : "\"accurate target\" mode to \"accurate projectile\"")
       << " mode."
       << G4endl
       << "Do this ONLY if you fully understand what it does!";
     EmitBigWarning(ss.str());
   }
 
   // No need to delete the model for this parameter
 
   accurateProjectile=b;
 }

void G4INCLXXInterfaceStore::SetCascadeMinEnergyPerNucleon ( const G4double anEnergy )

Setter for cascadeMinEnergyPerNucleon.

Definition at line 181 of file G4INCLXXInterfaceStore.cc.

References EmitBigWarning(), G4endl, and python.hepunit::MeV.

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

                                                                                   {
   if(cascadeMinEnergyPerNucleon!=anEnergy) {
     // Parameter is changed, emit a big warning message
     std::stringstream ss;
     ss << "Changing minimim cascade energy from "
       << cascadeMinEnergyPerNucleon / MeV
       << " to "
       << anEnergy / MeV
       << " MeV."
       << G4endl
       << "Do this ONLY if you fully understand what this setting does!";
     EmitBigWarning(ss.str());
   }
 
   // No need to delete the model object
 
   cascadeMinEnergyPerNucleon=anEnergy;
 }

void G4INCLXXInterfaceStore::SetConservationTolerance ( const G4double aTolerance )

Setter for conservationTolerance.

Definition at line 200 of file G4INCLXXInterfaceStore.cc.

                                                                                {
   conservationTolerance = aTolerance;
 }

void G4INCLXXInterfaceStore::SetMaxClusterMass ( const G4int aMass )

Setter for the maximum cluster mass.

Definition at line 120 of file G4INCLXXInterfaceStore.cc.

References EmitBigWarning(), G4endl, G4INCL::Config::getClusterMaxMass(), and G4INCL::Config::setClusterMaxMass().

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

                                                                 {
   const G4int theMaxClusterMass = theConfig.getClusterMaxMass();
   if(theMaxClusterMass!=aMass) {
     // Parameter is changed, emit a big warning message
     std::stringstream ss;
     ss << "Changing maximum cluster mass from "
       << theMaxClusterMass
       << " to "
       << aMass
       << "."
       << G4endl
       << "Do this ONLY if you fully understand what this setting does!";
     EmitBigWarning(ss.str());
 
     // We must delete the model object to make sure that we use the new
     // parameter
     DeleteModel();
 
     theConfig.setClusterMaxMass(aMass);
   }
 }

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation