include/Geant4/G4INCLPauliBlocking.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 G4INCLPauliBlocking__hh
0039 #define G4INCLPauliBlocking__hh 1
0040
0041 #include "G4INCLIPauli.hh"
0042 #include "G4INCLParticle.hh"
0043 #include "G4INCLNucleus.hh"
0044 #include "G4INCLConfig.hh"
0045
0046 namespace G4INCL {
0047
0048   /// \brief Pauli blocking
0049   namespace Pauli {
0050
0051     /** \brief Check Pauli blocking.
0052      *
0053      * Note: This is a "pure" function: it doesn't retain or modify
0054      * any state at all and thus only depends on its arguments.
0055      *
0056      * \param p list of modified and created particles
0057      * \param n the nucleus
0058      */
0059     G4bool isBlocked(ParticleList const &p, Nucleus const * const n);
0060
0061     /** \brief Check CDPP blocking.
0062      *
0063      * Note: This is a "pure" function: it doesn't retain or modify
0064      * any state at all and thus only depends on its arguments.
0065      *
0066      * \param p list of created particles
0067      * \param n the nucleus
0068      */
0069     G4bool isCDPPBlocked(ParticleList const &p, Nucleus const * const n);
0070
0071     /// \brief Get the Pauli blocker algorithm.
0072     IPauli * getBlocker();
0073
0074     /// \brief Get the CDPP blocker algorithm.
0075     IPauli * getCDPP();
0076
0077     /// \brief Set the Pauli blocker algorithm.
0078     void setBlocker(IPauli * const);
0079
0080     /// \brief Set the CDPP blocker algorithm.
0081     void setCDPP(IPauli * const);
0082
0083     /// \brief Delete blockers
0084     void deleteBlockers();
0085
0086     /// \brief Initialise blockers according to a Config object
0087     void initialize(Config const * const aConfig);
0088
0089   }
0090
0091 }
0092
0093 #endif