include/Geant4/G4VITStepModel.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 "AddClone_def.hh"
0049 #include "G4VITTimeStepComputer.hh"
0050 #include "G4VITReactionProcess.hh"
0051 #include "G4ITReactionTable.hh"
0052 #include "G4ITType.hh"
0053 #include <memory>
0054
0055 /**
0056  * Define actions before and after stepping.
0057  * The concrete implementation of G4VITModel defines the interaction
0058  * between two G4IT types. The types can be equal like :
0059  * Molecule + Molecule, or different : Molecule + Atom.
0060  */
0061 class G4VITStepModel
0062 {
0063 public:
0064     G4VITStepModel(const G4String& aName = "NoName");
0065     G4VITStepModel(std::unique_ptr<G4VITTimeStepComputer> pTimeStepper,
0066                    std::unique_ptr<G4VITReactionProcess> pReactionProcess,
0067                    const G4String& aName = "NoName");
0068
0069     G4VITStepModel(const G4VITStepModel& other) = delete;
0070     G4VITStepModel& operator=(const G4VITStepModel& other) = delete;
0071
0072     virtual ~G4VITStepModel() = default;
0073
0074     virtual void Initialize();
0075     void PrepareNewTimeStep();
0076
0077     void GetApplicable(G4ITType& type1, G4ITType& type2);
0078     virtual void PrintInfo() {;}
0079
0080     G4VITTimeStepComputer* GetTimeStepper();
0081     const G4String& GetName();
0082
0083     G4VITReactionProcess* GetReactionProcess();
0084     void SetReactionTable(G4ITReactionTable*);
0085     const G4ITReactionTable* GetReactionTable();
0086
0087 protected:
0088     G4String fName;
0089
0090     std::unique_ptr<G4VITTimeStepComputer> fpTimeStepper;
0091     std::unique_ptr<G4VITReactionProcess> fpReactionProcess;
0092     const G4ITReactionTable* fpReactionTable ;
0093
0094     G4ITType fType1;
0095     G4ITType fType2;
0096 };