Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/electromagnetic/xrays/include/G4Cerenkov.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 ]

Diff markup

Differences between /processes/electromagnetic/xrays/include/G4Cerenkov.hh (Version 11.3.0) and /processes/electromagnetic/xrays/include/G4Cerenkov.hh (Version 9.6)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
                                                   >>  26 //
                                                   >>  27 // $Id$
                                                   >>  28 //
                                                   >>  29 // 
 26 //////////////////////////////////////////////     30 ////////////////////////////////////////////////////////////////////////
 27 // Cerenkov Radiation Class Definition         <<  31 // Cerenkov Radiation Class Definition 
 28 //////////////////////////////////////////////     32 ////////////////////////////////////////////////////////////////////////
 29 //                                                 33 //
 30 // File:        G4Cerenkov.hh                  <<  34 // File:        G4Cerenkov.hh  
 31 // Description: Discrete Process - Generation      35 // Description: Discrete Process - Generation of Cerenkov Photons
 32 // Version:     2.0                                36 // Version:     2.0
 33 // Created:     1996-02-21                         37 // Created:     1996-02-21
 34 // Author:      Juliet Armstrong                   38 // Author:      Juliet Armstrong
 35 // Updated:     2007-09-30 change inheritance      39 // Updated:     2007-09-30 change inheritance to G4VDiscreteProcess
 36 //              2005-07-28 add G4ProcessType t     40 //              2005-07-28 add G4ProcessType to constructor
 37 //              1999-10-29 add method and clas     41 //              1999-10-29 add method and class descriptors
 38 //              1997-04-09 by Peter Gumplinger     42 //              1997-04-09 by Peter Gumplinger
 39 //              > G4MaterialPropertiesTable; n     43 //              > G4MaterialPropertiesTable; new physics/tracking scheme
                                                   >>  44 // mail:        gum@triumf.ca
 40 //                                                 45 //
 41 //////////////////////////////////////////////     46 ////////////////////////////////////////////////////////////////////////
 42                                                    47 
 43 #ifndef G4Cerenkov_h                               48 #ifndef G4Cerenkov_h
 44 #define G4Cerenkov_h 1                             49 #define G4Cerenkov_h 1
 45                                                    50 
                                                   >>  51 /////////////
                                                   >>  52 // Includes
                                                   >>  53 /////////////
                                                   >>  54 
                                                   >>  55 #include <CLHEP/Units/SystemOfUnits.h>
                                                   >>  56 
 46 #include "globals.hh"                              57 #include "globals.hh"
                                                   >>  58 #include "templates.hh"
                                                   >>  59 #include "Randomize.hh"
                                                   >>  60 #include "G4ThreeVector.hh"
                                                   >>  61 #include "G4ParticleMomentum.hh"
                                                   >>  62 #include "G4Step.hh"
                                                   >>  63 #include "G4VProcess.hh"
                                                   >>  64 #include "G4OpticalPhoton.hh"
 47 #include "G4DynamicParticle.hh"                    65 #include "G4DynamicParticle.hh"
 48 #include "G4ForceCondition.hh"                 <<  66 #include "G4Material.hh" 
 49 #include "G4GPILSelection.hh"                  <<  67 #include "G4PhysicsTable.hh"
 50 #include "G4MaterialPropertyVector.hh"             68 #include "G4MaterialPropertyVector.hh"
 51 #include "G4VProcess.hh"                       <<  69 #include "G4MaterialPropertiesTable.hh"
                                                   >>  70 #include "G4PhysicsOrderedFreeVector.hh"
 52                                                    71 
 53 class G4Material;                              <<  72 // Class Description:
 54 class G4ParticleDefinition;                    <<  73 // Discrete Process -- Generation of Cerenkov Photons.
 55 class G4PhysicsTable;                          <<  74 // Class inherits publicly from G4VDiscreteProcess.
 56 class G4Step;                                  <<  75 // Class Description - End:
 57 class G4Track;                                 <<  76 
 58 class G4VParticleChange;                       <<  77 /////////////////////
                                                   >>  78 // Class Definition
                                                   >>  79 /////////////////////
 59                                                    80 
 60 class G4Cerenkov : public G4VProcess               81 class G4Cerenkov : public G4VProcess
 61 {                                                  82 {
 62  public:                                       << 
 63   explicit G4Cerenkov(const G4String& processN << 
 64                       G4ProcessType type       << 
 65   ~G4Cerenkov();                               << 
 66                                                << 
 67   explicit G4Cerenkov(const G4Cerenkov& right) << 
 68                                                << 
 69   G4Cerenkov& operator=(const G4Cerenkov& righ << 
 70                                                << 
 71   G4bool IsApplicable(const G4ParticleDefiniti << 
 72   // Returns true -> 'is applicable', for all  << 
 73   // except short-lived particles.             << 
 74                                                << 
 75   void BuildPhysicsTable(const G4ParticleDefin << 
 76   // Build table at a right time               << 
 77                                                << 
 78   void PreparePhysicsTable(const G4ParticleDef << 
 79   void Initialise();                           << 
 80                                                << 
 81   G4double GetMeanFreePath(const G4Track& aTra << 
 82   // Returns the discrete step limit and sets  << 
 83   // condition for the DoIt to be invoked at e << 
 84                                                << 
 85   G4double PostStepGetPhysicalInteractionLengt << 
 86                                                << 
 87   // Returns the discrete step limit and sets  << 
 88   // condition for the DoIt to be invoked at e << 
 89                                                << 
 90   G4VParticleChange* PostStepDoIt(const G4Trac << 
 91                                   const G4Step << 
 92   // This is the method implementing the Ceren << 
 93                                                << 
 94   //  no operation in  AtRestDoIt and  AlongSt << 
 95   virtual G4double AlongStepGetPhysicalInterac << 
 96     const G4Track&, G4double, G4double, G4doub << 
 97   {                                            << 
 98     return -1.0;                               << 
 99   };                                           << 
100                                                << 
101   virtual G4double AtRestGetPhysicalInteractio << 
102     const G4Track&, G4ForceCondition*) overrid << 
103   {                                            << 
104     return -1.0;                               << 
105   };                                           << 
106                                                << 
107   //  no operation in  AtRestDoIt and  AlongSt << 
108   virtual G4VParticleChange* AtRestDoIt(const  << 
109   {                                            << 
110     return nullptr;                            << 
111   };                                           << 
112                                                << 
113   virtual G4VParticleChange* AlongStepDoIt(con << 
114                                            con << 
115   {                                            << 
116     return nullptr;                            << 
117   };                                           << 
118                                                << 
119   void SetTrackSecondariesFirst(const G4bool s << 
120   // If set, the primary particle tracking is  << 
121   // produced Cerenkov photons are tracked nex << 
122   // been tracked, the tracking of the primary << 
123                                                << 
124   G4bool GetTrackSecondariesFirst() const;     << 
125   // Returns the boolean flag for tracking sec << 
126                                                << 
127   void SetMaxBetaChangePerStep(const G4double  << 
128   // Set the maximum allowed change in beta =  << 
129                                                << 
130   G4double GetMaxBetaChangePerStep() const;    << 
131   // Returns the maximum allowed change in bet << 
132                                                << 
133   void SetMaxNumPhotonsPerStep(const G4int Num << 
134   // Set the maximum number of Cerenkov photon << 
135   // a tracking step. This is an average ONLY; << 
136   // around this average. If invoked, the maxi << 
137   // of the size set. If not called, the step  << 
138   // photons generated.                        << 
139                                                << 
140   G4int GetMaxNumPhotonsPerStep() const;       << 
141   // Returns the maximum number of Cerenkov ph << 
142   // generated during a tracking step.         << 
143                                                << 
144   void SetStackPhotons(const G4bool);          << 
145   // Call by the user to set the flag for stac << 
146                                                << 
147   G4bool GetStackPhotons() const;              << 
148   // Return the boolean for whether or not the << 
149                                                << 
150   G4int GetNumPhotons() const;                 << 
151   // Returns the current number of scint. phot << 
152                                                << 
153   G4PhysicsTable* GetPhysicsTable() const;     << 
154   // Returns the address of the physics table. << 
155                                                << 
156   void DumpPhysicsTable() const;               << 
157   // Prints the physics table.                 << 
158                                                << 
159   G4double GetAverageNumberOfPhotons(const G4d << 
160                                      const G4M << 
161                                      G4Materia << 
162                                                << 
163   void DumpInfo() const override {ProcessDescr << 
164   void ProcessDescription(std::ostream& out) c << 
165                                                << 
166   void SetVerboseLevel(G4int);                 << 
167   // sets verbosity                            << 
168                                                << 
169  protected:                                    << 
170   G4PhysicsTable* thePhysicsTable;             << 
171                                                << 
172  private:                                      << 
173   G4double fMaxBetaChange;                     << 
174                                                << 
175   G4int fMaxPhotons;                           << 
176   G4int fNumPhotons;                           << 
177                                                << 
178   G4bool fStackingFlag;                        << 
179   G4bool fTrackSecondariesFirst;               << 
180                                                    83 
181   G4int secID = -1;  // creator modelID        <<  84 public:
182                                                    85 
                                                   >>  86   ////////////////////////////////
                                                   >>  87   // Constructors and Destructor
                                                   >>  88   ////////////////////////////////
                                                   >>  89 
                                                   >>  90   G4Cerenkov(const G4String& processName = "Cerenkov", 
                                                   >>  91                             G4ProcessType type = fElectromagnetic);
                                                   >>  92   ~G4Cerenkov();
                                                   >>  93 
                                                   >>  94         G4Cerenkov(const G4Cerenkov &right);
                                                   >>  95 
                                                   >>  96 private:
                                                   >>  97 
                                                   >>  98         //////////////
                                                   >>  99         // Operators
                                                   >> 100         //////////////
                                                   >> 101 
                                                   >> 102         G4Cerenkov& operator=(const G4Cerenkov &right);
                                                   >> 103 
                                                   >> 104 public:
                                                   >> 105 
                                                   >> 106         ////////////
                                                   >> 107         // Methods
                                                   >> 108         ////////////
                                                   >> 109 
                                                   >> 110         G4bool IsApplicable(const G4ParticleDefinition& aParticleType);
                                                   >> 111         // Returns true -> 'is applicable', for all charged particles
                                                   >> 112         // except short-lived particles.
                                                   >> 113 
                                                   >> 114         G4double GetMeanFreePath(const G4Track& aTrack,
                                                   >> 115                                  G4double ,
                                                   >> 116                                  G4ForceCondition* );
                                                   >> 117         // Returns the discrete step limit and sets the 'StronglyForced'
                                                   >> 118         // condition for the DoIt to be invoked at every step.
                                                   >> 119 
                                                   >> 120         G4double PostStepGetPhysicalInteractionLength(const G4Track& aTrack,
                                                   >> 121                                                       G4double ,
                                                   >> 122                                                       G4ForceCondition* );
                                                   >> 123         // Returns the discrete step limit and sets the 'StronglyForced'
                                                   >> 124         // condition for the DoIt to be invoked at every step.
                                                   >> 125 
                                                   >> 126   G4VParticleChange* PostStepDoIt(const G4Track& aTrack, 
                                                   >> 127           const G4Step&  aStep);
                                                   >> 128         // This is the method implementing the Cerenkov process.
                                                   >> 129 
                                                   >> 130         //  no operation in  AtRestDoIt and  AlongStepDoIt
                                                   >> 131         virtual G4double AlongStepGetPhysicalInteractionLength(
                                                   >> 132                                const G4Track&,
                                                   >> 133                                G4double  ,
                                                   >> 134                                G4double  ,
                                                   >> 135                                G4double& ,
                                                   >> 136                                G4GPILSelection*
                                                   >> 137                               ) { return -1.0; };
                                                   >> 138 
                                                   >> 139         virtual G4double AtRestGetPhysicalInteractionLength(
                                                   >> 140                                const G4Track& ,
                                                   >> 141                                G4ForceCondition*
                                                   >> 142                               ) { return -1.0; };
                                                   >> 143 
                                                   >> 144         //  no operation in  AtRestDoIt and  AlongStepDoIt
                                                   >> 145         virtual G4VParticleChange* AtRestDoIt(
                                                   >> 146                                const G4Track& ,
                                                   >> 147                                const G4Step&
                                                   >> 148                               ) {return 0;};
                                                   >> 149 
                                                   >> 150         virtual G4VParticleChange* AlongStepDoIt(
                                                   >> 151                                const G4Track& ,
                                                   >> 152                                const G4Step&
                                                   >> 153                               ) {return 0;};
                                                   >> 154 
                                                   >> 155   void SetTrackSecondariesFirst(const G4bool state);
                                                   >> 156         // If set, the primary particle tracking is interrupted and any 
                                                   >> 157         // produced Cerenkov photons are tracked next. When all have 
                                                   >> 158         // been tracked, the tracking of the primary resumes. 
                                                   >> 159   
                                                   >> 160         void SetMaxBetaChangePerStep(const G4double d);
                                                   >> 161         // Set the maximum allowed change in beta = v/c in % (perCent)
                                                   >> 162         // per step.
                                                   >> 163 
                                                   >> 164   void SetMaxNumPhotonsPerStep(const G4int NumPhotons);
                                                   >> 165         // Set the maximum number of Cerenkov photons allowed to be 
                                                   >> 166         // generated during a tracking step. This is an average ONLY; 
                                                   >> 167         // the actual number will vary around this average. If invoked, 
                                                   >> 168         // the maximum photon stack will roughly be of the size set.
                                                   >> 169         // If not called, the step is not limited by the number of 
                                                   >> 170         // photons generated.
                                                   >> 171 
                                                   >> 172         G4PhysicsTable* GetPhysicsTable() const;
                                                   >> 173         // Returns the address of the physics table.
                                                   >> 174 
                                                   >> 175         void DumpPhysicsTable() const;
                                                   >> 176         // Prints the physics table.
                                                   >> 177 
                                                   >> 178 private:
                                                   >> 179 
                                                   >> 180         void BuildThePhysicsTable();
                                                   >> 181 
                                                   >> 182   /////////////////////
                                                   >> 183   // Helper Functions
                                                   >> 184   /////////////////////
                                                   >> 185 
                                                   >> 186   G4double GetAverageNumberOfPhotons(const G4double charge,
                                                   >> 187                                 const G4double beta,
                                                   >> 188             const G4Material *aMaterial,
                                                   >> 189         G4MaterialPropertyVector* Rindex) const;
                                                   >> 190 
                                                   >> 191         ///////////////////////
                                                   >> 192         // Class Data Members
                                                   >> 193         ///////////////////////
                                                   >> 194 
                                                   >> 195 protected:
                                                   >> 196 
                                                   >> 197         G4PhysicsTable* thePhysicsTable;
                                                   >> 198         //  A Physics Table can be either a cross-sections table or
                                                   >> 199         //  an energy table (or can be used for other specific
                                                   >> 200         //  purposes).
                                                   >> 201 
                                                   >> 202 private:
                                                   >> 203 
                                                   >> 204   G4bool fTrackSecondariesFirst;
                                                   >> 205         G4double fMaxBetaChange;
                                                   >> 206         G4int  fMaxPhotons;
183 };                                                207 };
184                                                   208 
185 inline G4bool G4Cerenkov::GetTrackSecondariesF << 209 ////////////////////
                                                   >> 210 // Inline methods
                                                   >> 211 ////////////////////
                                                   >> 212 
                                                   >> 213 inline 
                                                   >> 214 G4bool G4Cerenkov::IsApplicable(const G4ParticleDefinition& aParticleType)
186 {                                                 215 {
187   return fTrackSecondariesFirst;               << 216    if (aParticleType.GetParticleName() == "chargedgeantino") return false;
                                                   >> 217    if (aParticleType.IsShortLived()) return false;
                                                   >> 218 
                                                   >> 219    return (aParticleType.GetPDGCharge() != 0);
                                                   >> 220 }
                                                   >> 221 
                                                   >> 222 inline 
                                                   >> 223 void G4Cerenkov::SetTrackSecondariesFirst(const G4bool state) 
                                                   >> 224 { 
                                                   >> 225   fTrackSecondariesFirst = state;
188 }                                                 226 }
189                                                   227 
190 inline G4double G4Cerenkov::GetMaxBetaChangePe << 228 inline
                                                   >> 229 void G4Cerenkov::SetMaxBetaChangePerStep(const G4double value)
191 {                                                 230 {
192   return fMaxBetaChange;                       << 231         fMaxBetaChange = value*CLHEP::perCent;
193 }                                                 232 }
194                                                   233 
195 inline G4int G4Cerenkov::GetMaxNumPhotonsPerSt << 234 inline
                                                   >> 235 void G4Cerenkov::SetMaxNumPhotonsPerStep(const G4int NumPhotons) 
                                                   >> 236 { 
                                                   >> 237   fMaxPhotons = NumPhotons;
                                                   >> 238 }
196                                                   239 
197 inline G4bool G4Cerenkov::GetStackPhotons() co << 240 inline
                                                   >> 241 void G4Cerenkov::DumpPhysicsTable() const
                                                   >> 242 {
                                                   >> 243         G4int PhysicsTableSize = thePhysicsTable->entries();
                                                   >> 244         G4PhysicsOrderedFreeVector *v;
198                                                   245 
199 inline G4int G4Cerenkov::GetNumPhotons() const << 246         for (G4int i = 0 ; i < PhysicsTableSize ; i++ )
                                                   >> 247         {
                                                   >> 248           v = (G4PhysicsOrderedFreeVector*)(*thePhysicsTable)[i];
                                                   >> 249           v->DumpValues();
                                                   >> 250         }
                                                   >> 251 }
200                                                   252 
201 inline G4PhysicsTable* G4Cerenkov::GetPhysicsT << 253 inline
                                                   >> 254 G4PhysicsTable* G4Cerenkov::GetPhysicsTable() const
202 {                                                 255 {
203   return thePhysicsTable;                         256   return thePhysicsTable;
204 }                                                 257 }
205                                                   258 
206 #endif /* G4Cerenkov_h */                         259 #endif /* G4Cerenkov_h */
207                                                   260