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 11.0)


  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 //////////////////////////////////////////////     26 ////////////////////////////////////////////////////////////////////////
 27 // Cerenkov Radiation Class Definition             27 // Cerenkov Radiation Class Definition
 28 //////////////////////////////////////////////     28 ////////////////////////////////////////////////////////////////////////
 29 //                                                 29 //
 30 // File:        G4Cerenkov.hh                      30 // File:        G4Cerenkov.hh
 31 // Description: Discrete Process - Generation      31 // Description: Discrete Process - Generation of Cerenkov Photons
 32 // Version:     2.0                                32 // Version:     2.0
 33 // Created:     1996-02-21                         33 // Created:     1996-02-21
 34 // Author:      Juliet Armstrong                   34 // Author:      Juliet Armstrong
 35 // Updated:     2007-09-30 change inheritance      35 // Updated:     2007-09-30 change inheritance to G4VDiscreteProcess
 36 //              2005-07-28 add G4ProcessType t     36 //              2005-07-28 add G4ProcessType to constructor
 37 //              1999-10-29 add method and clas     37 //              1999-10-29 add method and class descriptors
 38 //              1997-04-09 by Peter Gumplinger     38 //              1997-04-09 by Peter Gumplinger
 39 //              > G4MaterialPropertiesTable; n     39 //              > G4MaterialPropertiesTable; new physics/tracking scheme
 40 //                                                 40 //
 41 //////////////////////////////////////////////     41 ////////////////////////////////////////////////////////////////////////
 42                                                    42 
 43 #ifndef G4Cerenkov_h                               43 #ifndef G4Cerenkov_h
 44 #define G4Cerenkov_h 1                             44 #define G4Cerenkov_h 1
 45                                                    45 
 46 #include "globals.hh"                              46 #include "globals.hh"
 47 #include "G4DynamicParticle.hh"                    47 #include "G4DynamicParticle.hh"
 48 #include "G4ForceCondition.hh"                     48 #include "G4ForceCondition.hh"
 49 #include "G4GPILSelection.hh"                      49 #include "G4GPILSelection.hh"
 50 #include "G4MaterialPropertyVector.hh"             50 #include "G4MaterialPropertyVector.hh"
 51 #include "G4VProcess.hh"                           51 #include "G4VProcess.hh"
 52                                                    52 
 53 class G4Material;                                  53 class G4Material;
 54 class G4ParticleDefinition;                        54 class G4ParticleDefinition;
 55 class G4PhysicsTable;                              55 class G4PhysicsTable;
 56 class G4Step;                                      56 class G4Step;
 57 class G4Track;                                     57 class G4Track;
 58 class G4VParticleChange;                           58 class G4VParticleChange;
 59                                                    59 
 60 class G4Cerenkov : public G4VProcess               60 class G4Cerenkov : public G4VProcess
 61 {                                                  61 {
 62  public:                                           62  public:
 63   explicit G4Cerenkov(const G4String& processN     63   explicit G4Cerenkov(const G4String& processName = "Cerenkov",
 64                       G4ProcessType type           64                       G4ProcessType type          = fElectromagnetic);
 65   ~G4Cerenkov();                                   65   ~G4Cerenkov();
 66                                                    66 
 67   explicit G4Cerenkov(const G4Cerenkov& right)     67   explicit G4Cerenkov(const G4Cerenkov& right);
 68                                                    68 
 69   G4Cerenkov& operator=(const G4Cerenkov& righ     69   G4Cerenkov& operator=(const G4Cerenkov& right) = delete;
 70                                                    70 
 71   G4bool IsApplicable(const G4ParticleDefiniti     71   G4bool IsApplicable(const G4ParticleDefinition& aParticleType) override;
 72   // Returns true -> 'is applicable', for all      72   // Returns true -> 'is applicable', for all charged particles
 73   // except short-lived particles.                 73   // except short-lived particles.
 74                                                    74 
 75   void BuildPhysicsTable(const G4ParticleDefin     75   void BuildPhysicsTable(const G4ParticleDefinition& aParticleType) override;
 76   // Build table at a right time                   76   // Build table at a right time
 77                                                    77 
 78   void PreparePhysicsTable(const G4ParticleDef     78   void PreparePhysicsTable(const G4ParticleDefinition& part) override;
 79   void Initialise();                               79   void Initialise();
 80                                                    80 
 81   G4double GetMeanFreePath(const G4Track& aTra     81   G4double GetMeanFreePath(const G4Track& aTrack, G4double, G4ForceCondition*);
 82   // Returns the discrete step limit and sets      82   // Returns the discrete step limit and sets the 'StronglyForced'
 83   // condition for the DoIt to be invoked at e     83   // condition for the DoIt to be invoked at every step.
 84                                                    84 
 85   G4double PostStepGetPhysicalInteractionLengt     85   G4double PostStepGetPhysicalInteractionLength(const G4Track& aTrack, G4double,
 86                                                    86                                                 G4ForceCondition*) override;
 87   // Returns the discrete step limit and sets      87   // Returns the discrete step limit and sets the 'StronglyForced'
 88   // condition for the DoIt to be invoked at e     88   // condition for the DoIt to be invoked at every step.
 89                                                    89 
 90   G4VParticleChange* PostStepDoIt(const G4Trac     90   G4VParticleChange* PostStepDoIt(const G4Track& aTrack,
 91                                   const G4Step     91                                   const G4Step& aStep) override;
 92   // This is the method implementing the Ceren     92   // This is the method implementing the Cerenkov process.
 93                                                    93 
 94   //  no operation in  AtRestDoIt and  AlongSt     94   //  no operation in  AtRestDoIt and  AlongStepDoIt
 95   virtual G4double AlongStepGetPhysicalInterac     95   virtual G4double AlongStepGetPhysicalInteractionLength(
 96     const G4Track&, G4double, G4double, G4doub     96     const G4Track&, G4double, G4double, G4double&, G4GPILSelection*) override
 97   {                                                97   {
 98     return -1.0;                                   98     return -1.0;
 99   };                                               99   };
100                                                   100 
101   virtual G4double AtRestGetPhysicalInteractio    101   virtual G4double AtRestGetPhysicalInteractionLength(
102     const G4Track&, G4ForceCondition*) overrid    102     const G4Track&, G4ForceCondition*) override
103   {                                               103   {
104     return -1.0;                                  104     return -1.0;
105   };                                              105   };
106                                                   106 
107   //  no operation in  AtRestDoIt and  AlongSt    107   //  no operation in  AtRestDoIt and  AlongStepDoIt
108   virtual G4VParticleChange* AtRestDoIt(const     108   virtual G4VParticleChange* AtRestDoIt(const G4Track&, const G4Step&) override
109   {                                               109   {
110     return nullptr;                               110     return nullptr;
111   };                                              111   };
112                                                   112 
113   virtual G4VParticleChange* AlongStepDoIt(con    113   virtual G4VParticleChange* AlongStepDoIt(const G4Track&,
114                                            con    114                                            const G4Step&) override
115   {                                               115   {
116     return nullptr;                               116     return nullptr;
117   };                                              117   };
118                                                   118 
119   void SetTrackSecondariesFirst(const G4bool s    119   void SetTrackSecondariesFirst(const G4bool state);
120   // If set, the primary particle tracking is     120   // If set, the primary particle tracking is interrupted and any
121   // produced Cerenkov photons are tracked nex    121   // produced Cerenkov photons are tracked next. When all have
122   // been tracked, the tracking of the primary    122   // been tracked, the tracking of the primary resumes.
123                                                   123 
124   G4bool GetTrackSecondariesFirst() const;        124   G4bool GetTrackSecondariesFirst() const;
125   // Returns the boolean flag for tracking sec    125   // Returns the boolean flag for tracking secondaries first.
126                                                   126 
127   void SetMaxBetaChangePerStep(const G4double     127   void SetMaxBetaChangePerStep(const G4double d);
128   // Set the maximum allowed change in beta =     128   // Set the maximum allowed change in beta = v/c in % (perCent) per step.
129                                                   129 
130   G4double GetMaxBetaChangePerStep() const;       130   G4double GetMaxBetaChangePerStep() const;
131   // Returns the maximum allowed change in bet    131   // Returns the maximum allowed change in beta = v/c in % (perCent)
132                                                   132 
133   void SetMaxNumPhotonsPerStep(const G4int Num    133   void SetMaxNumPhotonsPerStep(const G4int NumPhotons);
134   // Set the maximum number of Cerenkov photon    134   // Set the maximum number of Cerenkov photons allowed to be generated during
135   // a tracking step. This is an average ONLY;    135   // a tracking step. This is an average ONLY; the actual number will vary
136   // around this average. If invoked, the maxi    136   // around this average. If invoked, the maximum photon stack will roughly be
137   // of the size set. If not called, the step     137   // of the size set. If not called, the step is not limited by the number of
138   // photons generated.                           138   // photons generated.
139                                                   139 
140   G4int GetMaxNumPhotonsPerStep() const;          140   G4int GetMaxNumPhotonsPerStep() const;
141   // Returns the maximum number of Cerenkov ph    141   // Returns the maximum number of Cerenkov photons allowed to be
142   // generated during a tracking step.            142   // generated during a tracking step.
143                                                   143 
144   void SetStackPhotons(const G4bool);             144   void SetStackPhotons(const G4bool);
145   // Call by the user to set the flag for stac    145   // Call by the user to set the flag for stacking the scint. photons
146                                                   146 
147   G4bool GetStackPhotons() const;                 147   G4bool GetStackPhotons() const;
148   // Return the boolean for whether or not the    148   // Return the boolean for whether or not the scint. photons are stacked
149                                                   149 
150   G4int GetNumPhotons() const;                    150   G4int GetNumPhotons() const;
151   // Returns the current number of scint. phot    151   // Returns the current number of scint. photons (after PostStepDoIt)
152                                                   152 
153   G4PhysicsTable* GetPhysicsTable() const;        153   G4PhysicsTable* GetPhysicsTable() const;
154   // Returns the address of the physics table.    154   // Returns the address of the physics table.
155                                                   155 
156   void DumpPhysicsTable() const;                  156   void DumpPhysicsTable() const;
157   // Prints the physics table.                    157   // Prints the physics table.
158                                                   158 
159   G4double GetAverageNumberOfPhotons(const G4d    159   G4double GetAverageNumberOfPhotons(const G4double charge, const G4double beta,
160                                      const G4M    160                                      const G4Material* aMaterial,
161                                      G4Materia    161                                      G4MaterialPropertyVector* Rindex) const;
162                                                   162 
163   void DumpInfo() const override {ProcessDescr    163   void DumpInfo() const override {ProcessDescription(G4cout);};
164   void ProcessDescription(std::ostream& out) c    164   void ProcessDescription(std::ostream& out) const override;
165                                                   165 
166   void SetVerboseLevel(G4int);                    166   void SetVerboseLevel(G4int);
167   // sets verbosity                               167   // sets verbosity
168                                                   168 
169  protected:                                       169  protected:
170   G4PhysicsTable* thePhysicsTable;                170   G4PhysicsTable* thePhysicsTable;
171                                                   171 
172  private:                                         172  private:
173   G4double fMaxBetaChange;                        173   G4double fMaxBetaChange;
174                                                   174   
175   G4int fMaxPhotons;                              175   G4int fMaxPhotons;
176   G4int fNumPhotons;                              176   G4int fNumPhotons;
177                                                   177 
178   G4bool fStackingFlag;                           178   G4bool fStackingFlag;
179   G4bool fTrackSecondariesFirst;                  179   G4bool fTrackSecondariesFirst;
180                                                   180 
181   G4int secID = -1;  // creator modelID           181   G4int secID = -1;  // creator modelID
182                                                   182 
183 };                                                183 };
184                                                   184 
185 inline G4bool G4Cerenkov::GetTrackSecondariesF    185 inline G4bool G4Cerenkov::GetTrackSecondariesFirst() const
186 {                                                 186 {
187   return fTrackSecondariesFirst;                  187   return fTrackSecondariesFirst;
188 }                                                 188 }
189                                                   189 
190 inline G4double G4Cerenkov::GetMaxBetaChangePe    190 inline G4double G4Cerenkov::GetMaxBetaChangePerStep() const
191 {                                                 191 {
192   return fMaxBetaChange;                          192   return fMaxBetaChange;
193 }                                                 193 }
194                                                   194 
195 inline G4int G4Cerenkov::GetMaxNumPhotonsPerSt    195 inline G4int G4Cerenkov::GetMaxNumPhotonsPerStep() const { return fMaxPhotons; }
196                                                   196 
197 inline G4bool G4Cerenkov::GetStackPhotons() co    197 inline G4bool G4Cerenkov::GetStackPhotons() const { return fStackingFlag; }
198                                                   198 
199 inline G4int G4Cerenkov::GetNumPhotons() const    199 inline G4int G4Cerenkov::GetNumPhotons() const { return fNumPhotons; }
200                                                   200 
201 inline G4PhysicsTable* G4Cerenkov::GetPhysicsT    201 inline G4PhysicsTable* G4Cerenkov::GetPhysicsTable() const
202 {                                                 202 {
203   return thePhysicsTable;                         203   return thePhysicsTable;
204 }                                                 204 }
205                                                   205 
206 #endif /* G4Cerenkov_h */                         206 #endif /* G4Cerenkov_h */
207                                                   207