include/Geant4/G4VDNAReactionModel.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 #pragma once
0047
0048 #include "globals.hh"
0049
0050 class G4DNAMolecularReactionTable;
0051 class G4MolecularConfiguration;
0052 class G4Molecule;
0053 class G4Track;
0054
0055 /**
0056   * G4VDNAReactionModel is an interface used by the G4DNAMolecularReaction process.
0057   * It defines how the reaction radius should be calculated and whether two molecules
0058   * can indeed react.
0059   */
0060 class G4VDNAReactionModel
0061 {
0062 public :
0063     G4VDNAReactionModel();
0064     G4VDNAReactionModel(const G4VDNAReactionModel&) = delete;
0065     G4VDNAReactionModel& operator=(const G4VDNAReactionModel&) = delete;
0066     virtual ~G4VDNAReactionModel();
0067
0068     virtual void Initialise(const G4MolecularConfiguration*, const G4Track&) {}
0069     virtual void InitialiseToPrint(const G4MolecularConfiguration*) = 0 ;
0070     virtual G4double GetReactionRadius(const G4MolecularConfiguration*,
0071                                        const G4MolecularConfiguration*) = 0;
0072     virtual G4double GetReactionRadius(const G4int&) = 0;
0073     virtual G4bool FindReaction(const G4Track&, const G4Track&,
0074                                 G4double /*reactionRadius*/,
0075                                 G4double& /*separationDistance*/,
0076                                 G4bool /*hasReachedUserTimeLimit*/) = 0;
0077
0078     void SetReactionTable(const G4DNAMolecularReactionTable*);
0079     const G4DNAMolecularReactionTable* GetReactionTable();
0080
0081 protected :
0082     const G4DNAMolecularReactionTable* fpReactionTable{nullptr} ;
0083 };