G4QSSMessenger Class Reference

#include <G4QSSMessenger.hh>

Inheritance diagram for G4QSSMessenger:

Public Types
enum	StepperSelection { None = 0 , TemplatedDoPri , OldRK45 , G4QSS2 }

Public Member Functions
	G4QSSMessenger ()
	~G4QSSMessenger () override
void	SetNewValue (G4UIcommand *command, G4String newValues) override
void	selectStepper (const std::string &)
StepperSelection	selectedStepper ()
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

Static Public Member Functions
static G4QSSMessenger *	instance ()

Public Attributes
G4double	dQMin = 0
G4double	dQRel = 0
G4double	trialProposedStepModifier = 1.0

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 44 of file G4QSSMessenger.hh.

Member Enumeration Documentation

StepperSelection

enum G4QSSMessenger::StepperSelection

Enumerator
None
TemplatedDoPri
OldRK45
G4QSS2

Definition at line 59 of file G4QSSMessenger.hh.

     {
       None = 0,
       TemplatedDoPri,
       OldRK45,
       G4QSS2
     };

Constructor & Destructor Documentation

G4QSSMessenger()

G4QSSMessenger::G4QSSMessenger

(

)

Definition at line 33 of file G4QSSMessenger.cc.

{
  commandsShouldBeInMaster = true;
 
  qssCmdDir = new G4UIdirectory("/QSS/", false);
  qssCmdDir->SetGuidance("G4QSStepper configuration.");
 
  dQMinCmd = new G4UIcmdWithADoubleAndUnit("/QSS/dQMin",this);
  dQMinCmd->SetDefaultUnit("mm");
  dQMinCmd->SetParameterName("dQMinCmd",false);
  dQMinCmd->SetUnitCategory("Length");
 
  dQRelCmd = new G4UIcmdWithADouble("/QSS/dQRel",this);
  dQRelCmd->SetGuidance("Default is 1e-5");
  dQRelCmd->SetParameterName("dQRelCmd",false);
 
  trialProposedStepModifierCmd = new G4UIcmdWithADouble("/QSS/trialProposedStepModifier",this);
  trialProposedStepModifierCmd->SetGuidance("Default is 1");
  trialProposedStepModifierCmd->SetParameterName("trialProposedStepModifier", false);
 
  stepperSelectorCmd = new G4UIcmdWithAString("/QSS/selectStepper",this);
  stepperSelectorCmd->SetGuidance("Select stepper.");
  stepperSelectorCmd->SetParameterName("choice", false);
  stepperSelectorCmd->SetCandidates("TemplatedDoPri OldRK45 G4QSS2");
 
}

Referenced by instance().

~G4QSSMessenger()

G4QSSMessenger::~G4QSSMessenger ( )

override

Definition at line 60 of file G4QSSMessenger.cc.

{
  delete qssCmdDir;
  delete dQMinCmd;
  delete dQRelCmd;
  delete stepperSelectorCmd;
  delete trialProposedStepModifierCmd;
  //qssStats.print();
}

Member Function Documentation

instance()

G4QSSMessenger * G4QSSMessenger::instance ( )

static

Definition at line 70 of file G4QSSMessenger.cc.

{
  static G4QSSMessenger theSingleMessengerInstance;
  return &theSingleMessengerInstance;
}

selectedStepper()

G4QSSMessenger::StepperSelection G4QSSMessenger::selectedStepper

(

)

Definition at line 104 of file G4QSSMessenger.cc.

{
  return _selectedStepper;
}

selectStepper()

void G4QSSMessenger::selectStepper

(

const std::string &

newValue

)

Definition at line 96 of file G4QSSMessenger.cc.

{
  const std::map<std::string, StepperSelection> stepperMapping =
    {{"TemplatedDoPri", TemplatedDoPri}, {"OldRK45", OldRK45}, {"G4QSS2", G4QSS2}};
  _selectedStepper = stepperMapping.at(newValue);
  G4cout << "G4QSSMessenger: Selecting stepper " << newValue << G4endl;
}

Referenced by SetNewValue().

SetNewValue()

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

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 76 of file G4QSSMessenger.cc.

{
  if ( command == dQMinCmd ) {
    dQMin = dQMinCmd->GetNewDoubleValue(newValue);
  }
 
  if ( command == dQRelCmd ) {
    dQRel = dQRelCmd->GetNewDoubleValue(newValue);
  }
 
  if ( command == trialProposedStepModifierCmd ) {
    trialProposedStepModifier = trialProposedStepModifierCmd->GetNewDoubleValue(newValue);
  }
 
  if(command == stepperSelectorCmd){
    this->selectStepper(newValue);
  }
 
}

Member Data Documentation

dQMin

G4double G4QSSMessenger::dQMin = 0

Definition at line 71 of file G4QSSMessenger.hh.

Referenced by SetNewValue().

dQRel

G4double G4QSSMessenger::dQRel = 0

Definition at line 72 of file G4QSSMessenger.hh.

Referenced by SetNewValue().

trialProposedStepModifier

G4double G4QSSMessenger::trialProposedStepModifier = 1.0

Definition at line 73 of file G4QSSMessenger.hh.

Referenced by SetNewValue().

---

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

• G4QSSMessenger.hh
• G4QSSMessenger.cc