chem4/include/ScoreSpecies.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 ScoreSpecies.hh
0027 /// \brief Definition of the ScoreSpecies class
0028
0029 // This example is provided by the Geant4-DNA collaboration
0030 // Any report or published results obtained using the Geant4-DNA software
0031 // shall cite the following Geant4-DNA collaboration publication:
0032 // Med. Phys. 37 (2010) 4692-4708
0033 // J. Comput. Phys. 274 (2014) 841-882
0034 // The Geant4-DNA web site is available at http://geant4-dna.org
0035 //
0036 //
0037 #ifndef CHEM4_ScoreSpecies_h
0038 #define CHEM4_ScoreSpecies_h 1
0039
0040 #include "G4THitsMap.hh"
0041 #include "G4VPrimitiveScorer.hh"
0042
0043 #include <set>
0044
0045 class G4VAnalysisManager;
0046 class G4MolecularConfiguration;
0047
0048 // #define _ScoreSpecies_FOR_ALL_EVENTS
0049
0050 /** \file ScoreSpecies.hh*/
0051
0052 // Description:
0053 //   This is a primitive scorer class for scoring the radiolitic species
0054 // produced after irradiation in a water volume
0055 //
0056 // Created: 2015-10-27  by M. Karamitros,
0057 // modified: 2016-03-16 by P. Piersimoni
0058
0059 class ScoreSpecies : public G4VPrimitiveScorer
0060 {
0061   public:
0062     ScoreSpecies(G4String name, G4int depth = 0);
0063
0064     virtual ~ScoreSpecies();
0065
0066     /** Add a time at which the number of species should be recorded.
0067         Default times are set up to 1 microsecond.*/
0068     inline void AddTimeToRecord(double time) { fTimeToRecord.insert(time); }
0069
0070     /**  Remove all times to record, must be reset by user.*/
0071     inline void ClearTimeToRecord() { fTimeToRecord.clear(); }
0072
0073     /** Get number of recorded events*/
0074     inline int GetNumberOfRecordedEvents() const { return fNEvent; }
0075
0076     /** Write results to an text file*/
0077     void ASCII();
0078
0079     /** Write results to whatever chosen file format*/
0080     void WriteWithAnalysisManager(G4VAnalysisManager*);
0081
0082     struct SpeciesInfo
0083     {
0084         SpeciesInfo()
0085         {
0086           fNumber = 0;
0087           fG = 0.;
0088           fG2 = 0.;
0089         }
0090         SpeciesInfo(const SpeciesInfo& right)  // Species A(B);
0091         {
0092           fNumber = right.fNumber;
0093           fG = right.fG;
0094           fG2 = right.fG2;
0095         }
0096         SpeciesInfo& operator=(const SpeciesInfo& right)  // A = B
0097         {
0098           if (&right == this) return *this;
0099           fNumber = right.fNumber;
0100           fG = right.fG;
0101           fG2 = right.fG2;
0102           return *this;
0103         }
0104         int fNumber;
0105         double fG;
0106         double fG2;
0107     };
0108
0109 #ifdef _ScoreSpecies_FOR_ALL_EVENTS
0110     struct SpeciesInfoSOA
0111     {
0112         SpeciesInfoSOA()
0113         {
0114           // fNumber = 0;
0115           // fG = 0.;
0116           // fG2 = 0.;
0117         }
0118         SpeciesInfoSOA(const SpeciesInfoSOA& right)  // Species A(B);
0119         {
0120           fNumber = right.fNumber;
0121           fG = right.fG;
0122           fG2 = right.fG2;
0123           fEventID = right.fEventID;
0124         }
0125         SpeciesInfoSOA& operator=(const SpeciesInfoSOA& right)  // A = B
0126         {
0127           if (&right == this) return *this;
0128           fNumber = right.fNumber;
0129           fG = right.fG;
0130           fG2 = right.fG2;
0131           fEventID = right.fEventID;
0132           return *this;
0133         }
0134         std::vector<int> fNumber;
0135         std::vector<double> fG;
0136         std::vector<double> fG2;
0137         std::vector<int> fEventID;
0138     };
0139 #endif
0140
0141   private:
0142     typedef const G4MolecularConfiguration Species;
0143     typedef std::map<Species*, SpeciesInfo> InnerSpeciesMap;
0144     typedef std::map<double, InnerSpeciesMap> SpeciesMap;
0145     SpeciesMap fSpeciesInfoPerTime;
0146
0147 #ifdef _ScoreSpecies_FOR_ALL_EVENTS
0148     typedef std::map<Species, SpeciesInfoSOA> InnerSpeciesMapPerEvent;
0149     typedef std::map<double, InnerSpeciesMapPerEvent> SpeciesMapPerEvent;
0150     SpeciesMapPerEvent fSpeciesInfoPerEvent;
0151 #endif
0152
0153     std::set<G4double> fTimeToRecord;
0154
0155     int fNEvent;  // number of processed events
0156     double fEdep;  // total energy deposition
0157     G4String fOutputType;  // output type
0158
0159   protected:
0160     virtual G4bool ProcessHits(G4Step*, G4TouchableHistory*);
0161
0162   public:
0163     virtual void Initialize(G4HCofThisEvent*);
0164     virtual void EndOfEvent(G4HCofThisEvent*);
0165     virtual void DrawAll();
0166     virtual void PrintAll();
0167     /** Method used in multithreading mode in order to merge
0168         the results*/
0169     virtual void AbsorbResultsFromWorkerScorer(G4VPrimitiveScorer*);
0170     virtual void OutputAndClear();
0171
0172     SpeciesMap GetSpeciesInfo() { return fSpeciesInfoPerTime; }
0173
0174   private:
0175     G4int fHCID;
0176     G4THitsMap<G4double>* fEvtMap;
0177 };
0178 #endif