| 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 //
26 // =========================================== 27 // ===========================================================================
27 // GEANT4 class header file 28 // GEANT4 class header file
28 // 29 //
29 // Class: G4ExtDEDXTable 30 // Class: G4ExtDEDXTable
30 // 31 //
31 // Base class: G4VIonDEDXTable << 32 // Base class: G4VIonDEDXTable
32 // << 33 //
33 // Author: Anton Lechner (Anton. 34 // Author: Anton Lechner (Anton.Lechner@cern.ch)
34 // 35 //
35 // First implementation: 29. 02. 2009 36 // First implementation: 29. 02. 2009
36 // 37 //
37 // Modifications: 38 // Modifications:
38 // 03.11.2009 A. Lechner: Added new methods B 39 // 03.11.2009 A. Lechner: Added new methods BuildPhysicsVector according
39 // to interface changes in base cla 40 // to interface changes in base class G4VIonDEDXTable.
40 // 41 //
41 // 42 //
42 // Class description: 43 // Class description:
43 // Utility class for users to add their own 44 // Utility class for users to add their own electronic stopping powers
44 // for ions. This class is dedicated for us 45 // for ions. This class is dedicated for use with G4IonParametrisedLossModel
45 // of the low-energy electromagnetic packag 46 // of the low-energy electromagnetic package.
46 // 47 //
47 // Comments: 48 // Comments:
48 // 49 //
49 // =========================================== << 50 // ===========================================================================
>> 51 //
50 52
51 #ifndef G4EXTDEDXTABLE_HH 53 #ifndef G4EXTDEDXTABLE_HH
52 #define G4EXTDEDXTABLE_HH 54 #define G4EXTDEDXTABLE_HH
53 55
54 #include "G4VIonDEDXTable.hh" <<
55 #include "globals.hh" 56 #include "globals.hh"
56 << 57 #include "G4VIonDEDXTable.hh"
57 #include <map> <<
58 #include <utility> 58 #include <utility>
59 #include <vector> 59 #include <vector>
>> 60 #include <map>
>> 61
>> 62
>> 63 class G4ExtDEDXTable : public G4VIonDEDXTable {
60 64
61 class G4ExtDEDXTable : public G4VIonDEDXTable <<
62 { <<
63 public: 65 public:
64 explicit G4ExtDEDXTable() = default; << 66 explicit G4ExtDEDXTable() = default;
65 ~G4ExtDEDXTable() override; << 67 ~G4ExtDEDXTable() override;
66 G4ExtDEDXTable(G4ExtDEDXTable&) = delete; << 68
67 const G4ExtDEDXTable& operator=(const G4ExtD << 69 G4bool BuildPhysicsVector(G4int ionZ, const G4String& matName) override;
68 <<
69 G4bool BuildPhysicsVector(G4int ionZ, const <<
70 <<
71 G4bool BuildPhysicsVector(G4int ionZ, G4int <<
72 <<
73 // Function for checking the availability of <<
74 // for a given ion-material couple, where th <<
75 // a single element only. <<
76 G4bool IsApplicable(G4int atomicNumberIon, <<
77 G4int atomicNumberElem // Atomic number o <<
78 ) override; <<
79 <<
80 // Function for checking the availability of <<
81 // for given ion-material couples. <<
82 G4bool IsApplicable(G4int atomicNumberIon, <<
83 const G4String& matIdentifier // Name or <<
84 ) override; <<
85 <<
86 // Function returning the stopping power vec <<
87 // couples, where the material consists of a <<
88 G4PhysicsVector* GetPhysicsVector(G4int atom <<
89 G4int atomicNumberElem // Atomic number o <<
90 ) override; <<
91 <<
92 // Function returning the stopping power vec <<
93 // couples. <<
94 G4PhysicsVector* GetPhysicsVector(G4int atom <<
95 const G4String& matIdenfier // Name or ch <<
96 ) override; <<
97 <<
98 // Function returning the stopping power val <<
99 // couples, where the material consists of a <<
100 // given energy. <<
101 G4double GetDEDX(G4double kinEnergyPerNucleo <<
102 G4int atomicNumberIon, // Atomic number o <<
103 G4int atomicNumberElem // Atomic number o <<
104 ); <<
105 <<
106 // Function returning the stopping power val <<
107 // couples and given energy. <<
108 G4double GetDEDX(G4double kinEnergyPerNucleo <<
109 G4int atomicNumberIon, // Atomic number o <<
110 const G4String& matIdenfier // Name or ch <<
111 ); <<
112 <<
113 // Function for adding dE/dx vector for an e <<
114 // argument only applies to elemental materi <<
115 G4bool AddPhysicsVector(G4PhysicsVector* phy <<
116 G4int atomicNumberIon, // Atomic number o <<
117 const G4String& matIdenfier, // Name or c <<
118 G4int atomicNumberElem = 0 // Atomic numb <<
119 ); <<
120 <<
121 // Function for removing dE/dx vector for a <<
122 G4bool RemovePhysicsVector(G4int atomicNumbe <<
123 const G4String& matIdentifier // Name or <<
124 ); <<
125 <<
126 // Function writing all stopping power vecto <<
127 G4bool StorePhysicsTable(const G4String& fil <<
128 ); <<
129 <<
130 // Function retrieving all stopping power ve <<
131 G4bool RetrievePhysicsTable(const G4String& <<
132 ); <<
133 70
134 // Function deleting all physics vectors and << 71 G4bool BuildPhysicsVector(G4int ionZ, G4int matZ) override;
135 void ClearTable(); <<
136 72
137 // Function printing the ion-material pairs << 73 // Function for checking the availability of stopping power tables
138 void DumpMap(); << 74 // for a given ion-material couple, where the material consists of
>> 75 // a single element only.
>> 76 G4bool IsApplicable(
>> 77 G4int atomicNumberIon, // Atomic number of ion
>> 78 G4int atomicNumberElem // Atomic number of elemental material
>> 79 ) override;
>> 80
>> 81 // Function for checking the availability of stopping power tables
>> 82 // for given ion-material couples.
>> 83 G4bool IsApplicable(
>> 84 G4int atomicNumberIon, // Atomic number of ion
>> 85 const G4String& matIdentifier // Name or chemical formula of material
>> 86 ) override;
>> 87
>> 88 // Function returning the stopping power vector for given ion-material
>> 89 // couples, where the material consists of a single element only.
>> 90 G4PhysicsVector* GetPhysicsVector(
>> 91 G4int atomicNumberIon, // Atomic number of ion
>> 92 G4int atomicNumberElem // Atomic number of elemental material
>> 93 ) override;
>> 94
>> 95 // Function returning the stopping power vector for given ion-material
>> 96 // couples.
>> 97 G4PhysicsVector* GetPhysicsVector(
>> 98 G4int atomicNumberIon, // Atomic number of ion
>> 99 const G4String& matIdenfier // Name or chemical formula of material
>> 100 ) override;
>> 101
>> 102 // Function returning the stopping power value for given ion-material
>> 103 // couples, where the material consists of a single element only, and
>> 104 // given energy.
>> 105 G4double GetDEDX(
>> 106 G4double kinEnergyPerNucleon, // Kinetic energy per nucleon
>> 107 G4int atomicNumberIon, // Atomic number of ion
>> 108 G4int atomicNumberElem // Atomic number of elemental material
>> 109 );
>> 110
>> 111 // Function returning the stopping power value for given ion-material
>> 112 // couples and given energy.
>> 113 G4double GetDEDX(
>> 114 G4double kinEnergyPerNucleon, // Kinetic energy per nucleon
>> 115 G4int atomicNumberIon, // Atomic number of ion
>> 116 const G4String& matIdenfier // Name or chemical formula of material
>> 117 );
>> 118
>> 119 // Function for adding dE/dx vector for an elemental materials. The last
>> 120 // argument only applies to elemental materials.
>> 121 G4bool AddPhysicsVector(
>> 122 G4PhysicsVector* physicsVector, // Physics vector
>> 123 G4int atomicNumberIon, // Atomic number of ion
>> 124 const G4String& matIdenfier, // Name or chemical formula of material
>> 125 G4int atomicNumberElem = 0 // Atomic number of elemental material
>> 126 );
>> 127
>> 128 // Function for removing dE/dx vector for a compound materials
>> 129 G4bool RemovePhysicsVector(
>> 130 G4int atomicNumberIon, // Atomic number of ion
>> 131 const G4String& matIdentifier // Name or chemical formula of material
>> 132 );
>> 133
>> 134 // Function writing all stopping power vectors to file
>> 135 G4bool StorePhysicsTable(
>> 136 const G4String& fileName // File name
>> 137 );
>> 138
>> 139 // Function retrieving all stopping power vectors from file
>> 140 G4bool RetrievePhysicsTable(
>> 141 const G4String& fileName // File name
>> 142 );
>> 143
>> 144 // Function deleting all physics vectors and clearing the maps
>> 145 void ClearTable();
>> 146
>> 147 // Function printing the ion-material pairs of available vectors to stdout
>> 148 void DumpMap();
139 149
140 private: 150 private:
141 G4PhysicsVector* CreatePhysicsVector(G4int v <<
142 151
143 G4int FindAtomicNumberElement(G4PhysicsVecto << 152 G4ExtDEDXTable(G4ExtDEDXTable&) = delete;
>> 153 const G4ExtDEDXTable & operator=(const G4ExtDEDXTable&) = delete;
>> 154
>> 155 G4PhysicsVector* CreatePhysicsVector(G4int vectorType);
>> 156
>> 157 G4int FindAtomicNumberElement(G4PhysicsVector* physicsVector);
144 158
145 using G4IonDEDXKeyElem = std::pair<G4int, G4 << 159 using G4IonDEDXKeyElem = std::pair<G4int, G4int>;
146 using G4IonDEDXKeyMat = std::pair<G4int, G4S << 160 using G4IonDEDXKeyMat = std::pair<G4int, G4String>;
147 161
148 using G4IonDEDXMapElem = std::map<G4IonDEDXK << 162 using G4IonDEDXMapElem = std::map<G4IonDEDXKeyElem, G4PhysicsVector*>;
149 using G4IonDEDXMapMat = std::map<G4IonDEDXKe << 163 using G4IonDEDXMapMat = std::map<G4IonDEDXKeyMat, G4PhysicsVector*>;
150 164
151 G4IonDEDXMapElem dedxMapElements; << 165 G4IonDEDXMapElem dedxMapElements;
152 G4IonDEDXMapMat dedxMapMaterials; << 166 G4IonDEDXMapMat dedxMapMaterials;
153 }; 167 };
154 168
155 #endif // G4EXTDEDXTABLE_HH << 169 #endif // G4EXTDEDXTABLE_HH
156 170