dnadamage2/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 // This example is provided by the Geant4-DNA collaboration
0027 // dnadamage3 example is derived from the chem6 example
0028 // chem6 example authors: W. G. Shin and S. Incerti (CENBG, France)
0029 //
0030 // Any report or published results obtained using the Geant4-DNA software
0031 // shall cite the following Geant4-DNA collaboration publication:
0032 // J. Appl. Phys. 125 (2019) 104301
0033 // Med. Phys. 45 (2018) e722-e739
0034 // J. Comput. Phys. 274 (2014) 841-882
0035 // Med. Phys. 37 (2010) 4692-4708
0036 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157-178
0037 // The Geant4-DNA web site is available at http://geant4-dna.org
0038 //
0039 //
0040 /// \file ScoreSpecies.hh
0041 /// \brief Definition of the ScoreSpecies class
0042 // Description:
0043 //   This is a primitive scorer class for scoring the radiolitic species
0044 // produced after irradiation in a water volume
0045 //
0046 // Created: 2015-10-27  by M. Karamitros,
0047 // modified: 2016-03-16 by P. Piersimoni
0048 // modified: 2022-01-2022 by J. Naoki D. Kondo
0049
0050 #ifndef DNADAMAGE2_ScoreSpecies_h
0051 #define DNADAMAGE2_ScoreSpecies_h 1
0052
0053 #include "G4THitsMap.hh"
0054 #include "G4UIcmdWithADoubleAndUnit.hh"
0055 #include "G4UIcmdWithAString.hh"
0056 #include "G4UIcmdWithAnInteger.hh"
0057 #include "G4UImessenger.hh"
0058 #include "G4VPrimitiveScorer.hh"
0059
0060 #include <set>
0061
0062 class G4VAnalysisManager;
0063 class G4MolecularConfiguration;
0064
0065 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0066
0067 class ScoreSpecies : public G4VPrimitiveScorer, public G4UImessenger
0068 {
0069   public:
0070     ScoreSpecies(G4String name, G4int depth = 0);
0071     ~ScoreSpecies() override;
0072
0073     /** Add a time at which the number of species should be recorded.
0074         Default times are set up to 1 microsecond.*/
0075     inline void AddTimeToRecord(double time) { fTimeToRecord.insert(time); }
0076
0077     /**  Remove all times to record, must be reset by user.*/
0078     inline void ClearTimeToRecord() { fTimeToRecord.clear(); }
0079
0080     /** Get number of recorded events*/
0081     inline int GetNumberOfRecordedEvents() const { return fNEvent; }
0082
0083     /** Write results to whatever chosen file format*/
0084     void WriteWithAnalysisManager(G4VAnalysisManager*);
0085
0086     struct SpeciesInfo
0087     {
0088         SpeciesInfo() {}
0089         SpeciesInfo(const SpeciesInfo& right)  // Species A(B);
0090         {
0091           fNumber = right.fNumber;
0092           fNumber2 = right.fNumber2;
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           fNumber2 = right.fNumber2;
0100           fNumber = right.fNumber;
0101           fG = right.fG;
0102           fG2 = right.fG2;
0103           return *this;
0104         }
0105         int fNumber = 0;
0106         int fNumber2 = 0;
0107         double fG = 0;
0108         double fG2 = 0;
0109     };
0110
0111   private:
0112     typedef const G4MolecularConfiguration Species;
0113     typedef std::map<Species*, SpeciesInfo> InnerSpeciesMap;
0114     typedef std::map<double, InnerSpeciesMap> SpeciesMap;
0115     SpeciesMap fSpeciesInfoPerTime;
0116
0117     std::set<G4double> fTimeToRecord;
0118
0119     int fNEvent = 0;  // number of processed events
0120     double fEdep = 0;  // total energy deposition
0121     G4String fOutputType;  // output type
0122
0123   protected:
0124     G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0125
0126   public:
0127     void Initialize(G4HCofThisEvent*) override;
0128     void EndOfEvent(G4HCofThisEvent*) override;
0129     void DrawAll() override;
0130     void PrintAll() override;
0131     /** Method used in multithreading mode in order to merge
0132         the results*/
0133     void AbsorbResultsFromWorkerScorer(G4VPrimitiveScorer*);
0134     void OutputAndClear();
0135     void SetNewValue(G4UIcommand*, G4String) override;
0136     void OutputToASCII();
0137
0138     SpeciesMap GetSpeciesInfo() { return fSpeciesInfoPerTime; }
0139
0140   private:
0141     G4int fHCID;
0142     G4THitsMap<G4double>* fEvtMap = nullptr;
0143
0144     G4int fRunID = 0;
0145     G4UIdirectory* fSpeciesdir = nullptr;
0146     G4UIcmdWithAnInteger* fTimeBincmd = nullptr;
0147     G4UIcmdWithADoubleAndUnit* fAddTimeToRecordcmd = nullptr;
0148
0149     G4UIcmdWithAString* fOutputTypeUI = nullptr;
0150     G4UIcmdWithAString* fOutputFileUI = nullptr;
0151
0152     G4String fOutputFile = "Species_Info";
0153 };
0154
0155 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0156
0157 #endif