include/Geant4/G4QSSMessenger.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4QSSMessenger
0027 //
0028 // Messenger for QSS Integrator driver
0029
0030 // Author: Leandro Gomez Vidal (Univ. Buenos Aires), October 2021
0031 // --------------------------------------------------------------------
0032 #ifndef G4QSSMessenger_HH
0033 #define G4QSSMessenger_HH
0034
0035 #include "G4UIcmdWithABool.hh"
0036 #include "G4UIcmdWithADouble.hh"
0037 #include "G4UIcmdWithADoubleAndUnit.hh"
0038 #include "G4UIcmdWithAString.hh"
0039 #include "G4UIcmdWithAnInteger.hh"
0040 #include "G4UIcmdWithoutParameter.hh"
0041 #include "G4UIdirectory.hh"
0042 #include "G4UImessenger.hh"
0043
0044 #include "G4QSSParameters.hh"
0045
0046 class G4QSSMessenger : public G4UImessenger
0047 {
0048   public:
0049
0050     /**
0051      * Constructor and Destructor.
0052      */
0053     G4QSSMessenger();
0054     ~G4QSSMessenger() override;
0055
0056     /**
0057      * Applies command to the associated object.
0058      */
0059     void SetNewValue(G4UIcommand* command, G4String newValues) override;
0060
0061     /* Hacky - much easier to access G4QSSMessenger from G4QSSDriver than the other way around
0062      * Multithreading seems to cause weird stuff with Driver/Stepper instances, maybe making
0063      * some thread-local copies or something, outside of construction? */
0064
0065     static G4QSSMessenger* instance();
0066
0067     /**
0068      * Accessors.
0069      */
0070     inline G4int GetQssOrder() { return G4QSSParameters::Instance()->GetQssOrder(); }
0071     inline G4double Get_dQRel() { return G4QSSParameters::Instance()->Get_dQRel(); }
0072     inline G4double Get_dQMin() { return G4QSSParameters::Instance()->Get_dQMin(); }
0073     inline G4int GetMaxSubsteps() { return G4QSSParameters::Instance()->GetMaxSubsteps(); }
0074
0075     enum StepperSelection
0076     {
0077       None = 1,
0078       G4QSS2 = 2,
0079       G4QSS3 = 3,
0080       NumMethods,
0081     };
0082
0083     /**
0084      * Stepper selection, G4QSS2 or G4QSS3.
0085      */
0086     void selectStepper(const std::string&);
0087     StepperSelection selectedStepper();
0088
0089     /**
0090      * Sets QSS order. To be suppressed in favour of the method
0091      * it calls in G4QSSParameters.
0092      */
0093     G4bool SetQssOrder(G4int order);
0094
0095   private:
0096
0097     /**
0098      * Internal methods -- could be suppressed in future.
0099      */
0100     G4bool Set_dQMin( G4double dvalue );
0101     G4bool Set_dQRel( G4double value );
0102     G4bool SetMaxSubsteps( G4int number );
0103
0104   private:
0105
0106     StepperSelection _selectedStepper= StepperSelection::None;
0107
0108     G4UIdirectory*             qssCmdDir;
0109     G4UIcmdWithADoubleAndUnit* dQMinCmd;
0110     G4UIcmdWithADouble*        dQRelCmd;
0111     G4UIcmdWithAString*        stepperSelectorCmd;
0112     G4UIcmdWithAnInteger*      maxSubstepsCmd;
0113 };
0114
0115 #endif