Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/cuts/include/G4MaterialCutsCouple.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 // G4MaterialCutsCouple
 27 //
 28 // Class description:
 29 //
 30 // The same material can be used in regions with different cut values,
 31 // and physics processes must prepare several different cross-sections
 32 // for that material.
 33 // The G4ProductionCutsTable has G4MaterialCutsCouple objects, each of
 34 // which consists of a material paired with a cut value.
 35 // G4MaterialCutsCouples objects are numbered with an index which is the
 36 // same as the index of a G4PhysicsVector for the corresponding
 37 // G4MaterialCutsCouple in the G4PhysicsTable.
 38 // The list of G4MaterialCutsCouple objects used in the geometry setup
 39 // is updated before starting the event loop in each run.
 40 
 41 // Author: H.Kurashige, 17 September 2002 - First implementation
 42 // --------------------------------------------------------------------
 43 #ifndef G4MaterialCutsCouple_hh 
 44 #define G4MaterialCutsCouple_hh 1
 45 
 46 #include "globals.hh"
 47 #include "G4ios.hh"
 48 #include "G4ProductionCuts.hh"
 49 
 50 class G4Material;
 51 
 52 class G4MaterialCutsCouple  
 53 {
 54   public:
 55 
 56     G4MaterialCutsCouple();
 57     G4MaterialCutsCouple(const G4Material*, G4ProductionCuts* cut = nullptr);
 58       // Constructors
 59 
 60     virtual ~G4MaterialCutsCouple();
 61       // Destructor 
 62 
 63     G4MaterialCutsCouple(const G4MaterialCutsCouple& right);
 64     G4MaterialCutsCouple& operator=(const G4MaterialCutsCouple& right);
 65       // Copy constructor & assignment operator
 66 
 67     G4bool operator==(const G4MaterialCutsCouple& right) const;
 68     G4bool operator!=(const G4MaterialCutsCouple& right) const;
 69       // Equality operators
 70 
 71     void SetMaterial(const G4Material*);
 72       // Set pointer to material
 73 
 74     const G4Material* GetMaterial() const;
 75       // Get pointer to material
 76 
 77     void SetProductionCuts(G4ProductionCuts*);
 78       // Set pointer to production cuts
 79 
 80     G4ProductionCuts* GetProductionCuts() const;
 81       // Get pointer to production cuts
 82 
 83     G4bool IsRecalcNeeded() const;
 84       // Return true if cut and/or material has been modified 
 85       // after last calculation of PhysicsTable          
 86 
 87     void PhysicsTableUpdated();
 88       // Inform end of calculation of Physics Table  
 89 
 90     void SetIndex(G4int idx);
 91     G4int GetIndex() const;
 92       // Set/Get the index number in G4ProductionCutsTable
 93 
 94     void SetUseFlag(G4bool flg = true);
 95     G4bool IsUsed() const;
 96  
 97   private:
 98 
 99     G4bool            isMaterialModified = false;
100     const G4Material* fMaterial = nullptr;
101     G4ProductionCuts* fCuts = nullptr;
102     G4int             indexNumber = -1;
103     G4bool            isUsedInGeometry = false;
104 };
105 
106 // ------------------
107 // Inline methods
108 // ------------------
109 
110 inline 
111 void G4MaterialCutsCouple::SetIndex(G4int idx)
112 {
113   indexNumber = idx;
114 }
115 
116 inline
117 G4int G4MaterialCutsCouple::GetIndex() const
118 {
119   return indexNumber;
120 }
121 
122 inline 
123 void G4MaterialCutsCouple::SetUseFlag(G4bool flg)
124 {
125   isUsedInGeometry = flg;
126 }
127 
128 inline
129 G4bool G4MaterialCutsCouple::IsUsed() const
130 {
131   return isUsedInGeometry;
132 }
133 
134 inline
135 void G4MaterialCutsCouple::SetProductionCuts(G4ProductionCuts* aCut)
136 {
137   fCuts = aCut;
138 }
139 
140 inline
141 G4ProductionCuts* G4MaterialCutsCouple::GetProductionCuts() const
142 {
143   return fCuts;
144 }
145 
146 inline
147 G4bool G4MaterialCutsCouple::operator==(const G4MaterialCutsCouple& right) const
148 {
149   return (this == &right);
150 }
151 
152 inline
153 G4bool G4MaterialCutsCouple::operator!=(const G4MaterialCutsCouple& right) const
154 {
155   return (this !=  &right);
156 }
157 
158 inline
159 void  G4MaterialCutsCouple::SetMaterial(const G4Material* material)
160 {
161   fMaterial = material;
162   isMaterialModified = true;
163 }
164 
165 inline
166 const G4Material* G4MaterialCutsCouple::GetMaterial() const
167 {
168   return fMaterial;
169 }
170 
171 inline
172 G4bool  G4MaterialCutsCouple::IsRecalcNeeded() const
173 {
174   G4bool isCutModified = false;
175   if (fCuts != nullptr ) isCutModified = fCuts->IsModified();
176   return (isMaterialModified || isCutModified);
177 }
178 
179 inline
180 void G4MaterialCutsCouple::PhysicsTableUpdated()
181 {
182   if (fCuts != nullptr ) fCuts->PhysicsTableUpdated();
183   isMaterialModified = false;
184 }
185 
186 #endif
187