include/Geant4/G4INCLIClusteringModel.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 #ifndef G4INCLIClusteringModel_hh
0039 #define G4INCLIClusteringModel_hh 1
0040
0041 #include "G4INCLParticle.hh"
0042 #include "G4INCLCluster.hh"
0043 #include "G4INCLNucleus.hh"
0044
0045 namespace G4INCL {
0046
0047   /**
0048    * An abstract interface to cluster formation model(s).
0049    */
0050   class IClusteringModel {
0051   public:
0052     IClusteringModel() {};
0053     virtual ~IClusteringModel() {};
0054
0055     /**
0056      * Choose a cluster candidate to be produced. At this point we
0057      * don't yet decide if it can pass through the Coulomb barrier or
0058      * not.
0059      */
0060     virtual Cluster* getCluster(Nucleus*, Particle*) = 0;
0061
0062     /**
0063      * Determine whether cluster can escape or not.
0064      */
0065     virtual G4bool clusterCanEscape(Nucleus const * const, Cluster const * const) = 0;
0066   };
0067
0068 }
0069
0070 #endif