G4INCLXXInterfaceStore Class Reference

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

#include <G4INCLXXInterfaceStore.hh>

Public Member Functions
G4INCL::INCL *	GetINCLModel ()
	Get the cached INCL model engine.
void	constructINCLXXVersionName ()
const std::string &	getINCLXXVersionName ()
void	SetAccurateProjectile (const G4bool b)
	Setter for accurateProjectile.
void	SetMaxClusterMass (const G4int aMass)
	Setter for the maximum cluster mass.
void	SetCascadeMinEnergyPerNucleon (const G4double anEnergy)
	Setter for cascadeMinEnergyPerNucleon.
void	SetConservationTolerance (const G4double aTolerance)
	Setter for conservationTolerance.
G4bool	GetAccurateProjectile () const
	Getter for accurateProjectile.
G4double	GetCascadeMinEnergyPerNucleon () const
	Getter for cascadeMinEnergyPerNucleon.
G4INCL::Config &	GetINCLConfig ()
	Getter for theConfig.
G4int	GetMaxProjMassINCL () const
	Getter for theMaxProjMassINCL.
G4double	GetConservationTolerance () const
	Getter for conservationTolerance.
void	EmitWarning (const G4String &message)
	Emit a warning to G4cout.
void	EmitBigWarning (const G4String &message) const
	Emit a BIG warning to G4cout.
G4INCLXXVInterfaceTally *	GetTally () const
	Getter for the interface tally.
void	SetTally (G4INCLXXVInterfaceTally *const aTally)
	Setter for the interface tally.
void	SetINCLPhysics (const G4String &option)
	Set the INCL physics.
void	UseAblaDeExcitation ()
	Set ABLA V3 to be the de-excitation model to be used with INCL++.

Static Public Member Functions
static G4INCLXXInterfaceStore *	GetInstance ()
	Get the singleton instance.
static void	DeleteInstance ()
	Delete the singleton instance.

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.

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

DeleteInstance()

void G4INCLXXInterfaceStore::DeleteInstance ( )

static

Delete the singleton instance.

Definition at line 88 of file G4INCLXXInterfaceStore.cc.

                                            {
  delete theInstance;
  theInstance = NULL;
}

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

Referenced by 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;
    }
  }
}

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.

{ return 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.

{ return cascadeMinEnergyPerNucleon; }

Referenced by G4INCLXXInterface::ApplyYourself().

GetConservationTolerance()

G4double G4INCLXXInterfaceStore::GetConservationTolerance

(

)

const

Getter for conservationTolerance.

Definition at line 165 of file G4INCLXXInterfaceStore.cc.

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

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

Referenced by G4INCLXXInterface::ApplyYourself().

getINCLXXVersionName()

const std::string & G4INCLXXInterfaceStore::getINCLXXVersionName

(

)

Definition at line 108 of file G4INCLXXInterfaceStore.cc.

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

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

GetMaxProjMassINCL()

G4int G4INCLXXInterfaceStore::GetMaxProjMassINCL

(

)

const

Getter for theMaxProjMassINCL.

Definition at line 170 of file G4INCLXXInterfaceStore.cc.

{ return theMaxProjMassINCL; }

Referenced by G4INCLXXInterface::ApplyYourself().

GetTally()

G4INCLXXVInterfaceTally * G4INCLXXInterfaceStore::GetTally

(

)

const

Getter for the interface tally.

Definition at line 221 of file G4INCLXXInterfaceStore.cc.

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

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

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

SetConservationTolerance()

void G4INCLXXInterfaceStore::SetConservationTolerance

(

const G4double

aTolerance

)

Setter for conservationTolerance.

Definition at line 217 of file G4INCLXXInterfaceStore.cc.

                                                                               {
  conservationTolerance = aTolerance;
}

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

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

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

SetTally()

void G4INCLXXInterfaceStore::SetTally

(

G4INCLXXVInterfaceTally *const

aTally

)

Setter for the interface tally.

Definition at line 223 of file G4INCLXXInterfaceStore.cc.

{ theTally = aTally; }

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

Referenced by G4INCLXXInterfaceMessenger::SetNewValue().

---

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

• G4INCLXXInterfaceStore.hh
• G4INCLXXInterfaceStore.cc