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

#include <G4INCLXXInterfaceStore.hh>

Public Member Functions
void	constructINCLXXVersionName ()

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

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

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

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

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

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

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

const std::string &	getINCLXXVersionName ()

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

G4INCLXXVInterfaceTally *	GetTally () const
	Getter for the interface tally. More...

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

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

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

void	SetINCLPhysics (const G4String &option)
	Set the INCL physics. More...

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

void	SetTally (G4INCLXXVInterfaceTally *const aTally)
	Setter for the interface tally. More...

void	UseAblaDeExcitation ()
	Set ABLA V3 to be the de-excitation model to be used with INCL++. More...

Static Public Member Functions
static void	DeleteInstance ()
	Delete the singleton instance. More...

static G4INCLXXInterfaceStore *	GetInstance ()
	Get the singleton instance. More...

Private Member Functions
void	DeleteModel ()
	Delete the INCL model engine. More...

	G4INCLXXInterfaceStore ()
	Private constructor. More...

	~G4INCLXXInterfaceStore ()
	Private destructor. More...

Private Attributes
G4bool	accurateProjectile

G4double	cascadeMinEnergyPerNucleon

G4double	conservationTolerance

const G4int	maxWarnings
	Maximum number of warnings. More...

G4int	nWarnings
	Static warning counter. More...

G4INCL::Config	theConfig

G4INCL::INCL *	theINCLModel

G4INCLXXInterfaceMessenger *	theINCLXXInterfaceMessenger

const G4int	theMaxProjMassINCL

G4INCLXXVInterfaceTally *	theTally

std::string	versionName

Static Private Attributes
static G4ThreadLocal G4INCLXXInterfaceStore *	theInstance = NULL

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 64 of file G4INCLXXInterfaceStore.hh.

Constructor & Destructor Documentation

◆ G4INCLXXInterfaceStore()

G4INCLXXInterfaceStore::G4INCLXXInterfaceStore ( )

private

Private constructor.

This class is a singleton. It must be instantiated using the GetInstance static method.

Definition at line 59 of file G4INCLXXInterfaceStore.cc.

                                               :
  accurateProjectile(true),
  theMaxProjMassINCL(18),
  cascadeMinEnergyPerNucleon(1.*MeV),
  conservationTolerance(5*MeV),
  theINCLModel(NULL),
  theTally(NULL),
  nWarnings(0),
  maxWarnings(50)
{
  constructINCLXXVersionName();
  theINCLXXInterfaceMessenger = new G4INCLXXInterfaceMessenger(this);
}

References constructINCLXXVersionName(), and theINCLXXInterfaceMessenger.

Referenced by GetInstance().

◆ ~G4INCLXXInterfaceStore()

G4INCLXXInterfaceStore::~G4INCLXXInterfaceStore ( )

private

Private destructor.

This class is a singleton. Its instance must be deleted using the DeleteInstance static method.

Definition at line 73 of file G4INCLXXInterfaceStore.cc.

                                                {
  delete theINCLXXInterfaceMessenger;
  delete theINCLModel;
}

References theINCLModel, and theINCLXXInterfaceMessenger.

Member Function Documentation

◆ constructINCLXXVersionName()

void G4INCLXXInterfaceStore::constructINCLXXVersionName ( )

Definition at line 102 of file G4INCLXXInterfaceStore.cc.

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

References G4INCL_VERSION_ID, and versionName.

Referenced by G4INCLXXInterfaceStore().

◆ DeleteInstance()

void G4INCLXXInterfaceStore::DeleteInstance ( )

static

Delete the singleton instance.

Definition at line 88 of file G4INCLXXInterfaceStore.cc.

                                            {
  delete theInstance;
  theInstance = NULL;
}

References theInstance.

◆ DeleteModel()

void G4INCLXXInterfaceStore::DeleteModel ( )

private

Delete the INCL model engine.

Definition at line 78 of file G4INCLXXInterfaceStore.cc.

                                         {
  delete theINCLModel; theINCLModel=NULL;
}

References theINCLModel.

Referenced by GetINCLConfig(), and SetMaxClusterMass().

◆ EmitBigWarning()

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 181 of file G4INCLXXInterfaceStore.cc.

                                                                         {
  // Disable the printing when global hadronic verbosity is zero
  // (which can be issued via the UI command "/process/had/verbose 0" )
  if ( G4HadronicParameters::Instance()->GetVerboseLevel() == 0 ) return;
  G4cout
    << G4endl
    << "================================================================================"
    << G4endl
    << "                                 INCL++ WARNING                                 "
    << G4endl
    << message
    << G4endl
    << "================================================================================"
    << G4endl
    << G4endl;
}

References G4cout, G4endl, and G4HadronicParameters::Instance().

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

◆ EmitWarning()

void G4INCLXXInterfaceStore::EmitWarning ( const G4String & message )

Emit a warning to G4cout.

The InterfaceStore will not emit more than maxWarnings warnings.

Definition at line 172 of file G4INCLXXInterfaceStore.cc.

                                                                {
  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;
    }
  }
}

References G4cout, G4endl, maxWarnings, and nWarnings.

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

◆ GetAccurateProjectile()

G4bool G4INCLXXInterfaceStore::GetAccurateProjectile ( ) const

Getter for accurateProjectile.

The

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

Definition at line 156 of file G4INCLXXInterfaceStore.cc.

156{ return accurateProjectile; }

References accurateProjectile.

Referenced by G4INCLXXInterface::AccurateProjectile().

◆ GetCascadeMinEnergyPerNucleon()

G4double G4INCLXXInterfaceStore::GetCascadeMinEnergyPerNucleon ( ) const

Getter for cascadeMinEnergyPerNucleon.

The

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

Definition at line 158 of file G4INCLXXInterfaceStore.cc.

158{ return cascadeMinEnergyPerNucleon; }

References cascadeMinEnergyPerNucleon.

Referenced by G4INCLXXInterface::ApplyYourself().

◆ GetConservationTolerance()

G4double G4INCLXXInterfaceStore::GetConservationTolerance ( ) const

Getter for conservationTolerance.

Definition at line 165 of file G4INCLXXInterfaceStore.cc.

165{ return conservationTolerance; }

References conservationTolerance.

Referenced by G4INCLXXInterface::ApplyYourself().

◆ GetINCLConfig()

G4INCL::Config & G4INCLXXInterfaceStore::GetINCLConfig ( )

Getter for theConfig.

Definition at line 160 of file G4INCLXXInterfaceStore.cc.

                                                    {
  DeleteModel(); // in case the Config is modified
  return theConfig;
}

References DeleteModel(), and theConfig.

◆ GetINCLModel()

G4INCL::INCL * G4INCLXXInterfaceStore::GetINCLModel ( )

Get the cached INCL model engine.

Definition at line 93 of file G4INCLXXInterfaceStore.cc.

                                                 {
  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;
}

References theConfig, and theINCLModel.

Referenced by G4INCLXXInterface::ApplyYourself().

◆ getINCLXXVersionName()

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

Definition at line 108 of file G4INCLXXInterfaceStore.cc.

                                                              {
  return versionName;
}

References versionName.

Referenced by UseAblaDeExcitation().

◆ GetInstance()

G4INCLXXInterfaceStore * G4INCLXXInterfaceStore::GetInstance ( )

static

Get the singleton instance.

Definition at line 82 of file G4INCLXXInterfaceStore.cc.

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

References G4INCLXXInterfaceStore(), and theInstance.

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

◆ GetMaxProjMassINCL()

G4int G4INCLXXInterfaceStore::GetMaxProjMassINCL ( ) const

Getter for theMaxProjMassINCL.

Definition at line 170 of file G4INCLXXInterfaceStore.cc.

170{ return theMaxProjMassINCL; }

References theMaxProjMassINCL.

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

◆ GetTally()

G4INCLXXVInterfaceTally * G4INCLXXInterfaceStore::GetTally ( ) const

Getter for the interface tally.

Definition at line 221 of file G4INCLXXInterfaceStore.cc.

221{ return theTally; }

References theTally.

Referenced by G4INCLXXInterface::ApplyYourself().

◆ SetAccurateProjectile()

void G4INCLXXInterfaceStore::SetAccurateProjectile ( const G4bool b )

Setter for accurateProjectile.

Definition at line 114 of file G4INCLXXInterfaceStore.cc.

                                                                 {
  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;
}

References accurateProjectile, EmitBigWarning(), and G4endl.

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

◆ SetCascadeMinEnergyPerNucleon()

void G4INCLXXInterfaceStore::SetCascadeMinEnergyPerNucleon ( const G4double anEnergy )

Setter for cascadeMinEnergyPerNucleon.

Definition at line 198 of file G4INCLXXInterfaceStore.cc.

                                                                                  {
  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;
}

References cascadeMinEnergyPerNucleon, EmitBigWarning(), G4endl, and MeV.

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

◆ SetConservationTolerance()

void G4INCLXXInterfaceStore::SetConservationTolerance ( const G4double aTolerance )

Setter for conservationTolerance.

Definition at line 217 of file G4INCLXXInterfaceStore.cc.

                                                                               {
  conservationTolerance = aTolerance;
}

References conservationTolerance.

◆ SetINCLPhysics()

void G4INCLXXInterfaceStore::SetINCLPhysics ( const G4String & option )

Set the INCL physics.

Definition at line 225 of file G4INCLXXInterfaceStore.cc.

                                                                  {
  if(option == "default") {
    theConfig.init();
  } else if(option == "incl42") {
    const G4String message = "Changing INCL++ physics to mimic INCL4.2. Do this ONLY if you fully understand the implications!";
    EmitBigWarning(message);
 
    theConfig.setPotentialType(G4INCL::ConstantPotential);
    theConfig.setPionPotential(false);
    theConfig.setLocalEnergyBBType(G4INCL::NeverLocalEnergy);
    theConfig.setLocalEnergyPiType(G4INCL::NeverLocalEnergy);
    theConfig.setBackToSpectator(false);
    theConfig.setClusterAlgorithm(G4INCL::NoClusterAlgorithm);
    theConfig.setCoulombType(G4INCL::NoCoulomb);
    // UseRealMasses intentionally left out because it creates problems with
    // energy conservation
    // theConfig.setUseRealMasses(false);
    theConfig.setCrossSectionsType(G4INCL::INCL46CrossSections);
  } else {
    G4Exception("G4INCLXXInterfaceStore::SetINCLPhysics", "INCLXX0001", FatalErrorInArgument,
                "SetINCLPhysics argument must be one of: default, incl42"
                );
  }
}

References G4INCL::ConstantPotential, EmitBigWarning(), FatalErrorInArgument, G4Exception(), G4INCL::INCL46CrossSections, G4INCL::Config::init(), G4INCL::NeverLocalEnergy, G4INCL::NoClusterAlgorithm, G4INCL::NoCoulomb, G4INCL::Config::setBackToSpectator(), G4INCL::Config::setClusterAlgorithm(), G4INCL::Config::setCoulombType(), G4INCL::Config::setCrossSectionsType(), G4INCL::Config::setLocalEnergyBBType(), G4INCL::Config::setLocalEnergyPiType(), G4INCL::Config::setPionPotential(), G4INCL::Config::setPotentialType(), and theConfig.

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

◆ SetMaxClusterMass()

void G4INCLXXInterfaceStore::SetMaxClusterMass ( const G4int aMass )

Setter for the maximum cluster mass.

Definition at line 131 of file G4INCLXXInterfaceStore.cc.

                                                                {
  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);
  }
}

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

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

◆ SetTally()

void G4INCLXXInterfaceStore::SetTally ( G4INCLXXVInterfaceTally *const aTally )

Setter for the interface tally.

Definition at line 223 of file G4INCLXXInterfaceStore.cc.

223{ theTally = aTally; }

References theTally.

◆ UseAblaDeExcitation()

void G4INCLXXInterfaceStore::UseAblaDeExcitation ( )

Set ABLA V3 to be the de-excitation model to be used with INCL++.

Definition at line 250 of file G4INCLXXInterfaceStore.cc.

                                                 {
  // Get hold of pointers to the INCL++ model interfaces
  std::vector<G4HadronicInteraction *> const &interactions = G4HadronicInteractionRegistry::Instance()
    ->FindAllModels(G4INCLXXInterfaceStore::GetInstance()->getINCLXXVersionName());
  for(std::vector<G4HadronicInteraction *>::const_iterator iInter=interactions.begin(), e=interactions.end();
      iInter!=e; ++iInter) {
    G4INCLXXInterface *theINCLInterface = dynamic_cast<G4INCLXXInterface*>(*iInter);
    if(theINCLInterface) {
      // Instantiate the ABLA model
      G4HadronicInteraction *interaction = G4HadronicInteractionRegistry::Instance()->FindModel("ABLA");
      G4AblaInterface *theAblaInterface = dynamic_cast<G4AblaInterface*>(interaction);
      if(!theAblaInterface)
        theAblaInterface = new G4AblaInterface;
      // Couple INCL++ to ABLA
      G4cout << "Coupling INCLXX to ABLA" << G4endl;
      theINCLInterface->SetDeExcitation(theAblaInterface);
    }
  }
}

References G4HadronicInteractionRegistry::FindAllModels(), G4HadronicInteractionRegistry::FindModel(), G4cout, G4endl, getINCLXXVersionName(), GetInstance(), G4HadronicInteractionRegistry::Instance(), and G4INCLXXInterface::SetDeExcitation().

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

Field Documentation

◆ accurateProjectile

G4bool G4INCLXXInterfaceStore::accurateProjectile

private

Definition at line 176 of file G4INCLXXInterfaceStore.hh.

Referenced by GetAccurateProjectile(), and SetAccurateProjectile().

◆ cascadeMinEnergyPerNucleon

G4double G4INCLXXInterfaceStore::cascadeMinEnergyPerNucleon

private

Definition at line 178 of file G4INCLXXInterfaceStore.hh.

Referenced by GetCascadeMinEnergyPerNucleon(), and SetCascadeMinEnergyPerNucleon().

◆ conservationTolerance

G4double G4INCLXXInterfaceStore::conservationTolerance

private

Definition at line 179 of file G4INCLXXInterfaceStore.hh.

Referenced by GetConservationTolerance(), and SetConservationTolerance().

◆ maxWarnings

const G4int G4INCLXXInterfaceStore::maxWarnings

private

Maximum number of warnings.

Definition at line 191 of file G4INCLXXInterfaceStore.hh.

Referenced by EmitWarning().

◆ nWarnings

G4int G4INCLXXInterfaceStore::nWarnings

private

Static warning counter.

Definition at line 188 of file G4INCLXXInterfaceStore.hh.

Referenced by EmitWarning().

◆ theConfig

G4INCL::Config G4INCLXXInterfaceStore::theConfig

private

Definition at line 174 of file G4INCLXXInterfaceStore.hh.

Referenced by GetINCLConfig(), GetINCLModel(), SetINCLPhysics(), and SetMaxClusterMass().

◆ theINCLModel

G4INCL::INCL* G4INCLXXInterfaceStore::theINCLModel

private

Definition at line 183 of file G4INCLXXInterfaceStore.hh.

Referenced by DeleteModel(), GetINCLModel(), and ~G4INCLXXInterfaceStore().

◆ theINCLXXInterfaceMessenger

G4INCLXXInterfaceMessenger* G4INCLXXInterfaceStore::theINCLXXInterfaceMessenger

private

Definition at line 181 of file G4INCLXXInterfaceStore.hh.

Referenced by G4INCLXXInterfaceStore(), and ~G4INCLXXInterfaceStore().

◆ theInstance

G4ThreadLocal G4INCLXXInterfaceStore * G4INCLXXInterfaceStore::theInstance = NULL

staticprivate

Definition at line 172 of file G4INCLXXInterfaceStore.hh.

Referenced by DeleteInstance(), and GetInstance().

◆ theMaxProjMassINCL

const G4int G4INCLXXInterfaceStore::theMaxProjMassINCL

private

Definition at line 177 of file G4INCLXXInterfaceStore.hh.

Referenced by GetMaxProjMassINCL().

◆ theTally

G4INCLXXVInterfaceTally* G4INCLXXInterfaceStore::theTally

private

Definition at line 185 of file G4INCLXXInterfaceStore.hh.

Referenced by GetTally(), and SetTally().

◆ versionName

std::string G4INCLXXInterfaceStore::versionName

private

Definition at line 193 of file G4INCLXXInterfaceStore.hh.

Referenced by constructINCLXXVersionName(), and getINCLXXVersionName().

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

source/processes/hadronic/models/inclxx/interface/include/G4INCLXXInterfaceStore.hh
source/processes/hadronic/models/inclxx/interface/src/G4INCLXXInterfaceStore.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4INCLXXInterfaceStore()

◆ ~G4INCLXXInterfaceStore()

Member Function Documentation

◆ constructINCLXXVersionName()

◆ DeleteInstance()

◆ DeleteModel()

◆ EmitBigWarning()

◆ EmitWarning()

◆ GetAccurateProjectile()

◆ GetCascadeMinEnergyPerNucleon()

◆ GetConservationTolerance()

◆ GetINCLConfig()

◆ GetINCLModel()

◆ getINCLXXVersionName()

◆ GetInstance()

◆ GetMaxProjMassINCL()

◆ GetTally()

◆ SetAccurateProjectile()

◆ SetCascadeMinEnergyPerNucleon()

◆ SetConservationTolerance()

◆ SetINCLPhysics()

◆ SetMaxClusterMass()

◆ SetTally()

◆ UseAblaDeExcitation()

Field Documentation

◆ accurateProjectile

◆ cascadeMinEnergyPerNucleon

◆ conservationTolerance

◆ maxWarnings

◆ nWarnings

◆ theConfig

◆ theINCLModel

◆ theINCLXXInterfaceMessenger

◆ theInstance

◆ theMaxProjMassINCL

◆ theTally

◆ versionName