include/Geant4/G4IsotopeMagneticMomentTable.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 #ifndef G4IsotopeMagneticMomentTable_h
0027 #define G4IsotopeMagneticMomentTable_h 1
0028 // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0029 //
0030 // MODULE:              G4IsotopeMagneticMomentTable.hh
0031 //
0032 // Date:                16/03/07
0033 // Author:              H.Kurashige
0034 //
0035 // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0036 //
0037 // HISTORY
0038 ////////////////////////////////////////////////////////////////////////////////// IsomerLevel is
0039 /// added                         30 Apr. 2013  H.Kurashige
0040
0041 #include "G4Ions.hh"
0042 #include "G4IsotopeProperty.hh"
0043 #include "G4ParticleTable.hh"
0044 #include "G4VIsotopeTable.hh"
0045 #include "globals.hh"
0046
0047 #include <vector>
0048
0049 class G4IsotopeMagneticMomentTable : public G4VIsotopeTable
0050 {
0051     // class description
0052     //   G4IsotopeMagneticMomentTable is the table of pointers to G4IsotopeProperty,
0053     //   which has magnetic moment and spin.
0054     //   Data File name is given by G4IONMAGNETICMOMENT
0055     //
0056   public:
0057     using G4IsotopeList = std::vector<G4IsotopeProperty*>;
0058     using G4IsotopeNameList = std::vector<G4String>;
0059
0060   public:
0061     // constructor
0062     G4IsotopeMagneticMomentTable();
0063
0064     // destructor
0065     ~G4IsotopeMagneticMomentTable() override;
0066
0067     // The FindIsotope function will replace the pure virtual one defined in the
0068     // abstract base class G4VIstopeTable.  We don't use this fuction in this
0069     // implementation, instead we use the next function.
0070     virtual G4bool FindIsotope(G4IsotopeProperty* property);
0071
0072     //
0073     //   again it will replace the pure virtual one in the abstract base class.
0074     //
0075     //   Z: Atomic Number
0076     //   A: Atomic Mass
0077     //   E: Excitaion energy
0078     //   flb: floating level base (enum defined in G4Ions.hh)
0079     //          -- currently ignored
0080     //    or
0081     //    G4int  level: isomer level
0082     //
0083     G4IsotopeProperty*
0084     GetIsotope(G4int Z, G4int A, G4double E,
0085                G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float) override;
0086     G4IsotopeProperty* GetIsotopeByIsoLvl(G4int Z, G4int A, G4int lvl = 0) override;
0087
0088   protected:
0089     // hide copy construictor and assignment operator as protected
0090     G4IsotopeMagneticMomentTable(const G4IsotopeMagneticMomentTable& right);
0091     G4IsotopeMagneticMomentTable& operator=(const G4IsotopeMagneticMomentTable& right);
0092
0093   private:
0094     // get Verbose Level defined in G4ParticleTable
0095     G4int GetVerboseLevel() const;
0096
0097   private:
0098     G4IsotopeList fIsotopeList;
0099
0100     static const G4double levelTolerance;
0101     static const G4double nuclearMagneton;
0102 };
0103
0104 inline G4int G4IsotopeMagneticMomentTable::GetVerboseLevel() const
0105 {
0106   return G4ParticleTable::GetParticleTable()->GetVerboseLevel();
0107 }
0108
0109 #endif