#include <G4SchedulerMessenger.hh>

Inheritance diagram for G4SchedulerMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4SchedulerMessenger (G4Scheduler *runMgr)

G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4bool	operator== (const G4UImessenger &messenger) const

void	SetNewValue (G4UIcommand *command, G4String newValues)

	~G4SchedulerMessenger ()

Protected Member Functions
void	AddUIcommand (G4UIcommand *newCommand)

G4String	BtoS (G4bool b)

template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

G4String	DtoS (G4double a)

G4String	ItoS (G4int i)

G4bool	StoB (G4String s)

G4double	StoD (G4String s)

G4int	StoI (G4String s)

G4long	StoL (G4String s)

Protected Attributes
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 65 of file G4SchedulerMessenger.hh.

Constructor & Destructor Documentation

◆ G4SchedulerMessenger()

G4SchedulerMessenger::G4SchedulerMessenger ( G4Scheduler * runMgr )

Definition at line 46 of file G4SchedulerMessenger.cc.

                                                                :
    fScheduler(stepMgr)
{
  fITDirectory = new G4UIdirectory("/scheduler/");
  fITDirectory->SetGuidance("Control commands for the time scheduler "
      "(dna chemistry applications).");
 
  // Set end time
  fEndTime = new G4UIcmdWithADoubleAndUnit("/scheduler/endTime", this);
  fEndTime->SetGuidance("Set time at which the simulation must stop.");
  fEndTime->AvailableForStates(G4State_PreInit, G4State_Idle);
  fEndTime->SetUnitCategory("Time");
  fEndTime->SetDefaultUnit("picosecond");
  fEndTime->SetDefaultValue(1);
 
  // Set time tolerance
  fTimeTolerance = new G4UIcmdWithADoubleAndUnit("/scheduler/timeTolerance",
                                                 this);
  fTimeTolerance->SetGuidance("This command aims at resolving issues related to"
      " floating points. If two time events are separated by less than the "
      "selected tolerance, they are assumed to belong to the same time step.");
  fTimeTolerance->AvailableForStates(G4State_PreInit, G4State_Idle);
  fTimeTolerance->SetUnitCategory("Time");
  fTimeTolerance->SetDefaultUnit("picosecond");
  fTimeTolerance->SetDefaultValue(1);
 
  // Initialize
  fInitCmd = new G4UIcmdWithoutParameter("/scheduler/initialize", this);
  fInitCmd->SetGuidance("Initialize G4Scheduler. This is done "
      "for standalone application only (no physics).");
  fInitCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
 
  // Set Max Null time Step
  fMaxNULLTimeSteps = new G4UIcmdWithAnInteger("/scheduler/maxNullTimeSteps",
                                               this);
  fMaxNULLTimeSteps->SetGuidance("Set maximum allowed zero time steps. After this "
      "threshold, the simulation is stopped.");
  fMaxNULLTimeSteps->SetParameterName("numberOfNullTimeSteps", true);
  fMaxNULLTimeSteps->SetDefaultValue(10000);
  fMaxNULLTimeSteps->SetRange("numberOfNullTimeSteps >=0 ");
 
  fMaxStepNumber = new G4UIcmdWithAnInteger("/scheduler/maxStepNumber", this);
  fMaxStepNumber->SetGuidance("Set the maximum number of time steps. After this "
      "threshold, the simulation is stopped.");
  fMaxStepNumber->SetParameterName("maximumNumberOfSteps", true);
  fMaxStepNumber->SetDefaultValue(-1);
 
  // Beam On
  fProcessCmd = new G4UIcmdWithoutParameter("/scheduler/process", this);
  fProcessCmd->SetGuidance("Process stacked tracks in G4Scheduler. This is done "
      "for standalone application only (no physics).");
  fProcessCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
 
  // Verbose
  fVerboseCmd = new G4UIcmdWithAnInteger("/scheduler/verbose", this);
  fVerboseCmd->SetGuidance("Set the Verbose level of G4Scheduler.");
  fVerboseCmd->SetGuidance(" 0 : Silent (default)");
  fVerboseCmd->SetGuidance(" 1 : Display reactions");
  fVerboseCmd->SetGuidance(" 2 ");
  fVerboseCmd->SetParameterName("level", true);
  fVerboseCmd->SetDefaultValue(1);
  //  fVerboseCmd->SetRange("level >=0 && level <=4");
 
  fWhyDoYouStop = new G4UIcmdWithoutParameter("/scheduler/whyDoYouStop",this);
  fWhyDoYouStop->SetGuidance("Will print information on why the scheduler is "
      "stopping the process");
 
  fUseDefaultTimeSteps = new G4UIcmdWithABool("/scheduler/useDefaultTimeSteps",
                                              this);
  fUseDefaultTimeSteps->SetGuidance("Let the G4 processes decided for the next "
      "time step interval. This command would be interesting if no reaction has "
      "been set and if one will want to track down Brownian objects. "
      "NB: This command gets in conflicts with the declaration of time steps.");
}

References G4UIcommand::AvailableForStates(), fEndTime, fInitCmd, fITDirectory, fMaxNULLTimeSteps, fMaxStepNumber, fProcessCmd, fTimeTolerance, fUseDefaultTimeSteps, fVerboseCmd, fWhyDoYouStop, G4State_Idle, G4State_PreInit, G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcommand::SetRange(), and G4UIcmdWithADoubleAndUnit::SetUnitCategory().

◆ ~G4SchedulerMessenger()

G4SchedulerMessenger::~G4SchedulerMessenger ( )

Definition at line 121 of file G4SchedulerMessenger.cc.

{
  delete fTimeTolerance;
  delete fITDirectory;
  delete fInitCmd;
  delete fEndTime;
  delete fMaxNULLTimeSteps;
  delete fMaxStepNumber;
  delete fProcessCmd;
  delete fVerboseCmd;
  delete fWhyDoYouStop;
  delete fUseDefaultTimeSteps;
}

References fEndTime, fInitCmd, fITDirectory, fMaxNULLTimeSteps, fMaxStepNumber, fProcessCmd, fTimeTolerance, fUseDefaultTimeSteps, fVerboseCmd, and fWhyDoYouStop.

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protectedinherited

Definition at line 110 of file G4UImessenger.hh.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protectedinherited

Definition at line 156 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4SchedulerMessenger::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 178 of file G4SchedulerMessenger.cc.

{
  G4String cv;
 
  if (command == fVerboseCmd)
  {
    cv = fVerboseCmd->ConvertToString(fScheduler->GetVerbose());
  }
  else if (command == fEndTime)
  {
    cv = fEndTime->ConvertToString(fScheduler->GetEndTime());
  }
  else if (command == fTimeTolerance)
  {
    cv = fTimeTolerance->ConvertToString(fScheduler->GetTimeTolerance());
  }
  else if (command == fInitCmd)
  {
    cv = fInitCmd->ConvertToString(fScheduler->IsInitialized());
  }
  else if (command == fMaxNULLTimeSteps)
  {
    cv = fMaxNULLTimeSteps->ConvertToString(
        fScheduler->GetMaxZeroTimeAllowed());
  }
  else if (command == fMaxStepNumber)
  {
    cv = fMaxStepNumber->ConvertToString(fScheduler->GetMaxNbSteps());
  }
  else if (command == fUseDefaultTimeSteps)
  {
    cv = fUseDefaultTimeSteps->ConvertToString(fScheduler->AreDefaultTimeStepsUsed());
  }
 
  return cv;
}

References G4Scheduler::AreDefaultTimeStepsUsed(), G4UIcommand::ConvertToString(), fEndTime, fInitCmd, fMaxNULLTimeSteps, fMaxStepNumber, fScheduler, fTimeTolerance, fUseDefaultTimeSteps, fVerboseCmd, G4Scheduler::GetEndTime(), G4Scheduler::GetMaxNbSteps(), G4Scheduler::GetMaxZeroTimeAllowed(), G4Scheduler::GetTimeTolerance(), G4Scheduler::GetVerbose(), and G4Scheduler::IsInitialized().

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger & messenger ) const

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger & messenger ) const

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetNewValue()

void G4SchedulerMessenger::SetNewValue	(	G4UIcommand *	command,
		G4String	newValues
	)

virtual

Reimplemented from G4UImessenger.

Definition at line 135 of file G4SchedulerMessenger.cc.

{
  if (command == fProcessCmd)
  {
    fScheduler->Process();
  }
  else if (command == fEndTime)
  {
    fScheduler->SetEndTime(fEndTime->GetNewDoubleValue(newValue));
  }
  else if (command == fTimeTolerance)
  {
    fScheduler->SetTimeTolerance(
        fTimeTolerance->GetNewDoubleValue(newValue));
  }
  else if (command == fVerboseCmd)
  {
    fScheduler->SetVerbose(fVerboseCmd->GetNewIntValue(newValue));
  }
  else if (command == fInitCmd)
  {
    fScheduler->Initialize();
  }
  else if (command == fMaxNULLTimeSteps)
  {
    fScheduler->SetMaxZeroTimeAllowed(
        fMaxNULLTimeSteps->GetNewIntValue(newValue));
  }
  else if (command == fMaxStepNumber)
  {
    fScheduler->SetMaxNbSteps(fMaxStepNumber->GetNewIntValue(newValue));
  }
  else if (command == fWhyDoYouStop)
  {
    fScheduler->WhyDoYouStop();
  }
  else if (command == fUseDefaultTimeSteps)
  {
    fScheduler->UseDefaultTimeSteps(fUseDefaultTimeSteps->GetNewBoolValue(newValue));
  }
}

References fEndTime, fInitCmd, fMaxNULLTimeSteps, fMaxStepNumber, fProcessCmd, fScheduler, fTimeTolerance, fUseDefaultTimeSteps, fVerboseCmd, fWhyDoYouStop, G4UIcmdWithABool::GetNewBoolValue(), G4UIcmdWithADoubleAndUnit::GetNewDoubleValue(), G4UIcmdWithAnInteger::GetNewIntValue(), G4Scheduler::Initialize(), G4Scheduler::Process(), G4Scheduler::SetEndTime(), G4Scheduler::SetMaxNbSteps(), G4Scheduler::SetMaxZeroTimeAllowed(), G4Scheduler::SetTimeTolerance(), G4Scheduler::SetVerbose(), G4Scheduler::UseDefaultTimeSteps(), and G4Scheduler::WhyDoYouStop().

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ fEndTime

G4UIcmdWithADoubleAndUnit* G4SchedulerMessenger::fEndTime

private

Definition at line 81 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fInitCmd

G4UIcmdWithoutParameter* G4SchedulerMessenger::fInitCmd

private

Definition at line 85 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fITDirectory

G4UIdirectory* G4SchedulerMessenger::fITDirectory

private

Definition at line 79 of file G4SchedulerMessenger.hh.

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

◆ fMaxNULLTimeSteps

G4UIcmdWithAnInteger* G4SchedulerMessenger::fMaxNULLTimeSteps

private

Definition at line 87 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fMaxStepNumber

G4UIcmdWithAnInteger* G4SchedulerMessenger::fMaxStepNumber

private

Definition at line 84 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fProcessCmd

G4UIcmdWithoutParameter* G4SchedulerMessenger::fProcessCmd

private

Definition at line 86 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fScheduler

G4Scheduler* G4SchedulerMessenger::fScheduler

private

Definition at line 76 of file G4SchedulerMessenger.hh.

Referenced by GetCurrentValue(), and SetNewValue().

◆ fTimeTolerance

G4UIcmdWithADoubleAndUnit* G4SchedulerMessenger::fTimeTolerance

private

Definition at line 82 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fUseDefaultTimeSteps

G4UIcmdWithABool* G4SchedulerMessenger::fUseDefaultTimeSteps

private

Definition at line 89 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fVerboseCmd

G4UIcmdWithAnInteger* G4SchedulerMessenger::fVerboseCmd

private

Definition at line 83 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), GetCurrentValue(), SetNewValue(), and ~G4SchedulerMessenger().

◆ fWhyDoYouStop

G4UIcmdWithoutParameter* G4SchedulerMessenger::fWhyDoYouStop

private

Definition at line 88 of file G4SchedulerMessenger.hh.

Referenced by G4SchedulerMessenger(), SetNewValue(), and ~G4SchedulerMessenger().

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

source/processes/electromagnetic/dna/management/include/G4SchedulerMessenger.hh
source/processes/electromagnetic/dna/management/src/G4SchedulerMessenger.cc

Private Attributes
G4UIcmdWithADoubleAndUnit *	fEndTime

G4UIcmdWithoutParameter *	fInitCmd

G4UIdirectory *	fITDirectory

G4UIcmdWithAnInteger *	fMaxNULLTimeSteps

G4UIcmdWithAnInteger *	fMaxStepNumber

G4UIcmdWithoutParameter *	fProcessCmd

G4Scheduler *	fScheduler

G4UIcmdWithADoubleAndUnit *	fTimeTolerance

G4UIcmdWithABool *	fUseDefaultTimeSteps

G4UIcmdWithAnInteger *	fVerboseCmd

G4UIcmdWithoutParameter *	fWhyDoYouStop

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4SchedulerMessenger()

◆ ~G4SchedulerMessenger()

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator==()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ fEndTime

◆ fInitCmd

◆ fITDirectory

◆ fMaxNULLTimeSteps

◆ fMaxStepNumber

◆ fProcessCmd

◆ fScheduler

◆ fTimeTolerance

◆ fUseDefaultTimeSteps

◆ fVerboseCmd

◆ fWhyDoYouStop