| Geant4 Cross Reference |
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 // G4PhysicsTable << 26 //
>> 27 // $Id: G4PhysicsTable.hh 67970 2013-03-13 10:10:06Z gcosmo $
>> 28 //
>> 29 //
>> 30 // ------------------------------------------------------------
>> 31 // GEANT 4 class header file
27 // 32 //
28 // Class description: 33 // Class description:
29 // 34 //
30 // G4PhysicsTable is an utility class for stor 35 // G4PhysicsTable is an utility class for storage of pointers
31 // to G4PhysicsVector containers. It derives a 36 // to G4PhysicsVector containers. It derives all functionalities
32 // of STL vector containers with the addition 37 // of STL vector containers with the addition of few methods for
33 // compatibility with previous implementation 38 // compatibility with previous implementation based on Rogue-Wave
34 // pointer collections. 39 // pointer collections.
35 // The constructor given the 'capacity' of the 40 // The constructor given the 'capacity' of the table, pre-allocates
36 // memory for the specified value by invoking 41 // memory for the specified value by invoking the STL's reserve()
37 // function, in order to avoid reallocation du 42 // function, in order to avoid reallocation during insertions.
38 // G4PhysicsTable has a vector of Boolean whic << 43 // G4PhysicsTable has a vector of boolean which are used
39 // as 'recalc-needed' flags when processes cal << 44 // as 'recalc-needed' flags when processes calculate physics tables.
>> 45 // ------------------------------------------------------------
>> 46 //
>> 47 // History:
>> 48 // -------
>> 49 // - First implementation, based on object model of
>> 50 // 2nd December 1995. G.Cosmo
>> 51 // - 1st March 1996, modified. K.Amako
>> 52 // - 24th February 2001, migration to STL vectors. H.Kurashige
>> 53 // - 9th March 2001, added Store/RetrievePhysicsTable. H.Kurashige
>> 54 // - 20th August 2004, added FlagArray and related methods H.Kurashige
>> 55 //-------------------------------------
40 56
41 // Author: G.Cosmo, 2 December 1995 << 57 #ifndef G4PhysicsTable_h
42 // First implementation based on objec << 58 #define G4PhysicsTable_h 1
43 // Revisions: <<
44 // - 1st March 1996, K.Amako: modified <<
45 // - 24th February 2001, H.Kurashige: migratio <<
46 // ------------------------------------------- <<
47 #ifndef G4PhysicsTable_hh <<
48 #define G4PhysicsTable_hh 1 <<
49 59
50 #include "G4PhysicsVector.hh" <<
51 #include "G4ios.hh" <<
52 #include "globals.hh" <<
53 #include <vector> 60 #include <vector>
>> 61 #include "globals.hh"
>> 62 #include "G4ios.hh"
>> 63
>> 64 class G4PhysicsVector;
54 65
55 class G4PhysicsTable : public std::vector<G4Ph << 66 class G4PhysicsTable : public std::vector<G4PhysicsVector*>
56 { 67 {
57 using G4PhysCollection = std::vector<G4Physi <<
58 using G4FlagCollection = std::vector<G4bool> <<
59 68
60 public: << 69 typedef std::vector<G4PhysicsVector*> G4PhysCollection;
61 G4PhysicsTable() = default; << 70 typedef std::vector<G4bool> G4FlagCollection;
62 // Default constructor << 71
>> 72 public: // with description
>> 73
>> 74 G4PhysicsTable();
>> 75 // Default constructor.
63 76
64 explicit G4PhysicsTable(size_t cap); 77 explicit G4PhysicsTable(size_t cap);
65 // Constructor with capacity. Reserves memor << 78 // Constructor with capacity. Reserves memory for the
>> 79 // specified capacity.
66 80
67 virtual ~G4PhysicsTable(); 81 virtual ~G4PhysicsTable();
68 // Destructor. Does not invoke deletion of c << 82 // Destructor.
69 << 83 // Does not invoke deletion of contained pointed collections.
70 G4PhysicsTable(const G4PhysicsTable&) = dele <<
71 G4PhysicsTable& operator=(const G4PhysicsTab <<
72 84
73 G4PhysicsVector*& operator()(std::size_t); << 85 G4PhysicsVector*& operator()(size_t);
74 G4PhysicsVector* const& operator()(std::size << 86 G4PhysicsVector* const& operator()(size_t) const;
75 // Access operators << 87 // Access operators.
76 88
77 void clearAndDestroy(); 89 void clearAndDestroy();
78 // Removes all items and deletes them at the << 90 // Removes all items and deletes them at the same time.
79 91
80 void push_back(G4PhysicsVector*); << 92 void push_back( G4PhysicsVector* );
81 void insert(G4PhysicsVector*); << 93 void insert (G4PhysicsVector*);
82 // Pushes new element to collection << 94 // Pushes new element to collection.
83 << 95
84 void insertAt(std::size_t, G4PhysicsVector*) << 96 void insertAt (size_t, G4PhysicsVector*);
85 // Insert element at the specified position << 97 // insert element at the specified position in the collection.
86 << 98
87 void resize(std::size_t, G4PhysicsVector* ve << 99 void resize(size_t, G4PhysicsVector* vec = (G4PhysicsVector*)(0));
88 // Resize collection << 100 // resize collection
89 << 101
90 std::size_t entries() const; << 102 size_t entries() const;
91 std::size_t length() const; << 103 size_t length() const;
92 // Return collection's size << 104 // Return collection's size.
93 105
94 G4bool isEmpty() const; 106 G4bool isEmpty() const;
95 // Flags if collection is empty or not << 107 // Flags if collection is empty or not.
96 108
97 G4bool ExistPhysicsTable(const G4String& fil 109 G4bool ExistPhysicsTable(const G4String& fileName) const;
98 // Check if the specified file exists or not << 110 // Check if the specified file exists or not
99 111
100 G4bool StorePhysicsTable(const G4String& fil << 112 G4bool StorePhysicsTable(const G4String& filename, G4bool ascii=false);
101 // Stores PhysicsTable in a file (returns fa << 113 // Stores PhysicsTable in a file (returns false in case of failure).
102 << 114
103 G4bool RetrievePhysicsTable(const G4String& << 115 G4bool RetrievePhysicsTable(const G4String& filename, G4bool ascii=false);
104 // Retrieves Physics from a file (returns fa << 116 // Retrieves Physics from a file (returns false in case of failure).
105 117
106 void ResetFlagArray(); 118 void ResetFlagArray();
107 // Reset the array of flags and all flags ar << 119 // Reset the array of flags and all flags are set "true"
108 // This flag is supposed to be used as "reca << 120 // This flag is supposed to be used as "recalc-needed" flag
109 // associated with each physics vector << 121 // associated with each physics vector
110 << 122
111 G4bool GetFlag(std::size_t i) const; << 123 G4bool GetFlag(size_t i) const;
112 void ClearFlag(std::size_t i); << 124 void ClearFlag(size_t i);
113 // Get/Clear the flag for the 'i-th' physics << 125 // Get/Clear the flag for the 'i-th' physics vector
114 << 126
115 friend std::ostream& operator<<(std::ostream 127 friend std::ostream& operator<<(std::ostream& out, G4PhysicsTable& table);
116 128
117 protected: 129 protected:
118 G4PhysicsVector* CreatePhysicsVector(G4int t << 130
119 G4FlagCollection vecFlag; << 131 G4PhysicsVector* CreatePhysicsVector(G4int type);
>> 132 G4FlagCollection vecFlag;
>> 133
>> 134 private:
>> 135
>> 136 G4PhysicsTable(const G4PhysicsTable&);
>> 137 G4PhysicsTable& operator=(const G4PhysicsTable&);
>> 138 // Private copy constructor and assignment operator.
>> 139
120 }; 140 };
121 141
>> 142 typedef G4PhysicsTable::iterator G4PhysicsTableIterator;
>> 143
>> 144 #include "G4PhysicsVector.hh"
122 #include "G4PhysicsTable.icc" 145 #include "G4PhysicsTable.icc"
123 146
124 #endif 147 #endif
125 148