include/Geant4/G4EmLowEParameters.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 // -------------------------------------------------------------------
0027 //
0028 // GEANT4 Class header file
0029 //
0030 // File name:     G4EmLowEParameters
0031 //
0032 // Author:        Vladimir Ivanchenko
0033 //
0034 // Creation date: 06.05.2019
0035 //
0036 // Class Description:
0037 //
0038 // An internal utility class, responsable for keeping parameters
0039 // for low-energy EM and DNA physics processes and models.
0040 //
0041 // It is initialized by the master thread but can be updated
0042 // at any moment via G4EmParameters interface. It is not assumed
0043 // to be used for a direct initialisation
0044 //
0045 // -------------------------------------------------------------------
0046 //
0047
0048 #ifndef G4EmLowEParameters_h
0049 #define G4EmLowEParameters_h 1
0050
0051 #include "globals.hh"
0052 #include "G4DNAModelSubType.hh"
0053 #include "G4EmFluoDirectory.hh"
0054 #include <vector>
0055
0056 class G4EmLowEParametersMessenger;
0057 class G4VAtomDeexcitation;
0058
0059 class G4EmLowEParameters
0060 {
0061 public:
0062
0063   explicit G4EmLowEParameters();
0064
0065   ~G4EmLowEParameters();
0066
0067   void Initialise();
0068
0069   // boolean flags
0070   void SetFluo(G4bool val);
0071   G4bool Fluo() const;
0072
0073   G4EmFluoDirectory FluoDirectory() const;
0074
0075   void SetFluoDirectory(G4EmFluoDirectory val);
0076   void SetBeardenFluoDir(G4bool val);
0077   void SetANSTOFluoDir(G4bool val);
0078   void SetXDB_EADLFluoDir(G4bool val);
0079
0080   void SetAuger(G4bool val);
0081   G4bool Auger() const;
0082
0083   void SetPixe(G4bool val);
0084   G4bool Pixe() const;
0085
0086   void SetDeexcitationIgnoreCut(G4bool val);
0087   G4bool DeexcitationIgnoreCut() const;
0088
0089   void SetDNAFast(G4bool val);
0090   G4bool DNAFast() const;
0091
0092   void SetDNAStationary(G4bool val);
0093   G4bool DNAStationary() const;
0094
0095   void SetDNAElectronMsc(G4bool val);
0096   G4bool DNAElectronMsc() const;
0097
0098   // integer parameters
0099   void SetDNAeSolvationSubType(G4DNAModelSubType val);
0100   G4DNAModelSubType DNAeSolvationSubType() const;
0101
0102   // string parameters
0103   void SetPIXECrossSectionModel(const G4String&);
0104   const G4String& PIXECrossSectionModel();
0105
0106   void SetPIXEElectronCrossSectionModel(const G4String&);
0107   const G4String& PIXEElectronCrossSectionModel();
0108
0109   void SetLivermoreDataDir(const G4String&);
0110   const G4String& LivermoreDataDir();
0111
0112   // parameters per region or per process
0113   void AddMicroElec(const G4String& region);
0114   const std::vector<G4String>& RegionsMicroElec() const;
0115
0116   void AddDNA(const G4String& region, const G4String& type);
0117   const std::vector<G4String>& RegionsDNA() const;
0118   const std::vector<G4String>& TypesDNA() const;
0119
0120   void SetDeexActiveRegion(const G4String& region, G4bool fdeex,
0121                G4bool fauger, G4bool fpixe);
0122
0123   // initialisation methods
0124   void DefineRegParamForDeex(G4VAtomDeexcitation*) const;
0125
0126   G4EmLowEParameters(G4EmLowEParameters &) = delete;
0127   G4EmLowEParameters & operator=
0128   (const G4EmLowEParameters &right) = delete;
0129
0130 private:
0131
0132   G4String CheckRegion(const G4String&) const;
0133
0134   void PrintWarning(G4ExceptionDescription& ed) const;
0135
0136   G4EmLowEParametersMessenger* theMessenger;
0137
0138   G4bool fluo;
0139   G4bool auger;
0140   G4bool pixe;
0141   G4bool deexIgnoreCut;
0142
0143   G4bool dnaFast;
0144   G4bool dnaStationary;
0145   G4bool dnaMsc;
0146
0147   G4DNAModelSubType dnaElectronSolvation;
0148
0149   G4EmFluoDirectory fFluoDirectory;
0150
0151   G4String namePIXE;
0152   G4String nameElectronPIXE;
0153   G4String livDataDir;
0154
0155   std::vector<G4String>  m_regnamesME;
0156
0157   std::vector<G4String>  m_regnamesDNA;
0158   std::vector<G4String>  m_typesDNA;
0159
0160   std::vector<G4String>  m_regnamesDeex;
0161   std::vector<G4bool>    m_fluo;
0162   std::vector<G4bool>    m_auger;
0163   std::vector<G4bool>    m_pixe;
0164 };
0165
0166 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0167
0168 #endif
0169