Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/electromagnetic/dna/molecules/management/include/G4VMoleculeCounter.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 //  G4VMoleculeCounter.hh
 27 //  Geant4
 28 //
 29 //  Created by Mathieu Karamitros on 02/11/2016.
 30 //
 31 //
 32 
 33 #pragma once
 34 
 35 #include <G4Types.hh>
 36 #include <G4ios.hh>
 37 #include "G4ThreeVector.hh"
 38 
 39 class G4MolecularConfiguration;
 40 
 41 class G4MoleculeDefinition;
 42 
 43 class G4VMoleculeCounter
 44 {
 45 protected:
 46     static G4ThreadLocal G4VMoleculeCounter* fpInstance;
 47     G4bool fUse = false;
 48 
 49     G4VMoleculeCounter() = default;
 50 
 51     virtual ~G4VMoleculeCounter() = default;
 52 
 53 public:
 54     static void SetInstance(G4VMoleculeCounter*);
 55 
 56     static void DeleteInstance();
 57 
 58     using Reactant = const G4MolecularConfiguration;
 59 
 60     /*
 61      * If no instance of G4VMoleculeCounter is provided
 62      * then use G4MoleculeCounter
 63      */
 64     static G4VMoleculeCounter* Instance();
 65 
 66     static void InitializeInstance();
 67 
 68     /*
 69      * If the molecule counter is used, it will be called
 70      * at every creation/deletion of a molecule to
 71      * to increase/decrease the number at a given time.
 72      */
 73     void Use(G4bool flag = true);
 74 
 75     G4bool InUse();
 76 
 77     //----------------------------------------------------
 78 
 79     virtual void Initialize() = 0;
 80 
 81     virtual void ResetCounter() = 0;
 82 
 83     virtual void AddAMoleculeAtTime(Reactant*,
 84                                     G4double time,
 85                                     const G4ThreeVector* position = nullptr,
 86                                     int number = 1) = 0;
 87 
 88     virtual void RemoveAMoleculeAtTime(Reactant*,
 89                                        G4double time,
 90                                        const G4ThreeVector* position = nullptr,
 91                                        int number = 1) = 0;
 92 
 93     /* The dynamics of the given molecule won't be recorded. */
 94     virtual void DontRegister(const G4MoleculeDefinition*)
 95     {
 96     }
 97 
 98     virtual bool IsRegistered(const G4MoleculeDefinition*)
 99     {
100         return false;
101     }
102 
103     virtual void RegisterAll()
104     {
105     }
106 };