include/Geant4/G4QSSParameters.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 // G4QSSParameters
0027 //
0028 // Hold parameters for QSS Integrator driver -- used to create
0029 // all QSStepper objects (directly or via IntegrationDriver).
0030 // Checks consistency of values proposed.
0031 //
0032 // This design means that objects of only *one* order of QSS driver
0033 // can be created (QSS2 or QSS3 must be used globally).
0034 //
0035 // Author: John Apostolakis (CERN), 19.08.2025
0036 // --------------------------------------------------------------------
0037 #ifndef G4QSSParameters_HH
0038 #define G4QSSParameters_HH
0039
0040 #include "G4Types.hh"
0041
0042 /**
0043  * @brief G4QSSParameters hold parameters for the QSS Integrator driver.
0044  * It is used to create all QSStepper objects, directly or via the
0045  * Integration Driver. Checks for consistency of the proposed values.
0046  */
0047
0048 class G4QSSParameters
0049 {
0050   public:
0051
0052     static G4QSSParameters* Instance();
0053
0054     /**
0055      * Default Destructor.
0056      */
0057     ~G4QSSParameters() = default;
0058
0059     /**
0060      * Accessors.
0061      */
0062     inline G4int    GetQssOrder() { return fQssOrder; }
0063     inline G4double Get_dQRel() { return fdQRel; }
0064     inline G4double Get_dQMin() { return fdQMin; }
0065     inline G4int    GetMaxSubsteps() { return fMaxSubsteps; }
0066
0067     /**
0068      * Modifiers.
0069      */
0070     G4bool SetQssOrder( G4int value,  G4bool onlyWarn= false );
0071     G4bool Set_dQRel( G4double dQRel );
0072     G4bool Set_dQMin( G4double dQMin );
0073     G4bool SetMaxSubsteps( G4int maxSubsteps );
0074
0075   private:
0076
0077     /**
0078      * Private default Constructor.
0079      */
0080     G4QSSParameters() = default;
0081
0082   private:
0083
0084     G4int    fQssOrder = 2;
0085     G4double fdQMin    = 0.00001;
0086     G4double fdQRel    = 0.001;
0087     G4int    fMaxSubsteps = 5000;
0088 };
0089
0090 #endif