// // ******************************************************************** // * DISCLAIMER * // * * // * The following disclaimer summarizes all the specific disclaimers * // * of contributors to this software. The specific disclaimers,which * // * govern, are listed with their locations in: * // * http://cern.ch/geant4/license * // * * // * Neither the authors of this software system, nor their employing * // * institutes,nor the agencies providing financial support for this * // * work make any representation or warranty, express or implied, * // * regarding this software system or assume any liability for its * // * use. * // * * // * This code implementation is the intellectual property of the * // * GEANT4 collaboration. * // * By copying, distributing or modifying the Program (or any work * // * based on the Program) you indicate your acceptance of this * // * statement, and all its terms. * // ******************************************************************** // // // $Id: G4Material.hh,v 1.11.2.1 2001/06/28 19:10:29 gunter Exp $ // GEANT4 tag $Name: $ // // class description // // Materials defined via the G4Material class are used to define the // composition of Geant volumes. // a Material is always made of Elements. It can be defined directly // from scratch (defined by an implicit, single element), specifying : // its name, // density, // state informations, // and Z,A of the underlying Element. // // or in terms of a collection of constituent Elements with specified weights // (composition specified either by fractional mass or atom counts). // // Quantities, with physical meaning or not, which are constant in a given // material are computed and stored here as Derived data members. // // The class contains as a private static member the Table of defined // materials (an ordered vector of materials). // //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... // 10-07-96, new data members added by L.Urban // 12-12-96, new data members added by L.Urban // 20-01-97, aesthetic rearrangement. RadLength calculation modified // Data members Zeff and Aeff REMOVED (i.e. passed to the Elements). // (local definition of Zeff in DensityEffect and FluctModel...) // Vacuum defined as a G4State. Mixture flag removed, M.Maire // 29-01-97, State=Vacuum automatically set density=0 in the contructors. // Subsequent protections have been put in the calculation of // MeanExcEnergy, ShellCorrectionVector, DensityEffect, M.Maire // 20-03-97, corrected initialization of pointers, M.Maire // 10-06-97, new data member added by V.Grichine (fSandiaPhotoAbsCof) // 27-06-97, new function GetElement(int), M.Maire // 24-02-98, fFractionVector become fMassFractionVector // 28-05-98, kState=kVacuum removed: // The vacuum is an ordinary gas vith very low density, M.Maire // 12-06-98, new method AddMaterial() allowing mixture of materials, M.Maire // 09-07-98, Ionisation parameters removed from the class, M.Maire // 04-08-98, new method GetMaterial(materialName), M.Maire // 05-10-98, change name: NumDensity -> NbOfAtomsPerVolume // 18-11-98, SandiaTable interface modified. // 19-07-99, new data member (chemicalFormula) added by V.Ivanchenko // 12-03-01, G4bool fImplicitElement (mma) // 30-03-01, suppression of the warning message in GetMaterial //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... #ifndef G4MATERIAL_HH #define G4MATERIAL_HH #include "G4ios.hh" #include "g4rw/tpvector.h" #include "g4rw/tpordvec.h" #include "globals.hh" #include "G4Element.hh" #include "G4MaterialPropertiesTable.hh" #include "G4IonisParamMat.hh" #include "G4SandiaTable.hh" typedef G4RWTPtrVector G4ElementVector; class G4Material; //forward declaration typedef G4RWTPtrOrderedVector G4MaterialTable; enum G4State { kStateUndefined, kStateSolid, kStateLiquid, kStateGas }; //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... class G4Material { public: // with description // // Constructor to create a material from scratch. // G4Material(const G4String& name, //its name G4double z, //atomic number G4double a, //mass of mole G4double density, //density G4State state = kStateUndefined, //solid,liqid,gas G4double temp = STP_Temperature, //temperature G4double pressure = STP_Pressure); //pressure // // Constructor to create a material from a combination of elements // and/or materials subsequently added via AddElement and/or AddMaterial // G4Material(const G4String& name, //its name G4double density, //density G4int nComponents, //nb of components G4State state = kStateUndefined, //solid,liquid,gas G4double temp = STP_Temperature, //temperature G4double pressure = STP_Pressure); //pressure // // Constructor to create a material with chemical formula from scratch. // G4Material(const G4String& name, //its name const G4String& chFormula, //chemical formula G4double z, //atomic number G4double a, //mass of mole G4double density, //density G4State state = kStateUndefined, //solid,liqid,gas G4double temp = STP_Temperature, //temperature G4double pressure = STP_Pressure); //pressure // // Constructor to create a material with chemical formula from a // combination of elements and/or materials subsequently added via // AddElement and/or AddMaterial // G4Material(const G4String& name, //its name const G4String& chFormula, //chemical formula G4double density, //density G4int nComponents, //nb of components G4State state = kStateUndefined, //solid,liquid,gas G4double temp = STP_Temperature, //temperature G4double pressure = STP_Pressure); //pressure // // Add an element, giving number of atoms // void AddElement(G4Element* element, //the element G4int nAtoms); //nb of atoms in a molecule // // Add an element or material, giving fraction of mass // void AddElement (G4Element* element , //the element G4double fraction); //fraction of mass void AddMaterial(G4Material* material, //the material G4double fraction); //fraction of mass virtual ~G4Material(); // // retrieval methods // G4String GetName() const {return fName;}; G4String GetChemicalFormula() const {return fChemicalFormula;}; G4double GetDensity() const {return fDensity;}; G4State GetState() const {return fState;}; G4double GetTemperature() const {return fTemp;}; G4double GetPressure() const {return fPressure;}; //number of elements constituing this material: size_t GetNumberOfElements() const {return fNumberOfElements;}; //vector of pointers to elements constituing this material: const G4ElementVector* GetElementVector() const {return theElementVector;}; //vector of fractional mass of each element: const G4double* GetFractionVector() const {return fMassFractionVector;}; //vector of atom count of each element: const G4int* GetAtomsVector() const {return fAtomsVector;}; //return a pointer to an element, given its index in the material: const G4Element* GetElement(G4int iel) const {return (*theElementVector)[iel];}; //vector of nb of atoms per volume of each element in this material: const G4double* GetVecNbOfAtomsPerVolume() const {return VecNbOfAtomsPerVolume;}; //total number of atoms per volume: G4double GetTotNbOfAtomsPerVolume() const {return TotNbOfAtomsPerVolume;}; //total number of electrons per volume: G4double GetTotNbOfElectPerVolume() const {return TotNbOfElectPerVolume;}; //obsolete names (5-10-98) see the 2 functions above const G4double* GetAtomicNumDensityVector() const {return VecNbOfAtomsPerVolume;}; G4double GetElectronDensity() const {return TotNbOfElectPerVolume;}; // Radiation length: G4double GetRadlen() const {return fRadlen;}; // Nuclear interaction length: G4double GetNuclearInterLength() const {return fNuclInterLen;}; // ionisation parameters: G4IonisParamMat* GetIonisation() const {return fIonisation;}; // Sandia table: G4SandiaTable* GetSandiaTable() const {return fSandiaTable;}; //meaningful only for single material: G4double GetZ() const; G4double GetA() const; //the MaterialPropertiesTable (if any) attached to this material: void SetMaterialPropertiesTable(G4MaterialPropertiesTable* anMPT) {fMaterialPropertiesTable = anMPT;}; G4MaterialPropertiesTable* GetMaterialPropertiesTable() const {return fMaterialPropertiesTable;}; //the (static) Table of Materials: static const G4MaterialTable* GetMaterialTable() {return &theMaterialTable;}; static size_t GetNumberOfMaterials() {return theMaterialTable.length();}; //the index of this material in the Table: size_t GetIndex() const {return fIndexInTable;}; //return pointer to a material, given its name: static G4Material* GetMaterial(G4String name); // //printing methods // friend G4std::ostream& operator<<(G4std::ostream&, G4Material*); friend G4std::ostream& operator<<(G4std::ostream&, G4Material&); friend G4std::ostream& operator<<(G4std::ostream&, G4MaterialTable); public: // without description G4int operator==(const G4Material&) const; G4int operator!=(const G4Material&) const; private: G4Material(const G4Material&); const G4Material& operator=(const G4Material&); void InitializePointers(); // Header routine for all derived quantities void ComputeDerivedQuantities(); // Compute Radiation length void ComputeRadiationLength(); // Compute Nuclear interaction length void ComputeNuclearInterLength(); private: // // Basic data members ( To define a material) // G4String fName; // Material name G4String fChemicalFormula; // Material chemical formula G4double fDensity; // Material density G4State fState; // Material state (defaults to undefined, // determined internally based on density) G4double fTemp; // Temperature (defaults to STP) G4double fPressure; // Pressure (defaults to STP) G4int maxNbComponents; // total number of components in the material size_t fNumberOfComponents; // Number of components declared so far size_t fNumberOfElements; // Number of Elements in the material G4ElementVector* theElementVector; // vector of constituent Elements G4bool fImplicitElement; // implicit Element created by this? G4double* fMassFractionVector; // composition by fractional mass G4int* fAtomsVector; // composition by atom count G4MaterialPropertiesTable* fMaterialPropertiesTable; static G4MaterialTable theMaterialTable; // the material table size_t fIndexInTable; // Index of material in the material table // // Derived data members (computed from the basic data members) // // some general atomic properties G4double* VecNbOfAtomsPerVolume; // vector of nb of atoms per volume G4double TotNbOfAtomsPerVolume; // total nb of atoms per volume G4double TotNbOfElectPerVolume; // total nb of electrons per volume G4double fRadlen; // Radiation length G4double fNuclInterLen; // Nuclear interaction length G4IonisParamMat* fIonisation; // ionisation parameters G4SandiaTable* fSandiaTable; // Sandia table }; //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... inline G4Material* G4Material::GetMaterial(G4String materialName) { // search the material by its name for (size_t J=0 ; JGetName() == materialName) return theMaterialTable[J]; } // the material does not exist in the table return NULL; } //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... inline G4double G4Material::GetZ() const { if (fNumberOfElements > 1) { G4cerr << "WARNING in GetZ. The material: " << fName << " is a mixture." << G4endl; G4Exception ( " the Atomic number is not well defined." ); } return (*theElementVector)(0)->GetZ(); } //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... inline G4double G4Material::GetA() const { if (fNumberOfElements > 1) { G4cerr << "WARNING in GetA. The material: " << fName << " is a mixture." << G4endl; G4Exception ( " the Atomic mass is not well defined." ); } return (*theElementVector)(0)->GetA(); } //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... #endif