G4AdjointIons.hh

Go to the documentation of this file.
00001 //
00002 // ********************************************************************
00003 // * License and Disclaimer                                           *
00004 // *                                                                  *
00005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
00006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
00007 // * conditions of the Geant4 Software License,  included in the file *
00008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
00009 // * include a list of copyright holders.                             *
00010 // *                                                                  *
00011 // * Neither the authors of this software system, nor their employing *
00012 // * institutes,nor the agencies providing financial support for this *
00013 // * work  make  any representation or  warranty, express or implied, *
00014 // * regarding  this  software system or assume any liability for its *
00015 // * use.  Please see the license in the file  LICENSE  and URL above *
00016 // * for the full disclaimer and the limitation of liability.         *
00017 // *                                                                  *
00018 // * This  code  implementation is the result of  the  scientific and *
00019 // * technical work of the GEANT4 collaboration.                      *
00020 // * By using,  copying,  modifying or  distributing the software (or *
00021 // * any work based  on the software)  you  agree  to acknowledge its *
00022 // * use  in  resulting  scientific  publications,  and indicate your *
00023 // * acceptance of all terms of the Geant4 Software license.          *
00024 // ********************************************************************
00025 //
00026 // $Id$
00027 //
00028 // ------------------------------------------------------------
00029 //      GEANT 4 class header file
00030 //
00031 //      History: 
00032 //              1 July 2009 creation by L. Desorgher based on a modification of G4Ions          
00033 //
00034 //-------------------------------------------------------------
00035 //      Documentation:
00036 //              Adjoint particles are used in Reverse/Adjoint Monte Carlo simulations. New adjoint 
00037 //              processes act on adjoint particles when they are  tracked backward in the geometry. 
00038 //              The use of adjoint particles instead of "normal" particles during a reverse simulation 
00039 //              is based on an idea of M. Asai.   
00040 //
00041 
00042 #ifndef G4AdjointIons_h
00043 #define G4AdjointIons_h 1
00044 
00045 #include "globals.hh"
00046 #include "G4ios.hh"
00047 #include "G4ParticleDefinition.hh"
00048 
00049 // ######################################################################
00050 // ###                     ADJOINT Ions                               ###
00051 // ######################################################################
00052 
00053 class G4AdjointIons : public G4ParticleDefinition
00054 {
00055  // Class Description
00056  //  This is the base class for all nuclei including pre-defined 
00057  //  light nuclei such as deuteron, alpha, and proton (Hydrogen) 
00058  //  All nuclei/ions created on the fly are objects of this class
00059  //  Atomic number and atomic mass are vaild only for particles derived
00060  //  from this class.  This class has Excitation Energy in addition to
00061  //  the normal particle properties.
00062 
00063  protected:
00064    G4AdjointIons(){};
00065 
00066 
00067  public: //With Description
00068    G4AdjointIons(
00069        const G4String&     aName,        G4double            mass,
00070        G4double            width,        G4double            charge,   
00071        G4int               iSpin,        G4int               iParity,    
00072        G4int               iConjugation, G4int               iIsospin,   
00073        G4int               iIsospin3,    G4int               gParity,
00074        const G4String&     pType,        G4int               lepton,      
00075        G4int               baryon,       G4int               encoding,
00076        G4bool              stable,       G4double            lifetime,
00077        G4DecayTable        *decaytable,  G4bool              shortlived,
00078        const G4String&     subType ="",
00079        G4int               anti_encoding =0,
00080        G4double            excitation = 0.0
00081    );
00082 
00083  public:
00084    virtual                      ~G4AdjointIons();
00085    G4AdjointIons*                       IonsDefinition();
00086    G4AdjointIons*                       Ions();
00087 
00088  public:  //With Description
00089    // Get excitation energy of nucleus
00090    G4double GetExcitationEnergy() const ; 
00091   
00092   private:
00093    G4double theExcitationEnergy; 
00094 
00095 };
00096 
00097 inline
00098  G4AdjointIons* G4AdjointIons::Ions() 
00099 {
00100   return this;
00101 }
00102 
00103 inline
00104  G4double G4AdjointIons::GetExcitationEnergy() const 
00105 {
00106   return theExcitationEnergy;
00107 }
00108 
00109 #endif
00110 
00111 
00112 
00113 
00114 
00115 
00116 
00117 

Generated on Mon May 27 17:47:37 2013 for Geant4 by  doxygen 1.4.7