include/Geant4/G4VPhysChemIO.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 /*
0027  * G4VPhysChemIO.hh
0028  *
0029  *  Created on: 3 févr. 2017
0030  *      Author: matkara
0031  */
0032
0033 #ifndef G4VPHYSCHEMIO_HH_
0034 #define G4VPHYSCHEMIO_HH_
0035
0036 #include <fstream>
0037 #include "globals.hh"
0038 #include "G4ThreeVector.hh"
0039
0040 class G4Track;
0041 class G4VAnalysisManager;
0042
0043 class G4VPhysChemIO
0044 {
0045 public:
0046   G4VPhysChemIO();
0047   virtual ~G4VPhysChemIO();
0048
0049   virtual void InitializeMaster(){}
0050   virtual void InitializeThread(){}
0051   virtual void InitializeFile() = 0;
0052
0053   virtual void NewRun() = 0;
0054   virtual void NewEvent() = 0;
0055
0056   /**
0057    * When DNA physics model create a water molecule, you'll get a notification
0058    * through this method.
0059    * The ElectronicModification is a flag telling whether the molecule
0060    * is ionized or excited, the electronic level is calculated by the
0061    * model and the IncomingTrack is the track responsible for the creation
0062    * of this molecule (electron, proton...)
0063    */
0064    virtual void CreateWaterMolecule(G4int electronicModif,
0065                                     G4int /*electronicLevel*/,
0066                                     G4double energy,
0067                                     const G4Track* /*theIncomingTrack*/) = 0;
0068
0069    /**
0070     * Same idea as the previous method but for solvated electron.
0071     * This method should be used by the physics model of the ElectronSolvatation
0072     * process.
0073     */
0074    virtual void CreateSolvatedElectron(const G4Track* /*theIncomingTrack*/,
0075                                        G4ThreeVector* finalPosition = nullptr) = 0;
0076
0077   //============================================================================
0078   // FILE OPERATIONS
0079   //============================================================================
0080
0081   /**
0082    * Tells the chemistry manager to write into a file
0083    * the position and electronic state of the water molecule
0084    * and the position thermalized or not of the solvated electron
0085    */
0086   virtual void WriteInto(const G4String&, std::ios_base::openmode mode =
0087       std::ios_base::out) = 0;
0088   virtual void AddEmptyLineInOutputFile(){};
0089
0090   /**
0091    * Close the file specified with WriteInto
0092    */
0093   virtual void CloseFile() = 0;
0094 };
0095
0096 #endif // G4PHYSCHEMIO_HH_