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