include/Geant4/G4INCLCascadeAction.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 G4INCLCascadeAction.hh
0039  * \brief Class containing default actions to be performed at intermediate cascade steps
0040  *
0041  * \date 22nd October 2013
0042  * \author Davide Mancusi
0043  */
0044
0045 #ifndef G4INCLCASCADEACTION_HH
0046 #define G4INCLCASCADEACTION_HH 1
0047
0048 #include "G4INCLIAvatar.hh"
0049 #include "G4INCLNucleus.hh"
0050 #include "G4INCLFinalState.hh"
0051 #include "G4INCLIPropagationModel.hh"
0052 #include "G4INCLIAvatar.hh"
0053 #include "G4INCLConfig.hh"
0054
0055 namespace G4INCL {
0056
0057   class CascadeAction {
0058     // class INCL must be a friend because it needs to call private methods
0059     friend class INCL;
0060
0061     public:
0062     CascadeAction();
0063     virtual ~CascadeAction();
0064
0065     virtual void beforeRunUserAction(Config const *) {}
0066     virtual void beforeCascadeUserAction(IPropagationModel *) {}
0067     virtual void beforePropagationUserAction(IPropagationModel *) {}
0068     virtual void beforeAvatarUserAction(IAvatar *, Nucleus *) {}
0069     virtual void afterAvatarUserAction(IAvatar *, Nucleus *, FinalState *) {}
0070     virtual void afterPropagationUserAction(IPropagationModel *, IAvatar *) {}
0071     virtual void afterCascadeUserAction(Nucleus *) {}
0072     virtual void afterRunUserAction() {}
0073
0074     private:
0075     // These four methods should be private because the user must not be
0076     // allowed to override them
0077     void beforeRunAction(Config const *config);
0078     void beforeCascadeAction(IPropagationModel *);
0079     void beforePropagationAction(IPropagationModel *pm);
0080     void beforeAvatarAction(IAvatar *a, Nucleus *n);
0081     void afterAvatarAction(IAvatar *a, Nucleus *n, FinalState *fs);
0082     void afterPropagationAction(IPropagationModel *pm, IAvatar *avatar);
0083     void afterCascadeAction(Nucleus *);
0084     void afterRunAction();
0085
0086     void beforeRunDefaultAction(Config const *config);
0087     void beforeCascadeDefaultAction(IPropagationModel *pm);
0088     void beforePropagationDefaultAction(IPropagationModel *pm);
0089     void beforeAvatarDefaultAction(IAvatar *a, Nucleus *n);
0090     void afterAvatarDefaultAction(IAvatar *a, Nucleus *n, FinalState *fs);
0091     void afterPropagationDefaultAction(IPropagationModel *pm, IAvatar *avatar);
0092     void afterCascadeDefaultAction(Nucleus *);
0093     void afterRunDefaultAction();
0094
0095     private: // data members
0096     long stepCounter;
0097   };
0098
0099 }
0100 #endif // G4INCLCASCADEACTION_HH