include/Geant4/G4AdjointStackingAction.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 // G4AdjointStackingAction
0027 //
0028 // Class description:
0029 //
0030 // Stacking action used in the adjoint simulation. It is responsible to kill
0031 // a primary forward particle before it is traked in the forward phase,
0032 // if the last adjoint particle did not reach the adjoint surface.
0033 // Was needed for the new design where the G4AdjointSimManager is no more an
0034 // extension of G4RunManager. If the primary particles are not killed before
0035 // being tracked in the sensitive geometry, the User Stacking action can be
0036 // used during the forward phase if specified by the method
0037 // G4AdjointSimManager::UseUserStackingAction(G4bool).
0038
0039 // Author: L. Desorgher, SpaceIT GmbH - April 2008
0040 // Contract: ESA contract 21435/08/NL/AT
0041 // Customer: ESA/ESTEC
0042 // --------------------------------------------------------------------
0043 #ifndef G4AdjointStackingAction_hh
0044 #define G4AdjointStackingAction_hh 1
0045
0046 #include "globals.hh"
0047 #include "G4UserStackingAction.hh"
0048
0049 class G4Track;
0050 class G4ParticleDefinition;
0051 class G4AdjointTrackingAction;
0052
0053 class G4AdjointStackingAction : public G4UserStackingAction
0054 {
0055   public:
0056
0057     explicit G4AdjointStackingAction(G4AdjointTrackingAction* anAction);
0058     ~G4AdjointStackingAction() override = default;
0059
0060     G4ClassificationOfNewTrack ClassifyNewTrack(const G4Track* aTrack) override;
0061     void NewStage() override;
0062     void PrepareNewEvent() override;
0063     inline void SetUserFwdStackingAction(G4UserStackingAction* anAction)
0064       { theFwdStackingAction = anAction; }
0065     inline void SetUserAdjointStackingAction(G4UserStackingAction* anAction)
0066       { theUserAdjointStackingAction = anAction; }
0067     inline void SetKillTracks(G4bool aBool)
0068       { kill_tracks =aBool; }
0069     inline void SetAdjointMode(G4bool aBool)
0070       { adjoint_mode=aBool; }
0071
0072   private:
0073
0074     G4UserStackingAction* theFwdStackingAction = nullptr;
0075     G4UserStackingAction* theUserAdjointStackingAction = nullptr;
0076     G4bool reclassification_stage = false;
0077     G4bool first_reclassification_stage = false;
0078     G4bool kill_tracks = false;
0079     G4bool adjoint_mode = false;
0080     G4AdjointTrackingAction* theAdjointTrackingAction = nullptr;
0081 };
0082
0083 #endif
0084