Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/digits_hits/scorer/src/G4PSFlatSurfaceCurrent.cc

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 /digits_hits/scorer/src/G4PSFlatSurfaceCurrent.cc (Version 11.3.0) and /digits_hits/scorer/src/G4PSFlatSurfaceCurrent.cc (Version 11.2.2)


  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 //                                                 27 //
 28 // G4PSFlatSurfaceCurrent                          28 // G4PSFlatSurfaceCurrent
 29 #include "G4PSFlatSurfaceCurrent.hh"               29 #include "G4PSFlatSurfaceCurrent.hh"
 30                                                    30 
 31 #include "G4SystemOfUnits.hh"                      31 #include "G4SystemOfUnits.hh"
 32 #include "G4StepStatus.hh"                         32 #include "G4StepStatus.hh"
 33 #include "G4Track.hh"                              33 #include "G4Track.hh"
 34 #include "G4VSolid.hh"                             34 #include "G4VSolid.hh"
 35 #include "G4VPhysicalVolume.hh"                    35 #include "G4VPhysicalVolume.hh"
 36 #include "G4VPVParameterisation.hh"                36 #include "G4VPVParameterisation.hh"
 37 #include "G4UnitsTable.hh"                         37 #include "G4UnitsTable.hh"
 38 #include "G4GeometryTolerance.hh"                  38 #include "G4GeometryTolerance.hh"
 39 #include "G4VScoreHistFiller.hh"                   39 #include "G4VScoreHistFiller.hh"
 40                                                    40 
 41 //////////////////////////////////////////////     41 ////////////////////////////////////////////////////////////////////////////////
 42 // (Description)                                   42 // (Description)
 43 //   This is a primitive scorer class for scor     43 //   This is a primitive scorer class for scoring only Surface Flux.
 44 //  Current version assumes only for G4Box sha     44 //  Current version assumes only for G4Box shape.
 45 //                                                 45 //
 46 // Surface is defined at the -Z surface.           46 // Surface is defined at the -Z surface.
 47 // Direction                  -Z   +Z              47 // Direction                  -Z   +Z
 48 //   0  IN || OUT            ->|<-  |              48 //   0  IN || OUT            ->|<-  |
 49 //   1  IN                   ->|    |              49 //   1  IN                   ->|    |
 50 //   2  OUT                    |<-  |              50 //   2  OUT                    |<-  |
 51 //                                                 51 //
 52 // Created: 2005-11-14  Tsukasa ASO, Akinori K     52 // Created: 2005-11-14  Tsukasa ASO, Akinori Kimura.
 53 // 17-Nov-2005 T.Aso, Bug fix for area definit     53 // 17-Nov-2005 T.Aso, Bug fix for area definition.
 54 // 31-Mar-2007 T.Aso, Add option for normalizi     54 // 31-Mar-2007 T.Aso, Add option for normalizing by the area.
 55 // 2010-07-22   Introduce Unit specification.      55 // 2010-07-22   Introduce Unit specification.
 56 // 2020-10-06   Use G4VPrimitivePlotter and fi     56 // 2020-10-06   Use G4VPrimitivePlotter and fill 1-D histo of kinetic energy (x)
 57 //              vs. Surface Current * track w     57 //              vs. Surface Current * track weight (y)    (Makoto Asai)
 58 //                                                 58 //
 59 //////////////////////////////////////////////     59 ///////////////////////////////////////////////////////////////////////////////
 60                                                    60 
 61 G4PSFlatSurfaceCurrent::G4PSFlatSurfaceCurrent <<  61 G4PSFlatSurfaceCurrent::G4PSFlatSurfaceCurrent(G4String name, G4int direction,
 62                                                    62                                                G4int depth)
 63   : G4PSFlatSurfaceCurrent(name, direction, "p     63   : G4PSFlatSurfaceCurrent(name, direction, "percm2", depth) 
 64 {}                                                 64 {}
 65                                                    65 
 66 G4PSFlatSurfaceCurrent::G4PSFlatSurfaceCurrent <<  66 G4PSFlatSurfaceCurrent::G4PSFlatSurfaceCurrent(G4String name, G4int direction,
 67                                                    67                                                const G4String& unit,
 68                                                    68                                                G4int depth)
 69   : G4VPrimitivePlotter(name, depth)               69   : G4VPrimitivePlotter(name, depth)
 70   , HCID(-1)                                       70   , HCID(-1)
 71   , fDirection(direction)                          71   , fDirection(direction)
 72   , EvtMap(nullptr)                                72   , EvtMap(nullptr)
 73   , weighted(true)                                 73   , weighted(true)
 74   , divideByArea(true)                             74   , divideByArea(true)
 75 {                                                  75 {
 76   DefineUnitAndCategory();                         76   DefineUnitAndCategory();
 77   SetUnit(unit);                                   77   SetUnit(unit);
 78 }                                                  78 }
 79                                                    79 
 80 G4bool G4PSFlatSurfaceCurrent::ProcessHits(G4S     80 G4bool G4PSFlatSurfaceCurrent::ProcessHits(G4Step* aStep, G4TouchableHistory*)
 81 {                                                  81 {
 82   G4StepPoint* preStep             = aStep->Ge     82   G4StepPoint* preStep             = aStep->GetPreStepPoint();
 83   G4VPhysicalVolume* physVol       = preStep->     83   G4VPhysicalVolume* physVol       = preStep->GetPhysicalVolume();
 84   G4VPVParameterisation* physParam = physVol->     84   G4VPVParameterisation* physParam = physVol->GetParameterisation();
 85   G4VSolid* solid                  = nullptr;      85   G4VSolid* solid                  = nullptr;
 86   if(physParam != nullptr)                         86   if(physParam != nullptr)
 87   {  // for parameterized volume                   87   {  // for parameterized volume
 88     G4int idx =                                    88     G4int idx =
 89       ((G4TouchableHistory*) (aStep->GetPreSte     89       ((G4TouchableHistory*) (aStep->GetPreStepPoint()->GetTouchable()))
 90         ->GetReplicaNumber(indexDepth);            90         ->GetReplicaNumber(indexDepth);
 91     solid = physParam->ComputeSolid(idx, physV     91     solid = physParam->ComputeSolid(idx, physVol);
 92     solid->ComputeDimensions(physParam, idx, p     92     solid->ComputeDimensions(physParam, idx, physVol);
 93   }                                                93   }
 94   else                                             94   else
 95   {  // for ordinary volume                        95   {  // for ordinary volume
 96     solid = physVol->GetLogicalVolume()->GetSo     96     solid = physVol->GetLogicalVolume()->GetSolid();
 97   }                                                97   }
 98                                                    98 
 99   auto  boxSolid = (G4Box*) (solid);               99   auto  boxSolid = (G4Box*) (solid);
100                                                   100 
101   G4int dirFlag = IsSelectedSurface(aStep, box    101   G4int dirFlag = IsSelectedSurface(aStep, boxSolid);
102   if(dirFlag > 0)                                 102   if(dirFlag > 0)
103   {                                               103   {
104     if(fDirection == fCurrent_InOut || fDirect    104     if(fDirection == fCurrent_InOut || fDirection == dirFlag)
105     {                                             105     {
106       G4int index                    = GetInde    106       G4int index                    = GetIndex(aStep);
107       G4TouchableHandle theTouchable = preStep    107       G4TouchableHandle theTouchable = preStep->GetTouchableHandle();
108       G4double current               = 1.0;       108       G4double current               = 1.0;
109       if(weighted)                                109       if(weighted)
110         current = preStep->GetWeight();  // Cu    110         current = preStep->GetWeight();  // Current (Particle Weight)
111       if(divideByArea)                            111       if(divideByArea)
112       {                                           112       {
113         G4double square =                         113         G4double square =
114           4. * boxSolid->GetXHalfLength() * bo    114           4. * boxSolid->GetXHalfLength() * boxSolid->GetYHalfLength();
115         current = current / square;  // Normal    115         current = current / square;  // Normalized by Area
116       }                                           116       }
117       EvtMap->add(index, current);                117       EvtMap->add(index, current);
118                                                   118 
119       if(!hitIDMap.empty() && hitIDMap.find(in    119       if(!hitIDMap.empty() && hitIDMap.find(index) != hitIDMap.cend())
120       {                                           120       {
121         auto filler = G4VScoreHistFiller::Inst    121         auto filler = G4VScoreHistFiller::Instance();
122         if(filler == nullptr)                     122         if(filler == nullptr)
123         {                                         123         {
124           G4Exception("G4PSFlatSurfaceCurrent:    124           G4Exception("G4PSFlatSurfaceCurrent::ProcessHits", "SCORER0123",
125                       JustWarning,                125                       JustWarning,
126                       "G4TScoreHistFiller is n    126                       "G4TScoreHistFiller is not instantiated!! Histogram is "
127                       "not filled.");             127                       "not filled.");
128         }                                         128         }
129         else                                      129         else
130         {                                         130         {
131           filler->FillH1(hitIDMap[index], preS    131           filler->FillH1(hitIDMap[index], preStep->GetKineticEnergy(), current);
132         }                                         132         }
133       }                                           133       }
134     }                                             134     }
135   }                                               135   }
136                                                   136 
137   return true;                                    137   return true;
138 }                                                 138 }
139                                                   139 
140 G4int G4PSFlatSurfaceCurrent::IsSelectedSurfac    140 G4int G4PSFlatSurfaceCurrent::IsSelectedSurface(G4Step* aStep, G4Box* boxSolid)
141 {                                                 141 {
142   G4TouchableHandle theTouchable =                142   G4TouchableHandle theTouchable =
143     aStep->GetPreStepPoint()->GetTouchableHand    143     aStep->GetPreStepPoint()->GetTouchableHandle();
144   G4double kCarTolerance =                        144   G4double kCarTolerance =
145     G4GeometryTolerance::GetInstance()->GetSur    145     G4GeometryTolerance::GetInstance()->GetSurfaceTolerance();
146                                                   146 
147   if(aStep->GetPreStepPoint()->GetStepStatus()    147   if(aStep->GetPreStepPoint()->GetStepStatus() == fGeomBoundary)
148   {                                               148   {
149     // Entering Geometry                          149     // Entering Geometry
150     G4ThreeVector stppos1 = aStep->GetPreStepP    150     G4ThreeVector stppos1 = aStep->GetPreStepPoint()->GetPosition();
151     G4ThreeVector localpos1 =                     151     G4ThreeVector localpos1 =
152       theTouchable->GetHistory()->GetTopTransf    152       theTouchable->GetHistory()->GetTopTransform().TransformPoint(stppos1);
153     if(std::fabs(localpos1.z() + boxSolid->Get    153     if(std::fabs(localpos1.z() + boxSolid->GetZHalfLength()) < kCarTolerance)
154     {                                             154     {
155       return fCurrent_In;                         155       return fCurrent_In;
156     }                                             156     }
157   }                                               157   }
158                                                   158 
159   if(aStep->GetPostStepPoint()->GetStepStatus(    159   if(aStep->GetPostStepPoint()->GetStepStatus() == fGeomBoundary)
160   {                                               160   {
161     // Exiting Geometry                           161     // Exiting Geometry
162     G4ThreeVector stppos2 = aStep->GetPostStep    162     G4ThreeVector stppos2 = aStep->GetPostStepPoint()->GetPosition();
163     G4ThreeVector localpos2 =                     163     G4ThreeVector localpos2 =
164       theTouchable->GetHistory()->GetTopTransf    164       theTouchable->GetHistory()->GetTopTransform().TransformPoint(stppos2);
165     if(std::fabs(localpos2.z() + boxSolid->Get    165     if(std::fabs(localpos2.z() + boxSolid->GetZHalfLength()) < kCarTolerance)
166     {                                             166     {
167       return fCurrent_Out;                        167       return fCurrent_Out;
168     }                                             168     }
169   }                                               169   }
170                                                   170 
171   return -1;                                      171   return -1;
172 }                                                 172 }
173                                                   173 
174 void G4PSFlatSurfaceCurrent::Initialize(G4HCof    174 void G4PSFlatSurfaceCurrent::Initialize(G4HCofThisEvent* HCE)
175 {                                                 175 {
176   EvtMap = new G4THitsMap<G4double>(detector->    176   EvtMap = new G4THitsMap<G4double>(detector->GetName(), GetName());
177   if(HCID < 0)                                    177   if(HCID < 0)
178     HCID = GetCollectionID(0);                    178     HCID = GetCollectionID(0);
179   HCE->AddHitsCollection(HCID, (G4VHitsCollect    179   HCE->AddHitsCollection(HCID, (G4VHitsCollection*) EvtMap);
180 }                                                 180 }
181                                                   181 
182 void G4PSFlatSurfaceCurrent::clear() { EvtMap-    182 void G4PSFlatSurfaceCurrent::clear() { EvtMap->clear(); }
183                                                   183 
184 void G4PSFlatSurfaceCurrent::PrintAll()           184 void G4PSFlatSurfaceCurrent::PrintAll()
185 {                                                 185 {
186   G4cout << " MultiFunctionalDet  " << detecto    186   G4cout << " MultiFunctionalDet  " << detector->GetName() << G4endl;
187   G4cout << " PrimitiveScorer " << GetName() <    187   G4cout << " PrimitiveScorer " << GetName() << G4endl;
188   G4cout << " Number of entries " << EvtMap->e    188   G4cout << " Number of entries " << EvtMap->entries() << G4endl;
189   for(const auto& [copy, current] : *(EvtMap->    189   for(const auto& [copy, current] : *(EvtMap->GetMap()))
190   {                                               190   {
191     G4cout << "  copy no.: " << copy << " curr    191     G4cout << "  copy no.: " << copy << " current : ";
192     if(divideByArea)                              192     if(divideByArea)
193     {                                             193     {
194       G4cout << *(current) / GetUnitValue() <<    194       G4cout << *(current) / GetUnitValue() << " [" << GetUnit() << "]";
195     }                                             195     }
196     else                                          196     else
197     {                                             197     {
198       G4cout << *(current) / GetUnitValue() <<    198       G4cout << *(current) / GetUnitValue() << " [tracks]";
199     }                                             199     }
200     G4cout << G4endl;                             200     G4cout << G4endl;
201   }                                               201   }
202 }                                                 202 }
203                                                   203 
204 void G4PSFlatSurfaceCurrent::SetUnit(const G4S    204 void G4PSFlatSurfaceCurrent::SetUnit(const G4String& unit)
205 {                                                 205 {
206   if(divideByArea)                                206   if(divideByArea)
207   {                                               207   {
208     CheckAndSetUnit(unit, "Per Unit Surface");    208     CheckAndSetUnit(unit, "Per Unit Surface");
209   }                                               209   }
210   else                                            210   else
211   {                                               211   {
212     if(unit.empty())                              212     if(unit.empty())
213     {                                             213     {
214       unitName  = unit;                           214       unitName  = unit;
215       unitValue = 1.0;                            215       unitValue = 1.0;
216     }                                             216     }
217     else                                          217     else
218     {                                             218     {
219       G4String msg = "Invalid unit [" + unit +    219       G4String msg = "Invalid unit [" + unit + "] (Current  unit is [" +
220                      GetUnit() + "] ) for " +     220                      GetUnit() + "] ) for " + GetName();
221       G4Exception("G4PSFlatSurfaceCurrent::Set    221       G4Exception("G4PSFlatSurfaceCurrent::SetUnit", "DetPS0007", JustWarning,
222                   msg);                           222                   msg);
223     }                                             223     }
224   }                                               224   }
225 }                                                 225 }
226                                                   226 
227 void G4PSFlatSurfaceCurrent::DefineUnitAndCate    227 void G4PSFlatSurfaceCurrent::DefineUnitAndCategory()
228 {                                                 228 {
229   // Per Unit Surface                             229   // Per Unit Surface
230   new G4UnitDefinition("percentimeter2", "perc    230   new G4UnitDefinition("percentimeter2", "percm2", "Per Unit Surface",
231                        (1. / cm2));               231                        (1. / cm2));
232   new G4UnitDefinition("permillimeter2", "perm    232   new G4UnitDefinition("permillimeter2", "permm2", "Per Unit Surface",
233                        (1. / mm2));               233                        (1. / mm2));
234   new G4UnitDefinition("permeter2", "perm2", "    234   new G4UnitDefinition("permeter2", "perm2", "Per Unit Surface", (1. / m2));
235 }                                                 235 }
236                                                   236