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