include/Geant4/G4DNAIons.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 // 31.07.2013: Derived from G4Ions for MT migration (SI)
0027 // Suggested by Makoto et al.
0028
0029 #ifndef G4DNAIons_h
0030 #define G4DNAIons_h 1
0031
0032 #include "globals.hh"
0033 #include "G4ios.hh"
0034 #include "G4ParticleDefinition.hh"
0035
0036 // ######################################################################
0037 // ###                          G4DNAIons                                 ###
0038 // ######################################################################
0039
0040 class G4DNAIons : public G4ParticleDefinition
0041 {
0042  // Class Description
0043  //  This is the base class for all Geant4-DNA nuclei, including
0044  //  charged states
0045
0046  protected:
0047    G4DNAIons(){};
0048
0049
0050  public:
0051    G4DNAIons(
0052        const G4String&     aName,        G4double            mass,
0053        G4double            width,        G4double            charge,
0054        G4int               iSpin,        G4int               iParity,
0055        G4int               iConjugation, G4int               iIsospin,
0056        G4int               iIsospin3,    G4int               gParity,
0057        const G4String&     pType,        G4int               lepton,
0058        G4int               baryon,       G4int               encoding,
0059        G4bool              stable,       G4double            lifetime,
0060        G4DecayTable        *decaytable,  G4bool              shortlived,
0061        const G4String&     subType ="",
0062        G4int               anti_encoding =0,
0063        G4double            excitation = 0.0,
0064        G4int               isomer = 0
0065    );
0066
0067  public:
0068                 ~G4DNAIons() override;
0069    G4DNAIons*           IonsDefinition();
0070    G4DNAIons*           Ions();
0071
0072  public:
0073
0074   // Get excitation energy of nucleus
0075   G4double GetExcitationEnergy() const ;
0076
0077   // Get Isomer level (=0 for ground state)
0078   G4int GetIsomerLevel() const;
0079
0080   private:
0081   G4double theExcitationEnergy;
0082   G4int    theIsomerLevel;
0083
0084 };
0085
0086 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0087
0088 inline
0089  G4DNAIons* G4DNAIons::IonsDefinition()
0090 {
0091   return this;
0092 }
0093
0094 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0095
0096 inline
0097  G4DNAIons* G4DNAIons::Ions()
0098 {
0099   return this;
0100 }
0101
0102 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0103
0104 inline
0105  G4double G4DNAIons::GetExcitationEnergy() const
0106 {
0107   return theExcitationEnergy;
0108 }
0109
0110 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0111
0112 inline
0113  G4int G4DNAIons::GetIsomerLevel() const
0114 {
0115   return theIsomerLevel;
0116 }
0117
0118 #endif
0119
0120
0121
0122
0123
0124
0125
0126