G4NistMessenger Class Reference

#include <G4NistMessenger.hh>

Inheritance diagram for G4NistMessenger:

Public Member Functions
	G4NistMessenger (G4NistManager *)
	~G4NistMessenger () override
void	SetNewValue (G4UIcommand *, G4String) override
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	CommandsShouldBeInMaster () const

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	LtoS (G4long l)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const G4String &s)
G4bool	StoB (const G4String &s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T>
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 71 of file G4NistMessenger.hh.

Constructor & Destructor Documentation

G4NistMessenger()

G4NistMessenger::G4NistMessenger ( G4NistManager * man )

explicit

Definition at line 53 of file G4NistMessenger.cc.

                                                   : manager(man)
{
  matDir = new G4UIdirectory("/material/");
  matDir->SetGuidance("Commands for materials");
 
  verCmd = new G4UIcmdWithAnInteger("/material/verbose", this);
  verCmd->SetGuidance("Set verbose level.");
  verCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  verCmd->SetToBeBroadcasted(false);
 
  nistDir = new G4UIdirectory("/material/nist/");
  nistDir->SetGuidance("Commands for the nist dataBase");
 
  prtElmCmd = new G4UIcmdWithAString("/material/nist/printElement", this);
  prtElmCmd->SetGuidance("print element(s) in dataBase.");
  prtElmCmd->SetGuidance("symbol = element.");
  prtElmCmd->SetGuidance("all    = all elements.");
  prtElmCmd->SetParameterName("symbol", true);
  prtElmCmd->SetDefaultValue("all");
  prtElmCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  prtElmCmd->SetToBeBroadcasted(false);
 
  przElmCmd = new G4UIcmdWithAnInteger("/material/nist/printElementZ", this);
  przElmCmd->SetGuidance("print element Z in dataBase.");
  przElmCmd->SetGuidance("0 = all elements.");
  przElmCmd->SetParameterName("Z", true);
  przElmCmd->SetDefaultValue(0);
  przElmCmd->SetRange("0<=Z && Z<108");
  przElmCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  przElmCmd->SetToBeBroadcasted(false);
 
  lisMatCmd = new G4UIcmdWithAString("/material/nist/listMaterials", this);
  lisMatCmd->SetGuidance("Materials in Geant4 dataBase.");
  lisMatCmd->SetGuidance("simple - simple NIST materials.");
  lisMatCmd->SetGuidance("compound - compound NIST materials.");
  lisMatCmd->SetGuidance("hep - HEP materials.");
  lisMatCmd->SetGuidance("bio - biomedical materials.");
  lisMatCmd->SetGuidance("all - list of all Geant4 materials.");
  lisMatCmd->SetParameterName("matlist", true);
  // lisMatCmd->SetCandidates("simple compound hep bio all");
  lisMatCmd->SetDefaultValue("all");
  lisMatCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  lisMatCmd->SetToBeBroadcasted(false);
 
  g4Dir = new G4UIdirectory("/material/g4/");
  g4Dir->SetGuidance("Commands for G4MaterialTable");
 
  g4ElmCmd = new G4UIcmdWithAString("/material/g4/printElement", this);
  g4ElmCmd->SetGuidance("print Element from G4ElementTable.");
  g4ElmCmd->SetGuidance("all - all elements.");
  g4ElmCmd->SetParameterName("elm", true);
  g4ElmCmd->SetDefaultValue("all");
 
  g4MatCmd = new G4UIcmdWithAString("/material/g4/printMaterial", this);
  g4MatCmd->SetGuidance("print Material from G4MaterialTable.");
  g4MatCmd->SetGuidance("all - all materials");
  g4MatCmd->SetParameterName("pmat", true);
  g4MatCmd->SetDefaultValue("all");
  g4MatCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  g4MatCmd->SetToBeBroadcasted(false);
 
  g4DensCmd = new G4UIcmdWithAString("/material/g4/printDensityEffParam", this);
  g4DensCmd->SetGuidance("print Material from G4DensityEffectData.");
  g4DensCmd->SetGuidance("all - all materials");
  g4DensCmd->SetParameterName("dmat", true);
  g4DensCmd->SetDefaultValue("all");
  g4DensCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
  g4DensCmd->SetToBeBroadcasted(false);
 
  densCmd = new G4UIcmdWithAString("/material/g4/enableDensityEffOnFly", this);
  densCmd->SetGuidance("enable accurate computation of density effect.");
  densCmd->SetGuidance("all - all materials.");
  densCmd->SetParameterName("dens", true);
  densCmd->SetDefaultValue("all");
  densCmd->AvailableForStates(G4State_PreInit);
  lisMatCmd->SetToBeBroadcasted(false);
 
  adensCmd = new G4UIcmdWithAString("/material/g4/disableDensityEffOnFly", this);
  adensCmd->SetGuidance("disable accurate computation of density effect.");
  adensCmd->SetGuidance("all - all materials.");
  adensCmd->SetParameterName("dens", true);
  adensCmd->SetDefaultValue("all");
  adensCmd->AvailableForStates(G4State_PreInit);
  adensCmd->SetToBeBroadcasted(false);
 
  fPosiCmd = new G4UIcommand("/material/g4/ortoPositroniumFraction", this);
  fPosiCmd->SetGuidance("defined orto-positronium fraction for positron annihilation AtRest.");
  fPosiCmd->SetGuidance("via material name, all - all materials.");
  fPosiCmd->AvailableForStates(G4State_PreInit);
  fPosiCmd->SetToBeBroadcasted(false);
 
  auto p1 = new G4UIparameter("matname",'s', false);
  fPosiCmd->SetParameter(p1);
 
  auto p2 = new G4UIparameter("fraction", 'd', false);
  p2->SetParameterRange("fraction>=0. && fraction <=1.");
  fPosiCmd->SetParameter(p2);
}

~G4NistMessenger()

G4NistMessenger::~G4NistMessenger ( )

override

Definition at line 154 of file G4NistMessenger.cc.

{
  delete verCmd;
  delete prtElmCmd;
  delete przElmCmd;
  delete lisMatCmd;
  delete nistDir;
 
  delete g4ElmCmd;
  delete g4MatCmd;
  delete g4DensCmd;
  delete densCmd;
  delete adensCmd;
  delete fPosiCmd;
  
  delete g4Dir;
  delete matDir;
}

Member Function Documentation

SetNewValue()

void G4NistMessenger::SetNewValue ( G4UIcommand * command, G4String newValue )

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 175 of file G4NistMessenger.cc.

{
  // G4cout << "G4NistMessenger::SetNewValue <" << newValue << ">" << G4endl;
  if (command == verCmd) {
    manager->SetVerbose(verCmd->GetNewIntValue(newValue));
  }
  else if (command == prtElmCmd) {
    manager->PrintElement(newValue);
  }
  else if (command == przElmCmd) {
    G4int Z = przElmCmd->GetNewIntValue(newValue);
    if (Z >= 0 && Z < 108) {
      manager->PrintElement(Z);
    }
  }
  else if (command == lisMatCmd) {
    manager->ListMaterials(newValue);
  }
  else if (command == g4ElmCmd) {
    manager->PrintG4Element(newValue);
  }
  else if (command == g4MatCmd) {
    manager->PrintG4Material(newValue);
  }
  else if (command == g4DensCmd) {
    G4IonisParamMat::GetDensityEffectData()->PrintData(newValue);
  }
  else if (command == densCmd) {
    manager->SetDensityEffectCalculatorFlag(newValue, true);
  }
  else if (command == adensCmd) {
    manager->SetDensityEffectCalculatorFlag(newValue, false);
  }
  else if (command == fPosiCmd) {
    G4String mnam{""};
    G4double f{0.0};
    std::istringstream ss(newValue);
    ss >> mnam >> f;
    // set fraction for all materials 
    if (mnam == "all" || mnam == "none") {
      if (mnam == "none" || f < 0.0) { f = 0.0; }
      auto mtable = G4Material::GetMaterialTable();
      for ( auto const & mat : *mtable ) {
    mat->GetIonisation()->SetOrtoPositroniumFraction(f);
      }
    } else {
      // set fraction for one material 
      auto mat = manager->FindOrBuildMaterial(mnam, true);
      if (nullptr != mat) { 
    mat->GetIonisation()->SetOrtoPositroniumFraction(f);
      }
    }
  }
}

---

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

• G4NistMessenger.hh
• G4NistMessenger.cc