Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/biasing/include/G4WeightWindowStore.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 /geometry/biasing/include/G4WeightWindowStore.hh (Version 11.3.0) and /geometry/biasing/include/G4WeightWindowStore.hh (Version 10.5)


  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 // G4WeightWindowStore                         <<  26 //
                                                   >>  27 //
                                                   >>  28 // ----------------------------------------------------------------------
                                                   >>  29 // Class G4WeightWindowStore
 27 //                                                 30 //
 28 // Class description:                              31 // Class description:
 29 //                                                 32 //
 30 // Implementation of a weight window store acc     33 // Implementation of a weight window store according to the
 31 // G4VWeightWindowStore interface.                 34 // G4VWeightWindowStore interface.
 32 // See also G4VWeightWindowStore.              <<  35 // See G4VWeightWindowStore.
 33                                                    36 
 34 // Author: Michael Dressel (CERN), 2003        <<  37 // Author: Michael Dressel (Michael.Dressel@cern.ch)
 35 // Modified: Alex Howard (CERN), 2013 - Change <<  38 //
                                                   >>  39 // Alex Howard (alexander.howard@cern.ch):
                                                   >>  40 // Changed class to a `singleton', with access via the static method
                                                   >>  41 // G4WeightWindowStore::GetInstance().
                                                   >>  42 //
                                                   >>  43 // Member data:
                                                   >>  44 //
                                                   >>  45 //   static G4WeightWindowStore* fInstance
                                                   >>  46 //     - Ptr to the unique instance of class
                                                   >>  47 //
 36 // -------------------------------------------     48 // ----------------------------------------------------------------------
 37 #ifndef G4WEIGHTWINDOWSTORE_HH                 <<  49 #ifndef G4WeightWindowStore_hh
 38 #define G4WEIGHTWINDOWSTORE_HH 1               <<  50 #define G4WeightWindowStore_hh G4WeightWindowStore_hh 
 39                                                    51 
 40 #include "G4VWeightWindowStore.hh"                 52 #include "G4VWeightWindowStore.hh"
 41 #include "G4GeometryCellWeight.hh"                 53 #include "G4GeometryCellWeight.hh"
 42 #include <set>                                     54 #include <set>
 43 #include <vector>                                  55 #include <vector>
 44                                                    56 
 45 class G4WeightWindowStore: public G4VWeightWin     57 class G4WeightWindowStore: public G4VWeightWindowStore
 46 {                                                  58 {
 47   public:  // with description                 << 
 48                                                << 
 49     static G4WeightWindowStore* GetInstance(); << 
 50       // return ptr to singleton instance of t << 
 51                                                << 
 52     static G4WeightWindowStore* GetInstance(co << 
 53       // return ptr to singleton instance of t << 
 54                                                << 
 55     G4double GetLowerWeight(const G4GeometryCe << 
 56                                           G4do << 
 57       // derive a lower weight bound value of  << 
 58       // G4GeometryCell and the corresponding  << 
 59                                                << 
 60     G4bool IsKnown(const G4GeometryCell &gCell << 
 61       // returns true if the gCell is in the s << 
 62                                                << 
 63     void Clear();                              << 
 64                                                << 
 65     void SetWorldVolume();                     << 
 66       // set a pointer to the world volume of  << 
 67     void SetParallelWorldVolume(const G4String << 
 68       // set a pointer to parallel world volum << 
 69                                                << 
 70     const G4VPhysicalVolume& GetWorldVolume()  << 
 71       // return a reference to the world volum << 
 72     virtual const G4VPhysicalVolume* GetParall << 
 73       // return a pointer to parallel world vo << 
 74                                                << 
 75     void AddLowerWeights(const G4GeometryCell& << 
 76                          const std::vector<G4d << 
 77       // add lower weights. Only if general up << 
 78                                                << 
 79     void AddUpperEboundLowerWeightPairs(const  << 
 80                                   const G4Uppe << 
 81       // set upper energy - lower weight pairs << 
 82                                                << 
 83     void SetGeneralUpperEnergyBounds(const std << 
 84                                           std: << 
 85   protected:                                   << 
 86                                                << 
 87     explicit G4WeightWindowStore();            << 
 88       // initialise the weight window store fo << 
 89     explicit G4WeightWindowStore(const G4Strin << 
 90       // initialise the weight window store fo << 
 91                                                << 
 92    ~G4WeightWindowStore() override;            << 
 93       // destructor                            << 
 94                                                << 
 95   private:                                     << 
 96                                                    59 
 97     G4bool IsInWorld(const G4VPhysicalVolume&) <<  60 public:  // with description
 98     void Error(const G4String& m) const;       << 
 99     void SetInternalIterator(const G4GeometryC << 
100                                                    61 
101   private:                                     <<  62   static G4WeightWindowStore* GetInstance();
                                                   >>  63   // Return ptr to singleton instance of the class.
102                                                    64 
103     const G4VPhysicalVolume* fWorldVolume = nu <<  65   static G4WeightWindowStore* GetInstance(const G4String& ParallelWorldName);
                                                   >>  66   // Return ptr to singleton instance of the class.
104                                                    67 
105     std::set<G4double, std::less<G4double> > f <<  68 protected:
106     G4GeometryCellWeight fCellToUpEnBoundLoWeP <<  69 
107     mutable G4GeometryCellWeight::const_iterat <<  70   explicit G4WeightWindowStore();
                                                   >>  71     // initialise the weight window store for the given geometry
                                                   >>  72   explicit G4WeightWindowStore(const G4String& ParallelWorldName);
                                                   >>  73     // initialise the weight window store for the given geometry
                                                   >>  74 
                                                   >>  75   ~G4WeightWindowStore();
                                                   >>  76     // destructor
                                                   >>  77 
                                                   >>  78 public:  // with description
                                                   >>  79 
                                                   >>  80   virtual G4double GetLowerWeight(const G4GeometryCell &gCell, 
                                                   >>  81                       G4double partEnergy) const;
                                                   >>  82     // derive a lower weight bound value of a "cell" addresed by a 
                                                   >>  83     // G4GeometryCell and the coresponding energy from the store.
                                                   >>  84 
                                                   >>  85   virtual G4bool IsKnown(const G4GeometryCell &gCell) const;
                                                   >>  86     // returns true if the gCell is in the store, else false 
                                                   >>  87 
                                                   >>  88   void Clear();
                                                   >>  89 
                                                   >>  90   void SetWorldVolume();
                                                   >>  91     // set a pointer to the world volume of the 
                                                   >>  92     // weightwindow geometry
                                                   >>  93   void SetParallelWorldVolume(G4String paraName);
                                                   >>  94     // set a pointer to the parallel world volume of the 
                                                   >>  95     // weightwindow geometry
                                                   >>  96 
                                                   >>  97 
                                                   >>  98   virtual const G4VPhysicalVolume &GetWorldVolume() const;
                                                   >>  99     // return a reference to the world volume of the 
                                                   >> 100     // weightwindow geometry
                                                   >> 101   virtual const G4VPhysicalVolume* GetParallelWorldVolumePointer() const;
                                                   >> 102     // return a pointer to the parallel world volume of the 
                                                   >> 103     // weightwindow geometry
                                                   >> 104 
                                                   >> 105   void AddLowerWeights(const G4GeometryCell &gCell,
                                                   >> 106            const std::vector<G4double> &lowerWeights);
                                                   >> 107     // add lower weights. Only if general upper energy bounds have 
                                                   >> 108     // been set
                                                   >> 109  
                                                   >> 110   void AddUpperEboundLowerWeightPairs(const G4GeometryCell &gCell,
                                                   >> 111               const G4UpperEnergyToLowerWeightMap&
                                                   >> 112               enWeMap);
                                                   >> 113     // set upper energy - lower weight pairs for a cell
                                                   >> 114 
                                                   >> 115   void SetGeneralUpperEnergyBounds(const std::set<G4double, std::less<G4double> > &enBounds);
                                                   >> 116   
                                                   >> 117 private:
                                                   >> 118 
                                                   >> 119   G4bool IsInWorld(const G4VPhysicalVolume &) const;
                                                   >> 120   void Error(const G4String &m) const;
                                                   >> 121   void SetInternalIterator(const G4GeometryCell &gCell) const;
                                                   >> 122   
                                                   >> 123 private:
                                                   >> 124 
                                                   >> 125   const G4VPhysicalVolume* fWorldVolume;  
                                                   >> 126   //  G4bool fParaFlag;
                                                   >> 127 
                                                   >> 128   std::set<G4double, std::less<G4double> > fGeneralUpperEnergyBounds;
                                                   >> 129   G4GeometryCellWeight fCellToUpEnBoundLoWePairsMap;
                                                   >> 130   mutable G4GeometryCellWeight::const_iterator fCurrentIterator;
108                                                   131 
109     static G4ThreadLocal G4WeightWindowStore*  << 132   static G4ThreadLocal G4WeightWindowStore* fInstance;
                                                   >> 133   
110 };                                                134 };
111                                                   135 
112 #endif                                            136 #endif
113                                                   137