G4PhysListRegistry Class Reference

#include <G4PhysListRegistry.hh>

Collaboration diagram for G4PhysListRegistry:

Public Member Functions
	~G4PhysListRegistry ()
void	AddFactory (G4String name, G4VBasePhysListStamper *)
void	AddPhysicsExtension (G4String name, G4String procname)
G4VModularPhysicsList *	GetModularPhysicsList (const G4String &name)
G4VModularPhysicsList *	GetModularPhysicsListFromEnv ()
G4bool	IsReferencePhysList (G4String nam) const
const std::vector< G4String > &	AvailablePhysLists () const
const std::vector< G4String > &	AvailablePhysicsExtensions () const
const std::vector< G4String > &	AvailablePhysListsEM () const
void	PrintAvailablePhysLists () const
G4bool	DeconstructPhysListName (const G4String &name, G4String &plBase, std::vector< G4String > &physExt, std::vector< G4int > &replace, G4int verbose=0) const
void	SetVerbose (G4int val)
G4int	GetVerbose () const
void	SetUnknownFatal (G4int val)
G4int	GetUnknownFatal () const
void	SetUserDefaultPhysList (const G4String &name="")
G4String	GetUserDefaultPhysList () const
G4String	GetSystemDefaultPhysList () const

Static Public Member Functions
static G4PhysListRegistry *	Instance ()

Private Member Functions
	G4PhysListRegistry ()

Private Attributes
std::map< G4String, G4VBasePhysListStamper * >	factories
std::map< G4String, G4String >	physicsExtensions
G4int	verbose
G4int	unknownFatal
G4String	userDefault
	throw an exception if unsatisfiable? More...
G4String	systemDefault
	use this if $PHYSLIST isn't set More...
std::vector< G4String >	availBasePhysLists
std::vector< G4String >	availExtensions

Static Private Attributes
static G4ThreadLocal G4PhysListRegistry *	theInstance = 0

Detailed Description

Definition at line 57 of file G4PhysListRegistry.hh.

Constructor & Destructor Documentation

~G4PhysListRegistry()

G4PhysListRegistry::~G4PhysListRegistry

(

)

Definition at line 84 of file G4PhysListRegistry.cc.

{
}

G4PhysListRegistry()

G4PhysListRegistry::G4PhysListRegistry ( )

private

Definition at line 76 of file G4PhysListRegistry.cc.

  : verbose(1)
  , unknownFatal(0)
  , systemDefault("FTFP_BERT")
{
  SetUserDefaultPhysList();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

AddFactory()

void G4PhysListRegistry::AddFactory	(	G4String	name,
		G4VBasePhysListStamper *	factory
	)

Definition at line 94 of file G4PhysListRegistry.cc.

{
  factories[name] = factory;
}

Here is the caller graph for this function:

AddPhysicsExtension()

void G4PhysListRegistry::AddPhysicsExtension	(	G4String	name,
		G4String	procname
	)

Definition at line 99 of file G4PhysListRegistry.cc.

{
  // a mapping from short extension names to actual physics process constructors
  physicsExtensions[name] = procname;
}

Here is the caller graph for this function:

AvailablePhysicsExtensions()

const std::vector< G4String > & G4PhysListRegistry::AvailablePhysicsExtensions

(

)

const

Definition at line 347 of file G4PhysListRegistry.cc.

{
  availExtensions.clear();
  std::map<G4String,G4String>::const_iterator itr;
  for ( itr = physicsExtensions.begin(); itr != physicsExtensions.end(); ++itr ) {
    availExtensions.push_back(itr->first);
  }

  return availExtensions;
}

Here is the caller graph for this function:

AvailablePhysLists()

const std::vector< G4String > & G4PhysListRegistry::AvailablePhysLists

(

)

const

Definition at line 336 of file G4PhysListRegistry.cc.

{
  availBasePhysLists.clear();
  std::map<G4String,G4VBasePhysListStamper*>::const_iterator itr;
  for ( itr = factories.begin(); itr != factories.end(); ++itr ) {
    availBasePhysLists.push_back(itr->first);
  }

  return availBasePhysLists;
}

Here is the caller graph for this function:

AvailablePhysListsEM()

const std::vector< G4String > & G4PhysListRegistry::AvailablePhysListsEM

(

)

const

Definition at line 358 of file G4PhysListRegistry.cc.

{
  // in principle this method could weed out all the extensions that aren't
  // EM replacements ... but for now just use it as a synonym for 
  // AvailablePhysicsExtensions()
  return AvailablePhysicsExtensions();
}

Here is the call graph for this function:

Here is the caller graph for this function:

DeconstructPhysListName()

G4bool G4PhysListRegistry::DeconstructPhysListName	(	const G4String &	name,
		G4String &	plBase,
		std::vector< G4String > &	physExt,
		std::vector< G4int > &	replace,
		G4int	verbose = 0
	)		const

Definition at line 214 of file G4PhysListRegistry.cc.

{
  // Take apart a name given to us by the user
  // this name might be a base PhysList + unknown number of extensions
  // Extensions preceeded with a "_" should use 
  //    ReplacePhysics()
  // those proceeded with a "+" should use
  //    RegisterPhysics()
  // the former is in line with previous behaviour, while the second allows 
  // additional flexibility
  plBase = "";
  physExt.clear();
  replace.clear();
  bool allKnown = false;
  
  G4String workingName = name;

  const std::vector<G4String>& availBases = AvailablePhysLists();
  const std::vector<G4String>& availExtras = AvailablePhysicsExtensions();

  G4PhysicsConstructorRegistry* physConstRegistry = 
    G4PhysicsConstructorRegistry::Instance();

  // find the longest base list that is contained in the user supplied name
  // and starts at the beginning
  size_t nb = availBases.size();
  for (size_t ib=0;  ib<nb; ++ib) {
    const G4String& testBase = availBases[ib];
    size_t ipos = workingName.find(testBase);
    if ( ipos == 0 ) {
      if ( testBase.size() > plBase.size() )  {
        plBase = testBase;
        allKnown = true;
        if ( verb > 3 ) { G4cout << "  physlist current best guess: " << testBase << G4endl; }
      } else {
        if ( verb > 3 ) { G4cout << "  physlist match but shorter: " << testBase << G4endl; }
      }
    } else {
      if ( verb > 3 ) { G4cout << "  physlist reject: " << testBase << G4endl; }
    }
  }
  if ( verb > 2 ) { 
    G4cout << "  physlist " << name << ", base known " << allKnown 
           << " chosen plBase \"" << plBase << "\"" << G4endl; 
  }
  if ( ! allKnown ) {
    // didn't find any matching base physics list
    // no point of going on to the extensions
    return allKnown;
  }
  // remove base name for working name
  workingName.erase(0,plBase.size());

  // now start trying to match up extensions
  // each should be preceeded by at "_" (replace) or "+" (register)
  // but don't freak if it isn't, just assume "_"
  size_t ne = availExtras.size();
  while ( ! workingName.empty() ) {
    char c = workingName.data()[0];  // leading character
    if ( '_' == c || '+' == c ) workingName.erase(0,1);  // and remove it
    G4int    replaceExtra = ( c != '+' );
    G4String extraName = "";
    G4bool   extraKnown = false;
    for (size_t ie=0;  ie<ne; ++ie) {
      const G4String& testExtra = availExtras[ie];
      size_t ipos = workingName.find(testExtra);
      if ( ipos == 0 ) {
        if ( testExtra.size() > extraName.size() )  {
          extraName = testExtra;
          extraKnown = true;
#ifdef G4VERBOSE
          if ( verb > 3 ) { G4cout << "  physextra current best guess: " << testExtra << G4endl; }
        } else {
          if ( verb > 3 ) { G4cout << "  physextra match but shorter: " << testExtra << G4endl; }
#endif
        }
      } else {
#ifdef G4VERBOSE
        if ( verb > 3 ) { G4cout << "  physextra reject: " << testExtra << G4endl; }
#endif
      }
    }
#ifdef G4VERBOSE
    if ( verb > 2 ) { 
      G4cout << "  physextra " << name << " [" << workingName << "]"
             <<", extra known " << extraKnown 
             << " chosen extra \"" << extraName << "\"" 
             << " replace " << replaceExtra << G4endl; 
    }
#endif
    if ( extraKnown ) {
      // physics mapping name is known, but is it actually linked to physics?
      //const issue// G4String pcname = physicsExtensions[extraName]; 
      std::map<G4String,G4String>::const_iterator itr = 
        physicsExtensions.find(extraName);
      G4String pcname = "";
      if ( itr != physicsExtensions.end() ) pcname = itr->second;
      bool realknown = physConstRegistry->IsKnownPhysicsConstructor(pcname);
#ifdef G4VERBOSE
      if ( verb > 2 ) { 
        G4cout << "  extraName \"" << extraName << "\" maps to physics ctor \""
               << pcname << "\" which is itself realknown " << realknown
               << G4endl;
      }
#endif
      if ( ! realknown ) allKnown = false;
      physExt.push_back(extraName);
      replace.push_back(replaceExtra);
      // and remove it so we can look for the next bit
      workingName.erase(0,extraName.size());
    } else {
      allKnown = false;
    }
  } // workingName not empty

  return allKnown;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetModularPhysicsList()

G4VModularPhysicsList * G4PhysListRegistry::GetModularPhysicsList

(

const G4String &

name

)

Definition at line 106 of file G4PhysListRegistry.cc.

{
  // 
  //
  G4String plBase = "";
  std::vector<G4String> physExt;
  std::vector<G4int>    physReplace;
  G4bool allKnown = 
    DeconstructPhysListName(name,plBase,physExt,physReplace,verbose);

  size_t npc = physExt.size();
  if ( verbose > 0 ) {
    G4cout << "G4PhysListRegistry::GetModularPhysicsList <"
           << name << ">"
           << ", as \"" << plBase << "\" with extensions \"";
    for ( size_t ipc = 0; ipc < npc; ++ipc ) 
      G4cout << ((physReplace[ipc]>0)?"_":"+") << physExt[ipc];
    G4cout << "\"" << G4endl;
  }

  if ( ! allKnown ) {
    // couldn't match what the user wanted ... 
    G4cout << "### G4PhysListRegistry WARNING: " << name
           << " is not known" << G4endl << G4endl;
    if ( ! unknownFatal ) return 0;

    G4ExceptionDescription ED;
    ED << "The factory for the physicslist ["<< name << "] does not exist!"
       << G4endl;
    if ( plBase == "" ) {
      ED << "Could determine no sensible base physics list" << G4endl;
    } else {
      ED << "One or more of the extensions does not exist [ ";
      for ( size_t ipc = 0; ipc < physExt.size(); ++ipc ) {
        ED << physExt[ipc] << " ";
      }
      ED << "]" << G4endl;
    }
    G4Exception("G4PhysListRegistry::GetModularPhysicsList", 
                "PhysicsList001", FatalException, ED);
    return 0;
  }

  // if we want this method "const" then the next line becomes more complex
  // because there is no const version of [] (which adds an entry if the 
  // key doesn't exist)
  G4VModularPhysicsList* pl = factories[plBase]->Instantiate(verbose);
  G4PhysicsConstructorRegistry* pcRegistry = 
    G4PhysicsConstructorRegistry::Instance();
  G4int ver = pl->GetVerboseLevel();
  pl->SetVerboseLevel(0);
  for ( size_t ipc = 0; ipc < npc; ++ipc ) {
    // got back a list of short names, need to use the map to get the 
    // full physics constructor name
    G4String extName = physExt[ipc];
    G4String pcname = physicsExtensions[extName];
    // this doesn't have a verbose option ... it should
    // but G4PhysicsConstructorFactory doesn't support it
    G4VPhysicsConstructor* pc = pcRegistry->GetPhysicsConstructor(pcname);
    G4String reporreg = "";
    if ( physReplace[ipc] > 0 ) {
      pl->ReplacePhysics(pc);
      reporreg = "ReplacePhysics ";
    } else {
      pl->RegisterPhysics(pc);
      reporreg = "RegisterPhysics";
    }
    if ( verbose > 0 ) G4cout << "<<< " << reporreg << " with " << pcname 
                              << " \"" << extName << "\"" << G4endl;
  }
  pl->SetVerboseLevel(ver);
  G4cout << "<<< Reference Physics List " << name << " is built" << G4endl;
  G4cout << G4endl; // old factory has this

  return pl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetModularPhysicsListFromEnv()

G4VModularPhysicsList * G4PhysListRegistry::GetModularPhysicsListFromEnv

(

)

Definition at line 184 of file G4PhysListRegistry.cc.

{
  // 
  // instantiate PhysList by environment variable "PHYSLIST"
  // if not set use default
  G4String name = "";
  char* path = getenv("PHYSLIST");
  if (path) {
    name = G4String(path);
  } else {
    name = userDefault;
    G4cout << "### G4PhysListRegistry WARNING: "
       << " environment variable PHYSLIST is not defined"
       << G4endl
       << "    Default Physics Lists " << name 
       << " is instantiated" 
       << G4endl;
  }
  return GetModularPhysicsList(name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetSystemDefaultPhysList()

G4String G4PhysListRegistry::GetSystemDefaultPhysList ( ) const

inline

Definition at line 98 of file G4PhysListRegistry.hh.

{ return systemDefault; }

Here is the call graph for this function:

GetUnknownFatal()

G4int G4PhysListRegistry::GetUnknownFatal ( ) const

inline

Definition at line 91 of file G4PhysListRegistry.hh.

{ return unknownFatal; }

Here is the call graph for this function:

Here is the caller graph for this function:

GetUserDefaultPhysList()

G4String G4PhysListRegistry::GetUserDefaultPhysList ( ) const

inline

Definition at line 94 of file G4PhysListRegistry.hh.

{ return userDefault; }

GetVerbose()

G4int G4PhysListRegistry::GetVerbose ( ) const

inline

Definition at line 88 of file G4PhysListRegistry.hh.

{ return verbose; }

Here is the caller graph for this function:

Instance()

G4PhysListRegistry * G4PhysListRegistry::Instance ( void  )

static

Definition at line 52 of file G4PhysListRegistry.cc.

{
  if ( 0 == theInstance) {
    static G4ThreadLocal G4PhysListRegistry *manager_G4MT_TLS_ = 0; 
    if (!manager_G4MT_TLS_) manager_G4MT_TLS_ = new G4PhysListRegistry;
    G4PhysListRegistry &manager = *manager_G4MT_TLS_;
    theInstance = &manager;
  }

  // common EM overrides
  theInstance->AddPhysicsExtension("EMV","G4EmStandardPhysics_option1");
  theInstance->AddPhysicsExtension("EMX","G4EmStandardPhysics_option2");
  theInstance->AddPhysicsExtension("EMY","G4EmStandardPhysics_option3");
  theInstance->AddPhysicsExtension("EMZ","G4EmStandardPhysics_option4");
  theInstance->AddPhysicsExtension("LIV","G4EmLivermorePhysics");
  theInstance->AddPhysicsExtension("PEN","G4EmPenelopePhysics");
  // the GS EM extension originally required double underscores
  // support either one or two as __GS is confusing to users
  theInstance->AddPhysicsExtension("GS","G4EmStandardPhysicsGS");
  theInstance->AddPhysicsExtension("_GS","G4EmStandardPhysicsGS");

  return theInstance;
}

Here is the call graph for this function:

Here is the caller graph for this function:

IsReferencePhysList()

G4bool G4PhysListRegistry::IsReferencePhysList

(

G4String

nam

)

const

Definition at line 205 of file G4PhysListRegistry.cc.

{
  G4String plBase = "";
  std::vector<G4String> physExt;
  std::vector<G4int>    physReplace;
  G4bool allKnown = DeconstructPhysListName(name,plBase,physExt,physReplace,1);
  return allKnown;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PrintAvailablePhysLists()

void G4PhysListRegistry::PrintAvailablePhysLists

(

)

const

Definition at line 366 of file G4PhysListRegistry.cc.

{
  std::vector<G4String> avail = AvailablePhysLists();
  G4cout << "Base G4VModularPhysicsLists in G4PhysListRegistry are:"
         << G4endl;
  if ( avail.empty() ) G4cout << "... no registered lists" << G4endl;
  else {
    size_t n = avail.size();
    for (size_t i=0; i<n; ++i ) {
      G4cout << " [" << std::setw(3) << i << "] "
             << " \"" << avail[i] << "\"" << G4endl;
    }
  }

  G4PhysicsConstructorRegistry* physConstRegistry = G4PhysicsConstructorRegistry::Instance();

  std::map<G4String,G4String>::const_iterator itr;
  G4cout << "Replacement mappings in G4PhysListRegistry are:"
         << G4endl;
  for ( itr = physicsExtensions.begin(); itr != physicsExtensions.end(); ++itr ) {
    bool known = physConstRegistry->IsKnownPhysicsConstructor(itr->second);

    G4cout << "    " << std::setw(10) << itr->first << " => "
           << std::setw(30) << itr->second << " "
           << ( (known)?"":"[unregistered physics]")
           << G4endl;
  }
  G4cout << "Use these mapping to extend physics list; append with _EXT or +EXT" << G4endl
         << "   to use ReplacePhysics() (\"_\") or RegisterPhysics() (\"+\")."
         << G4endl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetUnknownFatal()

void G4PhysListRegistry::SetUnknownFatal ( G4int  val )

inline

Definition at line 90 of file G4PhysListRegistry.hh.

{ unknownFatal = val; }

Here is the caller graph for this function:

SetUserDefaultPhysList()

void G4PhysListRegistry::SetUserDefaultPhysList

(

const G4String &

name = ""

)

Definition at line 88 of file G4PhysListRegistry.cc.

{
  if ( name == "" ) userDefault = systemDefault;
  else              userDefault = name;
}

Here is the caller graph for this function:

SetVerbose()

void G4PhysListRegistry::SetVerbose ( G4int  val )

inline

Definition at line 87 of file G4PhysListRegistry.hh.

{ verbose = val; }

Here is the caller graph for this function:

Member Data Documentation

availBasePhysLists

std::vector<G4String> G4PhysListRegistry::availBasePhysLists

mutableprivate

use this if user hasn't set userDefault or attempts to set the userDefault=""

Definition at line 120 of file G4PhysListRegistry.hh.

availExtensions

std::vector<G4String> G4PhysListRegistry::availExtensions

mutableprivate

Definition at line 121 of file G4PhysListRegistry.hh.

factories

std::map<G4String, G4VBasePhysListStamper*> G4PhysListRegistry::factories

private

Definition at line 106 of file G4PhysListRegistry.hh.

physicsExtensions

std::map<G4String, G4String> G4PhysListRegistry::physicsExtensions

private

Definition at line 107 of file G4PhysListRegistry.hh.

systemDefault

G4String G4PhysListRegistry::systemDefault

private

use this if $PHYSLIST isn't set

Definition at line 112 of file G4PhysListRegistry.hh.

theInstance

G4ThreadLocal G4PhysListRegistry * G4PhysListRegistry::theInstance = 0

staticprivate

Definition at line 104 of file G4PhysListRegistry.hh.

unknownFatal

G4int G4PhysListRegistry::unknownFatal

private

Definition at line 110 of file G4PhysListRegistry.hh.

userDefault

G4String G4PhysListRegistry::userDefault

private

throw an exception if unsatisfiable?

Definition at line 111 of file G4PhysListRegistry.hh.

verbose

G4int G4PhysListRegistry::verbose

private

Definition at line 109 of file G4PhysListRegistry.hh.

---

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

• G4PhysListRegistry.hh
• G4PhysListRegistry.cc