include/Geant4/G4VITReactionProcess.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 // Author: Mathieu Karamitros
0028
0029 // The code is developed in the framework of the ESA AO7146
0030 //
0031 // We would be very happy hearing from you, send us your feedback! :)
0032 //
0033 // In order for Geant4-DNA to be maintained and still open-source,
0034 // article citations are crucial.
0035 // If you use Geant4-DNA chemistry and you publish papers about your software,
0036 // in addition to the general paper on Geant4-DNA:
0037 //
0038 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0039 //
0040 // we would be very happy if you could please also cite the following
0041 // reference papers on chemistry:
0042 //
0043 // J. Comput. Phys. 274 (2014) 841-882
0044 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0045
0046
0047 #pragma once
0048
0049 #include "globals.hh"
0050 #include <memory>
0051 #include <vector>
0052
0053 class G4ITReactionTable;
0054 class G4ITReactionChange;
0055 class G4Track;
0056 class G4ITReactionSet;
0057 struct G4ITType;
0058
0059 /**
0060  * G4VITReactionProcess defines the reaction between two G4IT.
0061  * It should be stored in a G4VITModel.
0062  * \deprecated This class will be removed
0063  */
0064 class G4VITReactionProcess
0065 {
0066 public:
0067     G4VITReactionProcess() = default;
0068     virtual ~G4VITReactionProcess() = default;
0069     G4VITReactionProcess(const G4VITReactionProcess& other) = delete;
0070     G4VITReactionProcess& operator=(const G4VITReactionProcess& other) = delete;
0071
0072     /** First initialization (done once for all at the begin of the run)
0073      * eg. check if the reaction table is given ...
0074      */
0075     virtual void Initialize(){;}
0076
0077     virtual G4bool IsApplicable(const G4ITType&, const G4ITType&) const;
0078
0079     virtual G4bool TestReactibility(const G4Track&,
0080                                     const G4Track&,
0081                                     double /*currentStepTime*/,
0082                                     bool /*reachedUserStepTimeLimit*/) = 0;
0083
0084     virtual std::vector<std::unique_ptr<G4ITReactionChange>> FindReaction(G4ITReactionSet*, const double, const double, const bool)=0;
0085     virtual std::unique_ptr<G4ITReactionChange> MakeReaction(const G4Track&, const G4Track&) = 0;
0086
0087     virtual void SetReactionTable(const G4ITReactionTable*);
0088
0089 protected:
0090     const G4ITReactionTable* fpReactionTable = nullptr;
0091     G4String fName ;
0092 };