include/Geant4/G4INCLClustering.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 /** \file G4INCLClustering.hh
0039  * \brief Static class for cluster formation
0040  *
0041  * \date 13th July 2011
0042  * \author Davide Mancusi
0043  */
0044
0045 #ifndef G4INCLCLUSTERING_HH
0046 #define G4INCLCLUSTERING_HH
0047
0048 #include "G4INCLIClusteringModel.hh"
0049 #include "G4INCLParticle.hh"
0050 #include "G4INCLNucleus.hh"
0051
0052 namespace G4INCL {
0053
0054   /// \brief Cluster formation
0055   namespace Clustering {
0056     /** \brief Call the clustering algorithm
0057      *
0058      * Choose a cluster candidate to be produced. At this point we
0059      * don't yet decide if it can pass through the Coulomb barrier or
0060      * not.
0061      */
0062     Cluster* getCluster(Nucleus *n, Particle *p);
0063
0064     /// \brief Determine whether the cluster can escape or not
0065     G4bool clusterCanEscape(Nucleus const * const n, Cluster const * const c);
0066
0067     /// \brief Get the clustering model
0068     IClusteringModel *getClusteringModel();
0069
0070     /// \brief Set the clustering model
0071     void setClusteringModel(IClusteringModel * const model);
0072
0073     /// \brief Delete the clustering model
0074     void deleteClusteringModel();
0075
0076     /// \brief Initialize the clustering model based on the Config object
0077     void initialize(Config const * const theConfig);
0078
0079   }
0080 }
0081
0082 #endif