Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/biasing/generic/include/G4BiasingProcessSharedData.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 // G4BiasingProcessSharedData
 27 //
 28 // Class Description:
 29 //
 30 // This class represents the data that the G4BiasingProcessInterface
 31 // objects attached to a same particle / hold by a same G4ProcessManager
 32 // share. It allows the active G4BiasingProcessInterface objects to share
 33 // information on operations that are common the these instances:
 34 //   - the current and previous G4VBiasingOperator objects (their
 35 //     pointers are collected once, at the beginning of the PostStepGPIL
 36 //     by the first interface invoked)
 37 //   - add the list of cooperating G4BiasingProcessInterface objects,
 38 //     acting on a same particle type.
 39 // G4BiasingProcessInterface is friend class of this one.
 40 //
 41 // Author: Marc Verderi, September 2014.
 42 // --------------------------------------------------------------------
 43 #ifndef G4BiasingProcessSharedData_h
 44 #define G4BiasingProcessSharedData_h 1
 45 
 46 #include "globals.hh"
 47 #include "G4Cache.hh"
 48 
 49 #include <vector>
 50 
 51 class G4VBiasingOperator;
 52 class G4BiasingProcessInterface;
 53 class G4ProcessManager;
 54 class G4ParallelGeometriesLimiterProcess;
 55 
 56 class G4BiasingProcessSharedData
 57 {
 58   friend class G4BiasingProcessInterface;
 59   friend class G4ParallelGeometriesLimiterProcess;
 60 
 61   public:
 62 
 63     // -------------------------
 64     // -- Public access methods:
 65     // -------------------------
 66     // -- The biasing process interface objects sharing this shared data class:
 67     const std::vector< const G4BiasingProcessInterface* >& GetBiasingProcessInterfaces() const
 68       { return fPublicBiasingProcessInterfaces; }
 69     const std::vector< const G4BiasingProcessInterface* >& GetPhysicsBiasingProcessInterfaces() const
 70       { return fPublicPhysicsBiasingProcessInterfaces; }
 71     const std::vector< const G4BiasingProcessInterface* >& GetNonPhysicsBiasingProcessInterfaces() const
 72       { return fPublicNonPhysicsBiasingProcessInterfaces; }
 73   
 74     // -- The possible geometry limiter process:
 75     const G4ParallelGeometriesLimiterProcess* GetParallelGeometriesLimiterProcess() const
 76       { return fParallelGeometriesLimiterProcess; }
 77 
 78   private:
 79 
 80     // -- Methods used by the G4BiasingProcessInterface objects.
 81     // -- Object is created by G4BiasingProcessInterface object:
 82     G4BiasingProcessSharedData( const G4ProcessManager* mgr)
 83       : fProcessManager(mgr) {}
 84     ~G4BiasingProcessSharedData() {}
 85 
 86     // -- biasing operators:
 87     void CurrentBiasingOperator( G4VBiasingOperator* );
 88     G4VBiasingOperator* CurrentBiasingOperator() const;
 89     void PreviousBiasingOperator( G4VBiasingOperator* );
 90     G4VBiasingOperator* PreviousBiasingOperator() const;
 91 
 92   private:
 93 
 94     const G4ProcessManager* fProcessManager;
 95     // -- biasing operators:
 96     G4VBiasingOperator* fCurrentBiasingOperator = nullptr;
 97     G4VBiasingOperator* fPreviousBiasingOperator = nullptr;
 98     G4VBiasingOperator* fParallelGeometryOperator = nullptr;
 99     G4VBiasingOperator* fMassGeometryOperator = nullptr;
100     // -- 
101     G4bool fIsNewOperator = true;
102     G4bool fLeavingPreviousOperator = false;
103 
104     // -- biasing process interfaces sharing this object:
105     std::vector < G4BiasingProcessInterface* > fBiasingProcessInterfaces;
106     std::vector < G4BiasingProcessInterface* > fPhysicsBiasingProcessInterfaces;
107     std::vector < G4BiasingProcessInterface* > fNonPhysicsBiasingProcessInterfaces;
108     // -- the same ones, for public use:
109     std::vector < const G4BiasingProcessInterface* > fPublicBiasingProcessInterfaces;
110     std::vector < const G4BiasingProcessInterface* > fPublicPhysicsBiasingProcessInterfaces;
111     std::vector < const G4BiasingProcessInterface* > fPublicNonPhysicsBiasingProcessInterfaces;
112 
113     // -- possible process limiting step on parallel geometries:
114     G4ParallelGeometriesLimiterProcess* fParallelGeometriesLimiterProcess = nullptr;
115   
116     // -- thread local:
117     // -- Map between process managers and shared data. This map is made of
118     // -- pointers of G4BiasingSharedData instead of objects themselves :
119     // -- each process needs to keep a valid pointer of a shared data object
120     // -- but a map of object will make pointers invalid when map is increased.
121     static G4MapCache< const G4ProcessManager*, G4BiasingProcessSharedData* > fSharedDataMap;
122 };
123 
124 #endif
125