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