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