include/Geant4/G4PhononTrackMap.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 /// \file processes/phonon/include/G4PhononTrackMap.hh
0027 /// \brief Definition of the G4PhononTrackMap base class
0028 //
0029 //
0030 // 20131111  Move implementation of Clear() to .cc file
0031
0032 #ifndef G4PhononTrackMap_h
0033 #define G4PhononTrackMap_h 1
0034
0035 #include "G4ThreeVector.hh"
0036 #include <map>
0037
0038 class G4Track;
0039
0040 class G4PhononTrackMap {
0041 public:
0042   typedef std::map<const G4Track*, G4ThreeVector> TrkIDKmap;
0043   static G4ThreadLocal G4PhononTrackMap* theTrackMap;
0044
0045 public:
0046   static G4PhononTrackMap* GetPhononTrackMap(); // Synonyms for access
0047   static G4PhononTrackMap* GetInstance() { return GetPhononTrackMap(); }
0048
0049   // Update the wavevector for specified track, add track if not found
0050   void SetK(const G4Track* track, const G4ThreeVector& K);
0051   void SetK(const G4Track& track, const G4ThreeVector& K) { SetK(&track, K); }
0052
0053   // Access current wavevector for specified track (NULL if doesn't exist)
0054   const G4ThreeVector& GetK(const G4Track* track) const;
0055   const G4ThreeVector& GetK(const G4Track& track) const { return GetK(&track); }
0056
0057   // Check if specified track is already loaded
0058   G4bool Find(const G4Track* track) const;
0059   G4bool Find(const G4Track& track) const { return Find(&track); }
0060
0061   // Remove specified track from map (used by EndTracking)
0062   void RemoveTrack(const G4Track* track);
0063
0064   void Clear();         // Remove all entries from map
0065
0066 private:
0067   TrkIDKmap theMap;     // Associate track ID numbers with vectors
0068
0069 private:
0070   G4PhononTrackMap() { Clear(); }       // Ensure map is empty
0071   ~G4PhononTrackMap() {;}
0072 };
0073 #endif  /* G4PhononTrackMap_h */