include/Geant4/G4VUserChemistryList.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 // Author: Mathieu Karamitros
0027
0028 // The code is developed in the framework of the ESA AO7146
0029 //
0030 // We would be very happy hearing from you, send us your feedback! :)
0031 //
0032 // In order for Geant4-DNA to be maintained and still open-source,
0033 // article citations are crucial.
0034 // If you use Geant4-DNA chemistry and you publish papers about your software,
0035 // in addition to the general paper on Geant4-DNA:
0036 //
0037 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0038 //
0039 // we would be very happy if you could please also cite the following
0040 // reference papers on chemistry:
0041 //
0042 // J. Comput. Phys. 274 (2014) 841-882
0043 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0044
0045 #ifndef G4VUSERCHEMISTRYLIST_HH_
0046 #define G4VUSERCHEMISTRYLIST_HH_
0047
0048 #include "G4Types.hh"
0049 class G4Molecule;
0050 class G4DNAMolecularReactionTable;
0051 class G4VITStepModel;
0052 class G4MoleculeDefinition;
0053
0054 enum TimeStepModel
0055 {
0056   fSBS,
0057   fIRT,
0058   fIRT_syn
0059 };
0060
0061 class G4VUserChemistryList
0062 {
0063 public:
0064   G4VUserChemistryList(G4bool flag = true);
0065   virtual ~G4VUserChemistryList();
0066
0067   // If your user class also inherits from G4VPhysicsConstructor,
0068   // please put this flag to true
0069   bool IsPhysicsConstructor()
0070   {
0071     return fIsPhysicsConstructor;
0072   }
0073
0074   void ThisIsAPhysicsConstructor(G4bool flag = true)
0075   {
0076     fIsPhysicsConstructor = flag;
0077   }
0078
0079   ////////////////////////////////
0080   // to be called from PhysicsList
0081
0082   virtual void ConstructMolecule()
0083   {
0084     ;
0085   } // PhysicsList::ConstructParticle
0086   virtual void ConstructProcess()
0087   {
0088     ;
0089   } // PhysicsList::ConstructProcess
0090
0091   /////////////
0092
0093   virtual void ConstructDissociationChannels()
0094   {
0095     ;
0096   }
0097   virtual void ConstructReactionTable(G4DNAMolecularReactionTable* reactionTable) = 0;
0098   virtual void ConstructTimeStepModel(G4DNAMolecularReactionTable* reactionTable) = 0;
0099
0100   void BuildPhysicsTable();
0101
0102  protected:
0103   void BuildPhysicsTable(G4MoleculeDefinition*);
0104
0105   void RegisterTimeStepModel(G4VITStepModel* timeStepModel,
0106                              G4double startingTime = 0);
0107
0108   G4int verboseLevel;
0109   G4bool fIsPhysicsConstructor;
0110 };
0111
0112 #endif /* G4VUSERCHEMISTRYLIST_HH_ */