include/Geant4/G4INCLFinalState.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 // INCL++ intra-nuclear cascade model
0027 // Alain Boudard, CEA-Saclay, France
0028 // Joseph Cugnon, University of Liege, Belgium
0029 // Jean-Christophe David, CEA-Saclay, France
0030 // Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
0031 // Sylvie Leray, CEA-Saclay, France
0032 // Davide Mancusi, CEA-Saclay, France
0033 //
0034 #define INCLXX_IN_GEANT4_MODE 1
0035
0036 #include "globals.hh"
0037
0038 /*
0039  * G4INCLIChannel.h
0040  *
0041  *  \date Jun 5, 2009
0042  * \author Pekka Kaitaniemi
0043  */
0044
0045 #ifndef G4INCLFINALSTATE_H_
0046 #define G4INCLFINALSTATE_H_
0047
0048 #include "G4INCLParticle.hh"
0049 #include <string>
0050
0051 namespace G4INCL {
0052
0053   enum FinalStateValidity {
0054     ValidFS,
0055     PauliBlockedFS,
0056     NoEnergyConservationFS,
0057     ParticleBelowFermiFS,
0058     ParticleBelowZeroFS
0059   };
0060
0061   /**
0062    * Final state of an interaction
0063    */
0064   class FinalState {
0065   public:
0066     FinalState();
0067     virtual ~FinalState();
0068
0069     void reset();
0070
0071     void setTotalEnergyBeforeInteraction(G4double E) { totalEnergyBeforeInteraction = E; };
0072     G4double getTotalEnergyBeforeInteraction() const { return totalEnergyBeforeInteraction; };
0073
0074     void addModifiedParticle(Particle *p);
0075     void addOutgoingParticle(Particle *p);
0076     void addDestroyedParticle(Particle *p);
0077     void addCreatedParticle(Particle *p);
0078     void addEnteringParticle(Particle *p);
0079
0080     ParticleList const &getModifiedParticles() const;
0081     ParticleList const &getOutgoingParticles() const;
0082     ParticleList const &getDestroyedParticles() const;
0083     ParticleList const &getCreatedParticles() const;
0084     ParticleList const &getEnteringParticles() const;
0085
0086     FinalStateValidity getValidity() const { return validity; }
0087     void makeValid() { validity = ValidFS; }
0088     void makePauliBlocked() { validity = PauliBlockedFS; }
0089     void makeNoEnergyConservation() { validity = NoEnergyConservationFS; }
0090     void makeParticleBelowFermi() { validity = ParticleBelowFermiFS; }
0091     void makeParticleBelowZero() { validity = ParticleBelowZeroFS; }
0092
0093     std::string print() const;
0094
0095   private:
0096     ParticleList outgoing, created, destroyed, modified, entering;
0097     G4double totalEnergyBeforeInteraction;
0098     FinalStateValidity validity;
0099   };
0100
0101 }
0102
0103 #endif /* G4INCLFINALSTATE_H_ */