include/Geant4/G4ITModelHandler.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 "G4Types.hh"
0049 #include "G4ITType.hh"
0050 #include <vector>
0051 #include <memory>
0052
0053 class G4ITModelManager;
0054 class G4VITStepModel;
0055
0056 /**
0057  * G4ITModelHandler holds for two IT types the corresponding model manager
0058  * \deprecated This class will be removed
0059  */
0060 class G4ITModelHandler
0061 {
0062 public:
0063     G4ITModelHandler();
0064
0065     G4ITModelHandler(const G4ITModelHandler& other) = delete;
0066
0067     G4ITModelHandler& operator=(const G4ITModelHandler& rhs) = delete;
0068
0069     ~G4ITModelHandler();
0070
0071     void Initialize();
0072
0073     // Register a model at a starting time (time1)
0074     // if a second model is registered at a later time (time2);
0075     // the second model will be considered from
0076     // time2 to the end of simulation
0077     void RegisterModel(G4VITStepModel* pModel, G4double globalTime);
0078
0079     void Reset();
0080
0081     void Finalize();
0082
0083     std::vector<G4VITStepModel*> GetActiveModels(G4double globalTime) const;
0084
0085     bool GetTimeStepComputerFlag();
0086
0087     bool GetReactionProcessFlag();
0088
0089 protected:
0090     G4bool fIsInitialized;
0091     std::unique_ptr<G4ITModelManager> fpModelManager;
0092
0093     G4bool fTimeStepComputerFlag; // Set true if a time stepper is registered
0094     G4bool fReactionProcessFlag; // Set true if a reaction process is registered
0095     G4bool fFinalize = false;
0096 };