G4INCLInteractionAvatar.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4INCLInteractionAvatar.hh

//
// ********************************************************************
// * 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
// Alain Boudard, CEA-Saclay, France
// Joseph Cugnon, University of Liege, Belgium
// Jean-Christophe David, CEA-Saclay, France
// Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
// Sylvie Leray, CEA-Saclay, France
// Davide Mancusi, CEA-Saclay, France
//
#define INCLXX_IN_GEANT4_MODE 1

#include "globals.hh"

/* \file G4INCLInteractionAvatar.hh
 * \brief Virtual class for interaction avatars.
 *
 * This class is inherited by decay and collision avatars. The goal is to
 * provide a uniform treatment of common physics, such as Pauli blocking,
 * enforcement of energy conservation, etc.
 *
 *  \date Mar 1st, 2011
 * \author Davide Mancusi
 */

#ifndef G4INCLINTERACTIONAVATAR_HH_
#define G4INCLINTERACTIONAVATAR_HH_

#include "G4INCLIAvatar.hh"
#include "G4INCLNucleus.hh"
#include "G4INCLFinalState.hh"
#include "G4INCLRootFinder.hh"
#include "G4INCLKinematicsUtils.hh"
#include "G4INCLAllocationPool.hh"

namespace G4INCL {

  class InteractionAvatar : public G4INCL::IAvatar {
    public:
      InteractionAvatar(G4double, G4INCL::Nucleus*, G4INCL::Particle*);
      InteractionAvatar(G4double, G4INCL::Nucleus*, G4INCL::Particle*, G4INCL::Particle*);
      virtual ~InteractionAvatar();

      static const G4double locEAccuracy;
      static const G4int maxIterLocE;

      static void deleteBackupParticles();

    protected:
      virtual G4INCL::IChannel* getChannel() = 0;

      G4bool bringParticleInside(Particle * const p);

      void preInteractionLocalEnergy(Particle * const p);

      void preInteractionBlocking();

      void preInteraction();
      void postInteraction(FinalState *);

      void restoreParticles() const;

      G4bool shouldUseLocalEnergy() const;

      Nucleus *theNucleus;
      Particle *particle1, *particle2;
      static G4ThreadLocal Particle *backupParticle1, *backupParticle2;
      ThreeVector boostVector;
      G4double oldTotalEnergy, oldXSec;
      G4bool isPiN;
      G4double weight;

    private:
      class ViolationEMomentumFunctor : public RootFunctor {
        public:
          ViolationEMomentumFunctor(Nucleus * const nucleus, ParticleList const &modAndCre, const G4double totalEnergyBeforeInteraction, ThreeVector const &boost, const G4bool localE);
          virtual ~ViolationEMomentumFunctor();

          G4double operator()(const G4double x) const;

          void cleanUp(const G4bool success) const;

        private:
          ParticleList finalParticles;
          std::vector<ThreeVector> particleMomenta;
          G4double initialEnergy;
          Nucleus *theNucleus;
          ThreeVector const &boostVector;

          const G4bool shouldUseLocalEnergy;

          void scaleParticleMomenta(const G4double alpha) const;

      };

      class ViolationEEnergyFunctor : public RootFunctor {
        public:
          ViolationEEnergyFunctor(Nucleus * const nucleus, Particle * const aParticle, const G4double totalEnergyBeforeInteraction, const G4bool localE);
          virtual ~ViolationEEnergyFunctor() {}

          G4double operator()(const G4double x) const;

          void cleanUp(const G4bool success) const;

          void setParticleEnergy(const G4double energy) const;

        private:
          G4double initialEnergy;
          Nucleus *theNucleus;
          Particle *theParticle;
          G4double theEnergy;
          ThreeVector theMomentum;
          G4double energyThreshold;
          const G4bool shouldUseLocalEnergy;
      };

      RootFunctor *violationEFunctor;

    protected:
      G4bool enforceEnergyConservation(FinalState * const fs);

      ParticleList modified, created, modifiedAndCreated, Destroyed, ModifiedAndDestroyed;

      INCL_DECLARE_ALLOCATION_POOL(InteractionAvatar)
  };

}

#endif /* G4INCLINTERACTIONAVATAR_HH_ */