Geant4.10
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4Material.hh
Go to the documentation of this file.
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 //
27 // $Id: G4Material.hh 68070 2013-03-13 15:03:06Z gcosmo $
28 //
29 
30 //---------------------------------------------------------------------------
31 //
32 // ClassName: G4Material
33 //
34 // Description: Contains material properties
35 //
36 // Class description:
37 //
38 // Is used to define the material composition of Geant4 volumes.
39 // A G4Material is always made of G4Elements. It should has the name,
40 // the list of G4Elements, material density, material state, temperature,
41 // pressure. Other parameters are optional and may be set by the user code
42 // or computed at initialisation.
43 //
44 // There is several ways to construct G4Material:
45 // - from single element;
46 // - from a list of components (elements or other materials);
47 // - from internal Geant4 database of materials
48 //
49 // A collection of constituent Elements/Materials should be defined
50 // with specified weights by fractional mass or atom counts (only for Elements).
51 //
52 // Quantities, with physical meaning or not, which are constant in a given
53 // material are computed and stored here as Derived data members.
54 //
55 // The class contains as a private static member the Table of defined
56 // materials (an ordered vector of materials).
57 //
58 // It is strongly not recommended to delete materials in user code.
59 // All materials will be deleted automatically at the end of Geant4 session.
60 //
61 
62 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
63 
64 // 10-07-96, new data members added by L.Urban
65 // 12-12-96, new data members added by L.Urban
66 // 20-01-97, aesthetic rearrangement. RadLength calculation modified
67 // Data members Zeff and Aeff REMOVED (i.e. passed to the Elements).
68 // (local definition of Zeff in DensityEffect and FluctModel...)
69 // Vacuum defined as a G4State. Mixture flag removed, M.Maire
70 // 29-01-97, State=Vacuum automatically set density=0 in the contructors.
71 // Subsequent protections have been put in the calculation of
72 // MeanExcEnergy, ShellCorrectionVector, DensityEffect, M.Maire
73 // 20-03-97, corrected initialization of pointers, M.Maire
74 // 10-06-97, new data member added by V.Grichine (fSandiaPhotoAbsCof)
75 // 27-06-97, new function GetElement(int), M.Maire
76 // 24-02-98, fFractionVector become fMassFractionVector
77 // 28-05-98, kState=kVacuum removed:
78 // The vacuum is an ordinary gas vith very low density, M.Maire
79 // 12-06-98, new method AddMaterial() allowing mixture of materials, M.Maire
80 // 09-07-98, Ionisation parameters removed from the class, M.Maire
81 // 04-08-98, new method GetMaterial(materialName), M.Maire
82 // 05-10-98, change name: NumDensity -> NbOfAtomsPerVolume
83 // 18-11-98, SandiaTable interface modified.
84 // 19-07-99, new data member (chemicalFormula) added by V.Ivanchenko
85 // 12-03-01, G4bool fImplicitElement (mma)
86 // 30-03-01, suppression of the warning message in GetMaterial
87 // 17-07-01, migration to STL. M. Verderi.
88 // 14-09-01, Suppression of the data member fIndexInTable
89 // 31-10-01, new function SetChemicalFormula() (mma)
90 // 26-02-02, fIndexInTable renewed
91 // 06-08-02, remove constructors with ChemicalFormula (mma)
92 // 15-11-05, GetMaterial(materialName, G4bool warning=true)
93 // 13-04-12, std::map<G4Material*,G4double> fMatComponents (mma)
94 // 21-04-12, fMassOfMolecule (mma)
95 
96 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
97 
98 #ifndef G4MATERIAL_HH
99 #define G4MATERIAL_HH 1
100 
101 #include <vector>
102 #include <map>
104 
105 #include "globals.hh"
106 #include "G4ios.hh"
107 #include "G4Element.hh"
109 #include "G4IonisParamMat.hh"
110 #include "G4SandiaTable.hh"
111 #include "G4ElementVector.hh"
112 #include "G4MaterialTable.hh"
113 
115 
116 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
117 
119 {
120 public: // with description
121  //
122  // Constructor to create a material from single element
123  //
124  G4Material(const G4String& name, //its name
125  G4double z, //atomic number
126  G4double a, //mass of mole
127  G4double density, //density
128  G4State state = kStateUndefined, //solid,gas
129  G4double temp = CLHEP::STP_Temperature, //temperature
130  G4double pressure = CLHEP::STP_Pressure); //pressure
131 
132  //
133  // Constructor to create a material from a combination of elements
134  // and/or materials subsequently added via AddElement and/or AddMaterial
135  //
136  G4Material(const G4String& name, //its name
137  G4double density, //density
138  G4int nComponents, //nbOfComponents
139  G4State state = kStateUndefined, //solid,gas
140  G4double temp = CLHEP::STP_Temperature, //temperature
141  G4double pressure = CLHEP::STP_Pressure); //pressure
142 
143  //
144  // Constructor to create a material from the base material
145  //
146  G4Material(const G4String& name, //its name
147  G4double density, //density
148  const G4Material* baseMaterial, //base material
149  G4State state = kStateUndefined, //solid,gas
150  G4double temp = CLHEP::STP_Temperature, //temperature
151  G4double pressure = CLHEP::STP_Pressure); //pressure
152 
153  //
154  // Add an element, giving number of atoms
155  //
156  void AddElement(G4Element* element, //the element
157  G4int nAtoms); //nb of atoms in
158  // a molecule
159  //
160  // Add an element or material, giving fraction of mass
161  //
162  void AddElement (G4Element* element , //the element
163  G4double fraction); //fractionOfMass
164 
165  void AddMaterial(G4Material* material, //the material
166  G4double fraction); //fractionOfMass
167 
168 
169  virtual ~G4Material();
170 
171  inline void SetChemicalFormula (const G4String& chF) {fChemicalFormula=chF;}
172 
173  //
174  // retrieval methods
175  //
176  inline const G4String& GetName() const {return fName;}
177  inline const G4String& GetChemicalFormula() const {return fChemicalFormula;}
178  inline G4double GetDensity() const {return fDensity;}
179  inline G4State GetState() const {return fState;}
180  inline G4double GetTemperature() const {return fTemp;}
181  inline G4double GetPressure() const {return fPressure;}
182 
183  //number of elements constituing this material:
184  inline size_t GetNumberOfElements() const {return fNumberOfElements;}
185 
186  //vector of pointers to elements constituing this material:
187  inline const
188  G4ElementVector* GetElementVector() const {return theElementVector;}
189 
190  //vector of fractional mass of each element:
191  inline const
192  G4double* GetFractionVector() const {return fMassFractionVector;}
193 
194  //vector of atom count of each element:
195  inline const
196  G4int* GetAtomsVector() const {return fAtomsVector;}
197 
198  //return a pointer to an element, given its index in the material:
199  inline const
200  G4Element* GetElement(G4int iel) const {return (*theElementVector)[iel];}
201 
202  //vector of nb of atoms per volume of each element in this material:
203  inline const
204  G4double* GetVecNbOfAtomsPerVolume() const {return VecNbOfAtomsPerVolume;}
205  //total number of atoms per volume:
206  inline
207  G4double GetTotNbOfAtomsPerVolume() const {return TotNbOfAtomsPerVolume;}
208  //total number of electrons per volume:
209  inline
210  G4double GetTotNbOfElectPerVolume() const {return TotNbOfElectPerVolume;}
211 
212  //obsolete names (5-10-98) see the 2 functions above
213  inline const
214  G4double* GetAtomicNumDensityVector() const {return VecNbOfAtomsPerVolume;}
215  inline G4double GetElectronDensity() const {return TotNbOfElectPerVolume;}
216 
217  // Radiation length:
218  inline G4double GetRadlen() const {return fRadlen;}
219 
220  // Nuclear interaction length:
221  inline G4double GetNuclearInterLength() const {return fNuclInterLen;}
222 
223  // ionisation parameters:
224  inline G4IonisParamMat* GetIonisation() const {return fIonisation;}
225 
226  // Sandia table:
227  inline G4SandiaTable* GetSandiaTable() const {return fSandiaTable;}
228 
229  // Base material:
230  inline
231  const G4Material* GetBaseMaterial() const {return fBaseMaterial;}
232 
233  // material components:
234  inline
235  std::map<G4Material*,G4double> GetMatComponents() const
236  {return fMatComponents;}
237 
238  //for chemical compound
239  inline
240  G4double GetMassOfMolecule() const {return fMassOfMolecule;}
241 
242  //meaningful only for single material:
243  G4double GetZ() const;
244  G4double GetA() const;
245 
246  //the MaterialPropertiesTable (if any) attached to this material:
248  {fMaterialPropertiesTable = anMPT;}
249 
251  {return fMaterialPropertiesTable;}
252 
253  //the (static) Table of Materials:
254  //
256 
257  static size_t GetNumberOfMaterials();
258 
259  //the index of this material in the Table:
260  inline size_t GetIndex() const {return fIndexInTable;}
261 
262  //return pointer to a material, given its name:
263  static G4Material* GetMaterial(const G4String& name, G4bool warning=true);
264 
265  //
266  //printing methods
267  //
268  friend std::ostream& operator<<(std::ostream&, G4Material*);
269  friend std::ostream& operator<<(std::ostream&, G4Material&);
270  friend std::ostream& operator<<(std::ostream&, G4MaterialTable);
271 
272 public: // without description
273 
274  G4int operator==(const G4Material&) const;
275  G4int operator!=(const G4Material&) const;
276  G4Material(__void__&);
277  // Fake default constructor for usage restricted to direct object
278  // persistency for clients requiring preallocation of memory for
279  // persistifiable objects.
280 
281  inline void SetName (const G4String& name) {fName=name;}
282 
283 private:
284 
285  G4Material(const G4Material&);
286  const G4Material& operator=(const G4Material&);
287 
288  void InitializePointers();
289 
290  // Header routine for all derived quantities
291  void ComputeDerivedQuantities();
292 
293  // Compute Radiation length
294  void ComputeRadiationLength();
295 
296  // Compute Nuclear interaction length
297  void ComputeNuclearInterLength();
298 
299  // Copy pointers of base material
300  void CopyPointersOfBaseMaterial();
301 
302 private:
303 
304  //
305  // Basic data members ( To define a material)
306  //
307  G4String fName; // Material name
308  G4String fChemicalFormula; // Material chemical formula
309  G4double fDensity; // Material density
310 
311  G4State fState; // Material state (determined
312  // internally based on density)
313  G4double fTemp; // Temperature (defaults: STP)
314  G4double fPressure; // Pressure (defaults: STP)
315 
316  G4int maxNbComponents; // totalNbOfComponentsInTheMaterial
317  G4int fArrayLength; // the length of fAtomsVector
318  size_t fNumberOfComponents; // Nb of components declared so far
319 
320  size_t fNumberOfElements; // Nb of Elements in the material
321  G4ElementVector* theElementVector; // vector of constituent Elements
322  G4bool fImplicitElement; // implicit Element created by this?
323  G4double* fMassFractionVector; // composition by fractional mass
324  G4int* fAtomsVector; // composition by atom count
325 
326  G4MaterialPropertiesTable* fMaterialPropertiesTable;
327 
328  static
329  G4MaterialTable theMaterialTable; // the material table
330  size_t fIndexInTable; // the position in the table
331 
332  //
333  // Derived data members (computed from the basic data members)
334  //
335  // some general atomic properties
336 
337  G4double* VecNbOfAtomsPerVolume; // vector of nb of atoms per volume
338  G4double TotNbOfAtomsPerVolume; // total nb of atoms per volume
339  G4double TotNbOfElectPerVolume; // total nb of electrons per volume
340  G4double fRadlen; // Radiation length
341  G4double fNuclInterLen; // Nuclear interaction length
342 
343  G4IonisParamMat* fIonisation; // ionisation parameters
344  G4SandiaTable* fSandiaTable; // Sandia table
345 
346  // utilities
347  //
348  const G4Material* fBaseMaterial; // Pointer to the base material
349  G4double fMassOfMolecule; // for materials built by atoms count
350  std::map<G4Material*,G4double> fMatComponents; // for composites built via
351  // AddMaterial()
352 };
353 
354 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
355 
356 #endif
G4double GetPressure() const
Definition: G4Material.hh:181
G4IonisParamMat * GetIonisation() const
Definition: G4Material.hh:224
G4double GetZ() const
Definition: G4Material.cc:606
G4int operator==(const G4Material &) const
Definition: G4Material.cc:683
void SetChemicalFormula(const G4String &chF)
Definition: G4Material.hh:171
void SetName(const G4String &name)
Definition: G4Material.hh:281
G4double GetTotNbOfElectPerVolume() const
Definition: G4Material.hh:210
std::vector< G4Element * > G4ElementVector
void AddMaterial(G4Material *material, G4double fraction)
Definition: G4Material.cc:450
G4State
Definition: G4Material.hh:114
static G4Material * GetMaterial(const G4String &name, G4bool warning=true)
Definition: G4Material.cc:578
G4double z
Definition: TRTMaterials.hh:39
size_t GetIndex() const
Definition: G4Material.hh:260
const G4String & GetChemicalFormula() const
Definition: G4Material.hh:177
void SetMaterialPropertiesTable(G4MaterialPropertiesTable *anMPT)
Definition: G4Material.hh:247
const G4String & GetName() const
Definition: G4Material.hh:176
static G4MaterialTable * GetMaterialTable()
Definition: G4Material.cc:564
std::vector< G4Material * > G4MaterialTable
G4double GetDensity() const
Definition: G4Material.hh:178
const XML_Char * name
G4int nComponents
Definition: TRTMaterials.hh:41
const G4Element * GetElement(G4int iel) const
Definition: G4Material.hh:200
const G4ElementVector * GetElementVector() const
Definition: G4Material.hh:188
int G4int
Definition: G4Types.hh:78
G4Material(const G4String &name, G4double z, G4double a, G4double density, G4State state=kStateUndefined, G4double temp=CLHEP::STP_Temperature, G4double pressure=CLHEP::STP_Pressure)
Definition: G4Material.cc:87
G4SandiaTable * GetSandiaTable() const
Definition: G4Material.hh:227
string material
Definition: eplot.py:19
G4double density
Definition: TRTMaterials.hh:39
const G4double * GetVecNbOfAtomsPerVolume() const
Definition: G4Material.hh:204
G4double GetElectronDensity() const
Definition: G4Material.hh:215
bool G4bool
Definition: G4Types.hh:79
static size_t GetNumberOfMaterials()
Definition: G4Material.cc:571
G4double GetRadlen() const
Definition: G4Material.hh:218
friend std::ostream & operator<<(std::ostream &, G4Material *)
Definition: G4Material.cc:697
const G4double * GetAtomicNumDensityVector() const
Definition: G4Material.hh:214
G4double GetA() const
Definition: G4Material.cc:619
G4double GetTotNbOfAtomsPerVolume() const
Definition: G4Material.hh:207
G4int operator!=(const G4Material &) const
Definition: G4Material.cc:690
G4MaterialPropertiesTable * GetMaterialPropertiesTable() const
Definition: G4Material.hh:250
G4double GetMassOfMolecule() const
Definition: G4Material.hh:240
const G4Material * GetBaseMaterial() const
Definition: G4Material.hh:231
const G4int * GetAtomsVector() const
Definition: G4Material.hh:196
std::map< G4Material *, G4double > GetMatComponents() const
Definition: G4Material.hh:235
G4double GetTemperature() const
Definition: G4Material.hh:180
void AddElement(G4Element *element, G4int nAtoms)
Definition: G4Material.cc:345
size_t GetNumberOfElements() const
Definition: G4Material.hh:184
G4State GetState() const
Definition: G4Material.hh:179
double G4double
Definition: G4Types.hh:76
const G4double * GetFractionVector() const
Definition: G4Material.hh:192
virtual ~G4Material()
Definition: G4Material.cc:224
G4double GetNuclearInterLength() const
Definition: G4Material.hh:221