G4SchedulerMessenger Class Reference

#include <G4SchedulerMessenger.hh>

Inheritance diagram for G4SchedulerMessenger:

Collaboration diagram for G4SchedulerMessenger:

Public Member Functions
	G4SchedulerMessenger (G4Scheduler *runMgr)
	~G4SchedulerMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValues)
G4String	GetCurrentValue (G4UIcommand *command)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Attributes
G4Scheduler *	fScheduler
G4UIdirectory *	fITDirectory
G4UIcmdWithADoubleAndUnit *	fEndTime
G4UIcmdWithADoubleAndUnit *	fTimeTolerance
G4UIcmdWithAnInteger *	fVerboseCmd
G4UIcmdWithAnInteger *	fMaxStepNumber
G4UIcmdWithoutParameter *	fInitCmd
G4UIcmdWithoutParameter *	fProcessCmd
G4UIcmdWithAnInteger *	fMaxNULLTimeSteps
G4UIcmdWithoutParameter *	fWhyDoYouStop
G4UIcmdWithABool *	fUseDefaultTimeSteps

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (G4String s)
G4bool	StoB (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
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 66 of file G4SchedulerMessenger.hh.

Constructor & Destructor Documentation

G4SchedulerMessenger()

G4SchedulerMessenger::G4SchedulerMessenger

(

G4Scheduler *

runMgr

)

Definition at line 47 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(10);
  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.");
}

Here is the call graph for this function:

~G4SchedulerMessenger()

G4SchedulerMessenger::~G4SchedulerMessenger

(

)

Definition at line 122 of file G4SchedulerMessenger.cc.

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

Member Function Documentation

GetCurrentValue()

G4String G4SchedulerMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 179 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;
}

Here is the call graph for this function:

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 136 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));
  }
}

Here is the call graph for this function:

Member Data Documentation

fEndTime

G4UIcmdWithADoubleAndUnit* G4SchedulerMessenger::fEndTime

private

Definition at line 82 of file G4SchedulerMessenger.hh.

fInitCmd

G4UIcmdWithoutParameter* G4SchedulerMessenger::fInitCmd

private

Definition at line 86 of file G4SchedulerMessenger.hh.

fITDirectory

G4UIdirectory* G4SchedulerMessenger::fITDirectory

private

Definition at line 80 of file G4SchedulerMessenger.hh.

fMaxNULLTimeSteps

G4UIcmdWithAnInteger* G4SchedulerMessenger::fMaxNULLTimeSteps

private

Definition at line 88 of file G4SchedulerMessenger.hh.

fMaxStepNumber

G4UIcmdWithAnInteger* G4SchedulerMessenger::fMaxStepNumber

private

Definition at line 85 of file G4SchedulerMessenger.hh.

fProcessCmd

G4UIcmdWithoutParameter* G4SchedulerMessenger::fProcessCmd

private

Definition at line 87 of file G4SchedulerMessenger.hh.

fScheduler

G4Scheduler* G4SchedulerMessenger::fScheduler

private

Definition at line 77 of file G4SchedulerMessenger.hh.

fTimeTolerance

G4UIcmdWithADoubleAndUnit* G4SchedulerMessenger::fTimeTolerance

private

Definition at line 83 of file G4SchedulerMessenger.hh.

fUseDefaultTimeSteps

G4UIcmdWithABool* G4SchedulerMessenger::fUseDefaultTimeSteps

private

Definition at line 90 of file G4SchedulerMessenger.hh.

fVerboseCmd

G4UIcmdWithAnInteger* G4SchedulerMessenger::fVerboseCmd

private

Definition at line 84 of file G4SchedulerMessenger.hh.

fWhyDoYouStop

G4UIcmdWithoutParameter* G4SchedulerMessenger::fWhyDoYouStop

private

Definition at line 89 of file G4SchedulerMessenger.hh.

---

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

• G4SchedulerMessenger.hh
• G4SchedulerMessenger.cc