| 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 //---------------------------------------------------------------------------
27 //
28 // ClassName: G4ExtendedMaterial
29 //
30 // Description: Contains extended material properties
31 //
32 // Class description:
33 //
34 // Is used to define the additional material information. This class
35 // contains a map of G4VMaterialExtension associated with an integer key.
36 //
37
38 #ifndef G4EXTENDEDMATERIAL_HH
39 #define G4EXTENDEDMATERIAL_HH 1
40
41 #include "G4Material.hh"
42 #include "G4VMaterialExtension.hh" //Needed for hash defintion
43
44 #include <memory>
45 #include <unordered_map>
46
47 // A map for material extensions based on the hash of the name.
48 // Extensions are owned by the map
49 using G4MaterialExtensionMap = std::unordered_map<G4String, // KEY
50 std::unique_ptr<G4VMaterialExtension>, // VALUE
51 G4MaterialExtensionHash>; // HASHING FUNCTOR
52
53 class G4ExtendedMaterial : public G4Material
54 {
55 public: // with description
56 // Constructor to create an extended material from the base-class G4Material
57 G4ExtendedMaterial(const G4String& name, // its name
58 const G4Material* baseMaterial); // base material
59
60 // Constructor to create an extended material from single element
61 G4ExtendedMaterial(const G4String& name, // its name
62 G4double z, // atomic number
63 G4double a, // mass of mole
64 G4double density, // density
65 G4State state = kStateUndefined, // solid,gas
66 G4double temp = NTP_Temperature, // temperature
67 G4double pressure = CLHEP::STP_Pressure); // pressure
68
69 // Constructor to create an extended material from a combination of elements
70 // and/or materials subsequently added via AddElement and/or AddMaterial
71 G4ExtendedMaterial(const G4String& name, // its name
72 G4double density, // density
73 G4int nComponents, // nbOfComponents
74 G4State state = kStateUndefined, // solid,gas
75 G4double temp = NTP_Temperature, // temperature
76 G4double pressure = CLHEP::STP_Pressure); // pressure
77
78 // Constructor to create an extended material from the base extended material
79 G4ExtendedMaterial(const G4String& name, // its name
80 G4double density, // density
81 const G4ExtendedMaterial* baseMaterial, // base material
82 G4State state = kStateUndefined, // solid,gas
83 G4double temp = NTP_Temperature, // temperature
84 G4double pressure = CLHEP::STP_Pressure); // pressure
85
86 ~G4ExtendedMaterial() override = default;
87
88 // register G4VMaterialExtension
89 // This class owns extensions. Register with:
90 // RegisterExtension(std::unique_ptr<MyExtension>(new MyExtension("name")));
91 // or:
92 // RegisteerExtension(std::make_unique<MyExtension>("name"));
93 void RegisterExtension(std::unique_ptr<G4VMaterialExtension> extension);
94
95 // retrieve G4VMaterialExtension, null pointer is returned if model is not available
96 G4VMaterialExtension* RetrieveExtension(const G4String& name);
97
98 inline G4int GetNumberOfExtensions() const { return G4int(fExtensionMap.size()); }
99
100 // Retrieve iterators, proxyes to c++ methods. These are const for read-only
101 // access. Use Register/RetreiveExtension to modify map
102 G4MaterialExtensionMap::const_iterator begin() const { return fExtensionMap.begin(); }
103 G4MaterialExtensionMap::const_iterator cbegin() const { return fExtensionMap.cbegin(); }
104 G4MaterialExtensionMap::const_iterator end() const { return fExtensionMap.end(); }
105 G4MaterialExtensionMap::const_iterator cend() const { return fExtensionMap.cend(); }
106
107 G4bool IsExtended() const override;
108 void Print(std::ostream& flux) const;
109
110 private:
111 G4MaterialExtensionMap fExtensionMap;
112 };
113
114 #endif
115