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 "G4ChemTimeStepModel.hh"
0055 #include <vector>
0056
0057 class G4EmLowEParametersMessenger;
0058 class G4VAtomDeexcitation;
0059
0060 class G4EmLowEParameters
0061 {
0062 public:
0063
0064   explicit G4EmLowEParameters();
0065
0066   ~G4EmLowEParameters();
0067
0068   void Initialise();
0069
0070   // boolean flags
0071   void SetFluo(G4bool val);
0072   G4bool Fluo() const;
0073
0074   G4EmFluoDirectory FluoDirectory() const;
0075
0076   void SetFluoDirectory(G4EmFluoDirectory val);
0077   void SetBeardenFluoDir(G4bool val);
0078   void SetANSTOFluoDir(G4bool val);
0079   void SetXDB_EADLFluoDir(G4bool val);
0080
0081   void SetAuger(G4bool val);
0082   G4bool Auger() const;
0083
0084   void SetPixe(G4bool val);
0085   G4bool Pixe() const;
0086
0087   void SetDeexcitationIgnoreCut(G4bool val);
0088   G4bool DeexcitationIgnoreCut() const;
0089
0090   void SetDNAFast(G4bool val);
0091   G4bool DNAFast() const;
0092
0093   void SetDNAStationary(G4bool val);
0094   G4bool DNAStationary() const;
0095
0096   void SetChemTimeStepModel(G4ChemTimeStepModel val);
0097   G4ChemTimeStepModel GetChemTimeStepModel() const;
0098
0099   void SetDNAElectronMsc(G4bool val);
0100   G4bool DNAElectronMsc() const;
0101
0102   // integer parameters
0103   void SetDNAeSolvationSubType(G4DNAModelSubType val);
0104   G4DNAModelSubType DNAeSolvationSubType() const;
0105
0106   // string parameters
0107   void SetPIXECrossSectionModel(const G4String&);
0108   const G4String& PIXECrossSectionModel();
0109
0110   void SetPIXEElectronCrossSectionModel(const G4String&);
0111   const G4String& PIXEElectronCrossSectionModel();
0112
0113   void SetLivermoreDataDir(const G4String&);
0114   const G4String& LivermoreDataDir();
0115
0116   // parameters per region or per process
0117   void AddMicroElec(const G4String& region);
0118   const std::vector<G4String>& RegionsMicroElec() const;
0119
0120   void AddDNA(const G4String& region, const G4String& type);
0121   const std::vector<G4String>& RegionsDNA() const;
0122   const std::vector<G4String>& TypesDNA() const;
0123
0124   void SetDeexActiveRegion(const G4String& region, G4bool fdeex,
0125                G4bool fauger, G4bool fpixe);
0126
0127   // initialisation methods
0128   void DefineRegParamForDeex(G4VAtomDeexcitation*) const;
0129
0130   G4EmLowEParameters(G4EmLowEParameters &) = delete;
0131   G4EmLowEParameters & operator=
0132   (const G4EmLowEParameters &right) = delete;
0133
0134 private:
0135
0136   G4String CheckRegion(const G4String&) const;
0137
0138   void PrintWarning(G4ExceptionDescription& ed) const;
0139
0140   G4EmLowEParametersMessenger* theMessenger;
0141
0142   G4bool fluo;
0143   G4bool auger;
0144   G4bool pixe;
0145   G4bool deexIgnoreCut;
0146
0147   G4bool dnaFast;
0148   G4bool dnaStationary;
0149   G4bool dnaMsc;
0150
0151   G4DNAModelSubType dnaElectronSolvation;
0152   G4ChemTimeStepModel fTimeStepModel;
0153
0154   G4EmFluoDirectory fFluoDirectory;
0155
0156   G4String namePIXE;
0157   G4String nameElectronPIXE;
0158   G4String livDataDir;
0159
0160   std::vector<G4String>  m_regnamesME;
0161
0162   std::vector<G4String>  m_regnamesDNA;
0163   std::vector<G4String>  m_typesDNA;
0164
0165   std::vector<G4String>  m_regnamesDeex;
0166   std::vector<G4bool>    m_fluo;
0167   std::vector<G4bool>    m_auger;
0168   std::vector<G4bool>    m_pixe;
0169 };
0170
0171 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0172
0173 #endif
0174