Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/electromagnetic/utils/include/G4EmSaturation.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 //
 27 #ifndef G4EmSaturation_h
 28 #define G4EmSaturation_h 1
 29 
 30 // -------------------------------------------------------------
 31 //
 32 // GEANT4 Class header file
 33 //
 34 //
 35 // File name:     G4EmSaturation
 36 //
 37 // Author:        Vladimir Ivanchenko
 38 //
 39 // Creation date: 18.02.2008
 40 //
 41 // Modifications:
 42 //
 43 //
 44 // Class Description:
 45 //   Compution on saturation effect, which reduce visible energy 
 46 //   deposition at the step. Default implementation takes into 
 47 //   account Birks effect. Birks coefficients for some materials
 48 //   from G4 database on materials are provided
 49 //
 50 //   This class assumed to be G4ThreadLocal, because it is using 
 51 //   cache value for material 
 52 // 
 53 // -------------------------------------------------------------
 54 
 55 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 56 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 57 
 58 #include "globals.hh"
 59 #include "G4Step.hh"
 60 #include "G4ParticleDefinition.hh"
 61 #include <vector>
 62 
 63 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
 64 
 65 class G4NistManager;
 66 class G4MaterialCutsCouple;
 67 class G4Material;
 68 
 69 class G4EmSaturation
 70 {
 71 public: 
 72 
 73   explicit G4EmSaturation(G4int verb);
 74   virtual ~G4EmSaturation();
 75 
 76   // this method may be overwritten in the derived class
 77   // which implements alternative algorithm of saturation
 78   virtual G4double VisibleEnergyDeposition(const G4ParticleDefinition*, 
 79              const G4MaterialCutsCouple*,
 80              G4double length, 
 81              G4double edepTotal,
 82              G4double edepNIEL = 0.0) const;
 83 
 84   // activate default model  
 85   void InitialiseG4Saturation();
 86 
 87   // find and Birks coefficient 
 88   G4double FindG4BirksCoefficient(const G4Material*);
 89 
 90   // dump coeffitients used in run time
 91   void DumpBirksCoefficients();
 92 
 93   // dump G4 list
 94   void DumpG4BirksCoefficients();
 95 
 96   // this method should not be overwritten
 97   inline G4double VisibleEnergyDepositionAtAStep(const G4Step*) const; 
 98 
 99   inline void SetVerbose(G4int);
100 
101   // hide assignment operator
102   G4EmSaturation & operator=(const G4EmSaturation &right) = delete;
103   G4EmSaturation(const G4EmSaturation&) = delete;
104 
105 private:
106 
107   void InitialiseBirksCoefficient(const G4Material*);
108 
109   void InitialiseG4materials();
110 
111   const G4ParticleDefinition* electron;
112   const G4ParticleDefinition* proton;
113   G4NistManager*              nist;
114 
115   G4int    verbose;             
116   G4int    nG4Birks;
117   G4int    nWarnings;
118 
119   static size_t nMaterials;
120 
121   // list of materials used in run time
122   static std::vector<G4double> massFactors;
123   static std::vector<G4double> effCharges;
124 
125   // list of G4 materials 
126   static std::vector<G4double>  g4MatData;
127   static std::vector<G4String>  g4MatNames;
128 };
129 
130 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
131 
132 inline void G4EmSaturation::SetVerbose(G4int val)
133 {
134   verbose = val;
135 }
136 
137 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
138 
139 inline G4double G4EmSaturation::VisibleEnergyDepositionAtAStep(
140                 const G4Step* step) const
141 {
142   return VisibleEnergyDeposition(step->GetTrack()->GetParticleDefinition(),
143                                  step->GetTrack()->GetMaterialCutsCouple(),
144          step->GetStepLength(),
145                                  step->GetTotalEnergyDeposit(),
146                                  step->GetNonIonizingEnergyDeposit());
147 }
148 
149 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
150 
151 #endif
152 
153