chem5/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 // Any report or published results obtained using the Geant4-DNA software
0028 // shall cite the following Geant4-DNA collaboration publication:
0029 // Med. Phys. 37 (2010) 4692-4708
0030 // J. Comput. Phys. 274 (2014) 841-882
0031 // Phys. Med. Biol. 63(10) (2018) 105014-12pp
0032 // The Geant4-DNA web site is available at http://geant4-dna.org
0033 //
0034 //
0035 #ifndef CHEM5_ScoreSpecies_h
0036 #define CHEM5_ScoreSpecies_h 1
0037
0038 #include "G4THitsMap.hh"
0039 #include "G4VPrimitiveScorer.hh"
0040
0041 #include <set>
0042
0043 class G4MolecularConfiguration;
0044
0045 /** \file ScoreSpecies.hh*/
0046
0047 // Description:
0048 //   This is a primitive scorer class for scoring the radiolitic species
0049 // produced after irradiation in a water volume
0050 //
0051 // Created: 2018-09-20  by J. Ramos-Mendez based on chem4 from
0052 //                         M. Karamitros
0053
0054 class ScoreSpecies : public G4VPrimitiveScorer
0055 {
0056   public:
0057     explicit ScoreSpecies(G4String name, G4int depth = 0);
0058
0059     ~ScoreSpecies() override = default;
0060
0061     /** Add a time at which the number of species should be recorded.
0062         Default times are set up to 1 microsecond.*/
0063     inline void AddTimeToRecord(double time) { fTimeToRecord.insert(time); }
0064
0065     /**  Remove all times to record, must be reset by user.*/
0066     inline void ClearTimeToRecord() { fTimeToRecord.clear(); }
0067
0068     /** Get number of recorded events*/
0069     inline G4int GetNumberOfRecordedEvents() const { return fNEvent; }
0070
0071     /** Write results to an text file*/
0072     void ASCII();
0073
0074     struct SpeciesInfo
0075     {
0076         SpeciesInfo() = default;
0077         SpeciesInfo(const SpeciesInfo& right)  // Species A(B);
0078         {
0079           fNumber = right.fNumber;
0080           fG = right.fG;
0081           fG2 = right.fG2;
0082         }
0083         SpeciesInfo& operator=(const SpeciesInfo& right)  // A = B
0084         {
0085           if (&right == this) return *this;
0086           fNumber = right.fNumber;
0087           fG = right.fG;
0088           fG2 = right.fG2;
0089           return *this;
0090         }
0091         G4int fNumber = 0;
0092         G4double fG = 0;
0093         G4double fG2 = 0;
0094     };
0095
0096   private:
0097     using Species = const G4MolecularConfiguration;
0098     using InnerSpeciesMap = std::map<Species*, SpeciesInfo>;
0099     using SpeciesMap = std::map<double, InnerSpeciesMap> ;
0100     SpeciesMap fSpeciesInfoPerTime;
0101
0102     std::set<G4double> fTimeToRecord;
0103
0104     G4int fNEvent = 0;  // number of processed events
0105     G4double fEdep = 0;  // total energy deposition
0106
0107   protected:
0108     G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0109
0110   public:
0111     void Initialize(G4HCofThisEvent*) override;
0112     void EndOfEvent(G4HCofThisEvent*) override;
0113     void PrintAll() override;
0114     /** Method used in multithreading mode in order to merge
0115         the results*/
0116     void AbsorbResultsFromWorkerScorer(G4VPrimitiveScorer*);
0117     void OutputAndClear();
0118
0119     SpeciesMap GetSpeciesInfo() { return fSpeciesInfoPerTime; }
0120
0121   private:
0122     G4int fHCID = -1;
0123     G4THitsMap<G4double>* fEvtMap = nullptr;
0124 };
0125 #endif