include/Geant4/G4ITModelProcessor.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 "G4ITReactionChange.hh"
0049 #include "G4ITType.hh"
0050 #include "G4ITModelHandler.hh"
0051 #include "G4ITStepStatus.hh"
0052 #include <vector>
0053
0054 class G4VITTimeStepComputer;
0055 class G4VITReactionProcess;
0056 class G4ITModelHandler;
0057 class G4ITReactionSet;
0058 class G4UserTimeStepAction;
0059 class G4ITTrackingManager;
0060 class G4ITTrackHolder;
0061
0062 /**
0063  * The G4ITModelProcessor will call the two processes defined in G4VITModel.
0064  * This processes act at the beginning and end of each step.
0065  * The first one, the TimeStepper will calculate a time step to propagate all
0066  * the track and eventually it can return some tracks that can likely react
0067  * at the end of the step.
0068  * The second one, the ReactionProcess will make the tracks reacting.
0069  * \deprecated This class will be removed
0070  */
0071 class G4ITModelProcessor
0072 {
0073 public:
0074     G4ITModelProcessor();
0075     G4ITModelProcessor(const G4ITModelProcessor& other) = delete;
0076     G4ITModelProcessor& operator=(const G4ITModelProcessor& other) = delete;
0077     virtual ~G4ITModelProcessor();
0078
0079     void SetModelHandler(G4ITModelHandler*);
0080     void SetTrackingManager(G4ITTrackingManager* trackingManager);
0081
0082     void Initialize();
0083
0084     void RegisterModel(double time, G4VITStepModel*);
0085
0086     /** Restore the original state. This method should be called only by G4Scheduler */
0087     void CleanProcessor();
0088
0089     G4double CalculateMinTimeStep(G4double currentGlobalTime,
0090                                   G4double definedMinTimeStep);
0091
0092     void ComputeTrackReaction(G4ITStepStatus fITStepStatus,
0093                               G4double fGlobalTime,
0094                               G4double currentTimeStep,
0095                               G4double previousTimeStep,
0096                               G4bool reachedUserTimeLimit,
0097                               G4double fTimeTolerance,
0098                               G4UserTimeStepAction* fpUserTimeStepAction,
0099                               G4int fVerbose);
0100
0101     void InitializeStepper(G4double currentGlobalTime,
0102                            G4double userMinTime);
0103
0104     bool GetComputeTimeStep() const;
0105
0106 public:
0107     const G4Track* GetTrack() const;
0108
0109 protected:
0110     void SetTrack(const G4Track*);
0111
0112     G4double fTSTimeStep;
0113     G4ITReactionSet* fReactionSet;
0114     G4ITTrackingManager* fpTrackingManager;
0115     G4ITTrackHolder* fpTrackContainer;
0116
0117     G4bool fInitialized;
0118     G4ITModelHandler* fpModelHandler;
0119
0120     const G4Track* fpTrack;
0121     G4double fUserMinTimeStep;
0122
0123     std::vector<G4VITStepModel*> fActiveModels;
0124     G4VITStepModel* fpActiveModelWithMinTimeStep;
0125
0126     std::vector<std::unique_ptr<G4ITReactionChange>> fReactionInfo;
0127
0128     bool fComputeTimeStep;
0129     bool fComputeReaction;
0130 };
0131