dnadamage2/include/MoleculeInserter.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 MoleculeInserter.hh
0027 /// \brief Definition of the MoleculeInserter class
0028 ///
0029 /// Definition of the DNA chemical species inserter for IRT
0030
0031 // This class was made using G4MoleculeGun as a base
0032 // G4MoleculeGun Author: Mathieu Karamitros
0033 //
0034 // The code is developed in the framework of the ESA AO7146
0035 //
0036 // We would be very happy hearing from you, send us your feedback! :)
0037 //
0038 // In order for Geant4-DNA to be maintained and still open-source,
0039 // article citations are crucial.
0040 // If you use Geant4-DNA chemistry and you publish papers about your software,
0041 // in addition to the general paper on Geant4-DNA:
0042 //
0043 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0044 //
0045 // we would be very happy if you could please also cite the following
0046 // reference papers on chemistry:
0047 //
0048 // Authors: J. Naoki D. Kondo (UCSF, US)
0049 //          J. Ramos-Mendez and B. Faddegon (UCSF, US)
0050 //
0051 // J. Comput. Phys. 274 (2014) 841-882
0052 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0053 //
0054
0055 #ifndef DNADAMAGE2_moleculeinserter_h
0056 #define DNADAMAGE2_moleculeinserter_h 1
0057
0058 #include "G4ITGun.hh"
0059 #include "G4ThreeVector.hh"
0060 #include "globals.hh"
0061
0062 #include <G4memory.hh>
0063 #include <map>
0064 #include <vector>
0065
0066 class G4Track;
0067 class MoleculeInserter;
0068 class G4Molecule;
0069
0070 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0071
0072 class MoleculeShoot
0073 {
0074   public:
0075     MoleculeShoot();
0076     ~MoleculeShoot() = default;
0077     void Shoot(MoleculeInserter*);
0078
0079   public:
0080     G4int fNumber = 0;
0081     G4String fMoleculeName = "None";
0082     G4double fTime = 1;
0083     G4ThreeVector fPosition = G4ThreeVector();
0084 };
0085
0086 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0087
0088 class MoleculeInserter : public G4ITGun
0089 {
0090   public:
0091     MoleculeInserter();
0092     MoleculeInserter(G4bool);
0093     ~MoleculeInserter() = default;
0094     void DefineTracks() override;
0095     void AddMolecule(const G4String& moleculeName, const G4ThreeVector& position, double time = 0);
0096     void PushToChemistry(G4Molecule*, G4double, G4ThreeVector);
0097     void CreateMolecule(G4Molecule*, G4double, G4ThreeVector);
0098     void CreateMolecule(G4String, G4double, G4ThreeVector);
0099     void Clean();
0100
0101     std::vector<G4Track*> const GetInsertedTracks() { return fInsertedTracks; }
0102
0103   private:
0104     G4bool fSaveTrackID = true;
0105     std::vector<G4Track*> fInsertedTracks;
0106
0107   protected:
0108     std::vector<MoleculeShoot> fShoots;
0109 };
0110
0111 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0112
0113 #endif