include/Geant4/G4VMoleculeCounter.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 //  G4VMoleculeCounter.hh
0027 //  Geant4
0028 //
0029 //  Created by Mathieu Karamitros on 02/11/2016.
0030 //
0031 //
0032
0033 #pragma once
0034
0035 #include <G4Types.hh>
0036 #include <G4ios.hh>
0037 #include "G4ThreeVector.hh"
0038
0039 class G4MolecularConfiguration;
0040
0041 class G4MoleculeDefinition;
0042
0043 class G4VMoleculeCounter
0044 {
0045 protected:
0046     static G4ThreadLocal G4VMoleculeCounter* fpInstance;
0047     G4bool fUse = false;
0048
0049     G4VMoleculeCounter() = default;
0050
0051     virtual ~G4VMoleculeCounter() = default;
0052
0053 public:
0054     static void SetInstance(G4VMoleculeCounter*);
0055
0056     static void DeleteInstance();
0057
0058     using Reactant = const G4MolecularConfiguration;
0059
0060     /*
0061      * If no instance of G4VMoleculeCounter is provided
0062      * then use G4MoleculeCounter
0063      */
0064     static G4VMoleculeCounter* Instance();
0065
0066     static void InitializeInstance();
0067
0068     /*
0069      * If the molecule counter is used, it will be called
0070      * at every creation/deletion of a molecule to
0071      * to increase/decrease the number at a given time.
0072      */
0073     void Use(G4bool flag = true);
0074
0075     G4bool InUse();
0076
0077     //----------------------------------------------------
0078
0079     virtual void Initialize() = 0;
0080
0081     virtual void ResetCounter() = 0;
0082
0083     virtual void AddAMoleculeAtTime(Reactant*,
0084                                     G4double time,
0085                                     const G4ThreeVector* position = nullptr,
0086                                     int number = 1) = 0;
0087
0088     virtual void RemoveAMoleculeAtTime(Reactant*,
0089                                        G4double time,
0090                                        const G4ThreeVector* position = nullptr,
0091                                        int number = 1) = 0;
0092
0093     /* The dynamics of the given molecule won't be recorded. */
0094     virtual void DontRegister(const G4MoleculeDefinition*)
0095     {
0096     }
0097
0098     virtual bool IsRegistered(const G4MoleculeDefinition*)
0099     {
0100         return false;
0101     }
0102
0103     virtual void RegisterAll()
0104     {
0105     }
0106 };