sdcounters/include/ScoreBasicMoleculeCounts.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 // The `molcounters` example(s) are provided as part of Geant4-DNA
0027 // and any report or published result obtained using it shall cite
0028 // the respective Geant4-DNA collaboration publications.
0029 //
0030 // Reports or results obtained using the spatially-aware `MoleculeCounter`
0031 // provided in this example, shall further cite:
0032 //
0033 // Velten & Tomé, Radiation Physics and Chemistry, 2023 (10.1016/j.radphyschem.2023.111194)
0034 //
0035 //
0036 // Author: Christian Velten (2025)
0037 //
0038
0039 #ifndef ScoreBasicMoleculeCounts_hh
0040 #define ScoreBasicMoleculeCounts_hh 1
0041
0042 #include "G4MoleculeCounter.hh"
0043 #include "G4UIcmdWithADoubleAndUnit.hh"
0044 #include "G4UIcmdWithAnInteger.hh"
0045 #include "G4UImessenger.hh"
0046 #include "G4VPrimitiveScorer.hh"
0047
0048 #include <set>
0049
0050 class G4HCofThisEvent;
0051 class G4MolecularConfiguration;
0052 class G4VAnalysisManager;
0053 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0054 class ScoreBasicMoleculeCounts : public G4VPrimitiveScorer, public G4UImessenger
0055 {
0056   public:
0057     ScoreBasicMoleculeCounts(G4String name, G4int depth = 0, G4String = "BasicCounter");
0058     ~ScoreBasicMoleculeCounts() override;
0059
0060     void EndOfEvent(G4HCofThisEvent*) override;
0061     void clear() override;
0062     void AbsorbResultsFromWorkerScorer(G4VPrimitiveScorer*);
0063     void OutputAndClear();
0064     void SetNewValue(G4UIcommand*, G4String) override;
0065     const std::map<G4String, std::map<G4double, G4double>>& GetMoleculeCountMap() const
0066     {
0067       return fMoleculeCountPerIndexPerTime;
0068     }
0069     inline void AddTimeToRecord(G4double);
0070     inline void ClearTimesToRecord();
0071     inline G4int GetNumberOfRecordedEvents() const;
0072     void WriteWithAnalysisManager();
0073     G4bool ProcessHits(G4Step*, G4TouchableHistory*) override;
0074
0075   private:
0076     const char* ScorerCommand(G4String command);
0077     G4String fMoleculeCounterName = "";
0078     G4int fRunID = 0;
0079     G4int fNbOfScoredEvents = 0;
0080     G4UIcmdWithAnInteger* fTimeBincmd = nullptr;
0081     G4UIcmdWithADoubleAndUnit* fAddTimeToRecordcmd = nullptr;
0082     //G4bool fAppendAllCopyNumbers{false};//not used
0083     std::set<G4double> fTimesToRecord;
0084     std::map<G4String, std::map<G4double, G4double>> fMoleculeCountPerIndexPerTime;
0085 };
0086 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0087 inline void ScoreBasicMoleculeCounts::AddTimeToRecord(G4double time)
0088 {
0089   fTimesToRecord.insert(time);
0090 }
0091 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0092 inline void ScoreBasicMoleculeCounts::ClearTimesToRecord()
0093 {
0094   fTimesToRecord.clear();
0095 }
0096 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0097 inline G4int ScoreBasicMoleculeCounts::GetNumberOfRecordedEvents() const
0098 {
0099   return fNbOfScoredEvents;
0100 }
0101 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0102 #endif