G4INCLStandardPropagationModel.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * 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.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// INCL++ intra-nuclear cascade model
// Pekka Kaitaniemi, CEA and Helsinki Institute of Physics
// Davide Mancusi, CEA
// Alain Boudard, CEA
// Sylvie Leray, CEA
// Joseph Cugnon, University of Liege
//
#define INCLXX_IN_GEANT4_MODE 1

#include "globals.hh"

/*
 * StandardPropagationModel.hh
 *
 *  \date 4 June 2009
 * \author Pekka Kaitaniemi
 */

#ifndef G4INCLStandardPropagationModel_hh
#define G4INCLStandardPropagationModel_hh 1

#include "G4INCLNucleus.hh"
#include "G4INCLIPropagationModel.hh"
#include "G4INCLIAvatar.hh"
#include "G4INCLConfigEnums.hh"

#include <iterator>

namespace G4INCL {

    class StandardPropagationModel: public G4INCL::IPropagationModel {
    public:
      StandardPropagationModel(LocalEnergyType localEnergyType, LocalEnergyType localEnergyDeltaType);
      virtual ~StandardPropagationModel();

      G4double getCurrentTime();
      void setNucleus(G4INCL::Nucleus *nucleus);

      G4INCL::Nucleus* getNucleus();

      G4double shoot(ParticleSpecies const projectileSpecies, const G4double kineticEnergy, const G4double impactParameter, const G4double phi);
      G4double shootParticle(ParticleType const t, const G4double kineticEnergy, const G4double impactParameter, const G4double phi);
      G4double shootComposite(ParticleSpecies const s, const G4double kineticEnergy, const G4double impactParameter, const G4double phi);

      void setStoppingTime(G4double);

      G4double getStoppingTime();

      void registerAvatar(G4INCL::IAvatar *anAvatar);

      IAvatar *generateBinaryCollisionAvatar(Particle * const p1, Particle * const p2) const;

      G4double getReflectionTime(G4INCL::Particle const * const aParticle);

      G4double getTime(G4INCL::Particle const * const particleA,
             G4INCL::Particle const * const particleB, G4double *minDistOfApproach) const;

      void generateUpdatedCollisions(const ParticleList &updatedParticles, const ParticleList &particles);

      void generateCollisions(const ParticleList &particles, const ParticleList &except);

      void generateDecays(const ParticleList &particles);

      void updateAvatars(const ParticleList &particles);

      void generateAllAvatars(G4bool excludeUpdated=false);

      G4INCL::IAvatar* propagate();

    private:
      G4INCL::Nucleus *theNucleus;
      G4double maximumTime;
      G4double currentTime;
      G4bool firstAvatar;
      LocalEnergyType theLocalEnergyType, theLocalEnergyDeltaType;

      void putSpectatorsOnShell(IAvatarList const &entryAvatars, ParticleList const &spectators);
    };

}


#endif