include/Geant4/G4EmExtraParameters.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:     G4EmExtraParameters
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 EM 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 G4EmExtraParameters_h
0049 #define G4EmExtraParameters_h 1
0050
0051 #include "globals.hh"
0052 #include "G4ios.hh"
0053 #include "G4ThreeVector.hh"
0054 #include <vector>
0055
0056 class G4EmExtraParametersMessenger;
0057 class G4VEnergyLossProcess;
0058 class G4VEmProcess;
0059 class G4ParticleDefinition;
0060 class G4VAtomDeexcitation;
0061
0062 class G4EmExtraParameters
0063 {
0064 public:
0065
0066   explicit G4EmExtraParameters();
0067
0068   ~G4EmExtraParameters();
0069
0070   void Initialise();
0071
0072   G4bool GetDirectionalSplitting();
0073   void SetDirectionalSplitting(G4bool v);
0074
0075   G4bool QuantumEntanglement();
0076   void SetQuantumEntanglement(G4bool v);
0077
0078   void SetDirectionalSplittingRadius(G4double r);
0079   G4double GetDirectionalSplittingRadius();
0080
0081   void SetDirectionalSplittingTarget(const G4ThreeVector& v);
0082   G4ThreeVector GetDirectionalSplittingTarget() const;
0083
0084   void SetStepFunction(G4double v1, G4double v2);
0085   G4double GetStepFunctionP1() const;
0086   G4double GetStepFunctionP2() const;
0087
0088   void SetStepFunctionMuHad(G4double v1, G4double v2);
0089   G4double GetStepFunctionMuHadP1() const;
0090   G4double GetStepFunctionMuHadP2() const;
0091
0092   void SetStepFunctionLightIons(G4double v1, G4double v2);
0093   G4double GetStepFunctionLightIonsP1() const;
0094   G4double GetStepFunctionLightIonsP2() const;
0095
0096   void SetStepFunctionIons(G4double v1, G4double v2);
0097   G4double GetStepFunctionIonsP1() const;
0098   G4double GetStepFunctionIonsP2() const;
0099
0100   void FillStepFunction(const G4ParticleDefinition*, G4VEnergyLossProcess*) const;
0101
0102   // parameters per region or per process
0103   void AddPAIModel(const G4String& particle,
0104                    const G4String& region,
0105                    const G4String& type);
0106   const std::vector<G4String>& ParticlesPAI() const;
0107   const std::vector<G4String>& RegionsPAI() const;
0108   const std::vector<G4String>& TypesPAI() const;
0109
0110   void AddPhysics(const G4String& region, const G4String& type);
0111   const std::vector<G4String>& RegionsPhysics() const;
0112   const std::vector<G4String>& TypesPhysics() const;
0113
0114   void SetSubCutRegion(const G4String& region);
0115
0116   void SetProcessBiasingFactor(const G4String& procname,
0117                                G4double val, G4bool wflag);
0118
0119   void ActivateForcedInteraction(const G4String& procname,
0120                                  const G4String& region,
0121                                  G4double length,
0122                                  G4bool wflag);
0123
0124   void ActivateSecondaryBiasing(const G4String& name,
0125                 const G4String& region,
0126                 G4double factor,
0127                 G4double energyLimit);
0128
0129   // initialisation methods
0130   void DefineRegParamForLoss(G4VEnergyLossProcess*) const;
0131   void DefineRegParamForEM(G4VEmProcess*) const;
0132
0133   G4EmExtraParameters(G4EmExtraParameters &) = delete;
0134   G4EmExtraParameters & operator=
0135   (const G4EmExtraParameters &right) = delete;
0136
0137 private:
0138
0139   G4String CheckRegion(const G4String&) const;
0140
0141   void PrintWarning(G4ExceptionDescription& ed) const;
0142
0143   G4EmExtraParametersMessenger* theMessenger;
0144
0145   G4bool directionalSplitting;
0146   G4bool quantumEntanglement;
0147
0148   G4double dRoverRange;
0149   G4double finalRange;
0150   G4double dRoverRangeMuHad;
0151   G4double finalRangeMuHad;
0152   G4double dRoverRangeLIons;
0153   G4double finalRangeLIons;
0154   G4double dRoverRangeIons;
0155   G4double finalRangeIons;
0156
0157   G4double directionalSplittingRadius;
0158   G4ThreeVector directionalSplittingTarget;
0159
0160   std::vector<G4String>  m_particlesPAI;
0161   std::vector<G4String>  m_regnamesPAI;
0162   std::vector<G4String>  m_typesPAI;
0163
0164   std::vector<G4String>  m_regnamesPhys;
0165   std::vector<G4String>  m_typesPhys;
0166
0167   std::vector<G4String>  m_regnamesSubCut;
0168
0169   std::vector<G4String>  m_procBiasedXS;
0170   std::vector<G4double>  m_factBiasedXS;
0171   std::vector<G4bool>    m_weightBiasedXS;
0172
0173   std::vector<G4String>  m_procForced;
0174   std::vector<G4String>  m_regnamesForced;
0175   std::vector<G4double>  m_lengthForced;
0176   std::vector<G4bool>    m_weightForced;
0177
0178   std::vector<G4String>  m_procBiasedSec;
0179   std::vector<G4String>  m_regnamesBiasedSec;
0180   std::vector<G4double>  m_factBiasedSec;
0181   std::vector<G4double>  m_elimBiasedSec;
0182 };
0183
0184 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0185
0186 #endif