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