G4QSSMessenger Class Reference

#include <G4QSSMessenger.hh>

Inheritance diagram for G4QSSMessenger:

Public Types
enum	StepperSelection { None = 1 , G4QSS2 = 2 , G4QSS3 = 3 , NumMethods }

Public Member Functions
	G4QSSMessenger ()
	~G4QSSMessenger () override
void	SetNewValue (G4UIcommand *command, G4String newValues) override
G4int	GetQssOrder ()
G4double	Get_dQRel ()
G4double	Get_dQMin ()
G4int	GetMaxSubsteps ()
void	selectStepper (const std::string &)
StepperSelection	selectedStepper ()
G4bool	SetQssOrder (G4int order)
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 ()

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

Member Enumeration Documentation

StepperSelection

enum G4QSSMessenger::StepperSelection

Enumerator
None
G4QSS2
G4QSS3
NumMethods

Definition at line 75 of file G4QSSMessenger.hh.

    {
      None = 1,
      G4QSS2 = 2,
      G4QSS3 = 3,
      NumMethods,
    };

Constructor & Destructor Documentation

G4QSSMessenger()

G4QSSMessenger::G4QSSMessenger

(

)

Constructor and Destructor.

Definition at line 34 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);
 
  stepperSelectorCmd = new G4UIcmdWithAString("/QSS/selectStepper",this);
  stepperSelectorCmd->SetGuidance("Select stepper.");
  stepperSelectorCmd->SetParameterName("choice", false);
  stepperSelectorCmd->SetCandidates("TemplatedDoPri OldRK45 G4QSS2");
 
  maxSubstepsCmd = new G4UIcmdWithAnInteger("/QSS/maxSubsteps",this);
  maxSubstepsCmd->SetGuidance("Default is 5000");
  maxSubstepsCmd->SetDefaultValue(5000);
  maxSubstepsCmd->SetParameterName("maxSubstepsCmd", false);
 
}

Referenced by instance().

~G4QSSMessenger()

G4QSSMessenger::~G4QSSMessenger ( )

override

Definition at line 62 of file G4QSSMessenger.cc.

{
  delete qssCmdDir;
  delete dQMinCmd;
  delete dQRelCmd;
  delete stepperSelectorCmd;
  delete maxSubstepsCmd;
}

Member Function Documentation

Get_dQMin()

G4double G4QSSMessenger::Get_dQMin ( )

inline

Definition at line 72 of file G4QSSMessenger.hh.

{ return G4QSSParameters::Instance()->Get_dQMin(); }

Get_dQRel()

G4double G4QSSMessenger::Get_dQRel ( )

inline

Definition at line 71 of file G4QSSMessenger.hh.

{ return G4QSSParameters::Instance()->Get_dQRel(); }

GetMaxSubsteps()

G4int G4QSSMessenger::GetMaxSubsteps ( )

inline

Definition at line 73 of file G4QSSMessenger.hh.

{ return G4QSSParameters::Instance()->GetMaxSubsteps(); }   

Referenced by SetNewValue(), and G4QSStepper::Stepper().

GetQssOrder()

G4int G4QSSMessenger::GetQssOrder ( )

inline

Accessors.

Definition at line 70 of file G4QSSMessenger.hh.

{ return G4QSSParameters::Instance()->GetQssOrder(); }

Referenced by G4ChordFinder::G4ChordFinder().

instance()

G4QSSMessenger * G4QSSMessenger::instance ( )

static

Definition at line 71 of file G4QSSMessenger.cc.

{
  static G4QSSMessenger theSingleMessengerInstance;
  return &theSingleMessengerInstance;
}

Referenced by G4ChordFinder::G4ChordFinder(), G4QSStepper::G4QSStepper(), and G4QSStepper::Stepper().

selectedStepper()

G4QSSMessenger::StepperSelection G4QSSMessenger::selectedStepper

(

)

Definition at line 195 of file G4QSSMessenger.cc.

{
  return _selectedStepper;
}

selectStepper()

void G4QSSMessenger::selectStepper

(

const std::string &

newValue

)

Stepper selection, G4QSS2 or G4QSS3.

Definition at line 136 of file G4QSSMessenger.cc.

{
  const std::map<std::string, StepperSelection> stepperMapping =
    {
      {"G4QSS2", G4QSS2}, {"G4QSS3", G4QSS3}
    };
  _selectedStepper = stepperMapping.at(newValue);
 
  if( (StepperSelection::None <= _selectedStepper ) 
      && (_selectedStepper < StepperSelection::NumMethods ) )
  {
    G4cout << "G4QSSMessenger: Selecting stepper " << newValue 
        <<   " ( which is method # " << _selectedStepper << " ) " << G4endl;
 
    G4int new_order= 0;
    if( _selectedStepper == G4QSS2 )
    {
      new_order= 2;
    }
    else
    {
      if( _selectedStepper == G4QSS3 )
      {
        new_order= 3;
      }
    }
    SetQssOrder( new_order ); // Will check requested value
  }
  else
  {
    G4cerr << "G4QSSMessenger::selectStepper : Invalid type of stepper requested" 
           << " Cannot find the requested stepper type '" << newValue << G4endl;
  }
}

Referenced by SetNewValue().

SetNewValue()

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

overridevirtual

Applies command to the associated object.

Reimplemented from G4UImessenger.

Definition at line 100 of file G4QSSMessenger.cc.

{
  G4bool good_value= true;
 
  if ( command == dQMinCmd )
  {
    good_value= Set_dQMin( dQMinCmd->GetNewDoubleValue(newValue) );
  }
 
  if ( command == dQRelCmd )
  {
    good_value= Set_dQRel( dQRelCmd->GetNewDoubleValue(newValue) );
  }
 
  if (command == maxSubstepsCmd)
  {
    G4int oldMaxSubstp = GetMaxSubsteps();
    good_value= SetMaxSubsteps ( maxSubstepsCmd->GetNewIntValue(newValue) );
    if( good_value )
    {
      G4cout << "G4QSSMessenger: changed maxSubsteps = " << GetMaxSubsteps()
             << "  ( old value = " << oldMaxSubstp << " )." << G4endl;
    }
  }
 
  if( !good_value ) 
  {
    G4cerr << " G4QSSMessenger: Command FAILED - parameter was not accepted." << G4endl;
  }
 
  if(command == stepperSelectorCmd)
  {
    this->selectStepper(newValue);
  }
}

SetQssOrder()

G4bool G4QSSMessenger::SetQssOrder

(

G4int

order

)

Sets QSS order. To be suppressed in favour of the method it calls in G4QSSParameters.

Definition at line 171 of file G4QSSMessenger.cc.

{
  G4bool good_value= false;
  
  if( 2 <= value && value <= 3 )
  {
    if( value == 2)
    { 
       _selectedStepper = G4QSS2;
    }
    else
    {
       _selectedStepper = G4QSS3;
    }
    good_value= G4QSSParameters::Instance()->SetQssOrder( value );
  }
  else
  {
    G4cerr << "G4QSSMessenger::SetQssOrder : requested invalid *order* of QSS-stepper"
           << " Asked for " << value << " . Value must be either 2 or 3." << G4endl;
  }
  return good_value;  
}

Referenced by G4ChordFinder::G4ChordFinder(), G4QSStepper::G4QSStepper(), and selectStepper().

---

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

• G4QSSMessenger.hh
• G4QSSMessenger.cc