G4VMoleculeCounter Class Reference

#include <G4VMoleculeCounter.hh>

Inheritance diagram for G4VMoleculeCounter:

Public Types
using	Reactant = const G4MolecularConfiguration

Public Member Functions
virtual void	AddAMoleculeAtTime (Reactant *, G4double time, const G4ThreeVector *position=nullptr, int number=1)=0
virtual void	DontRegister (const G4MoleculeDefinition *)
virtual void	Initialize ()=0
virtual bool	IsRegistered (const G4MoleculeDefinition *)
virtual void	RegisterAll ()
virtual void	RemoveAMoleculeAtTime (Reactant *, G4double time, const G4ThreeVector *position=nullptr, int number=1)=0
virtual void	ResetCounter ()=0

Static Public Member Functions
static void	DeleteInstance ()
static void	InitializeInstance ()
static G4VMoleculeCounter *	Instance ()
static G4bool	InUse ()
static void	SetInstance (G4VMoleculeCounter *)
static void	Use (G4bool flag=true)

Protected Member Functions
	G4VMoleculeCounter ()=default
virtual	~G4VMoleculeCounter ()=default

Static Protected Attributes
static G4ThreadLocal G4VMoleculeCounter *	fpInstance = nullptr
static G4bool	fUse = false

Detailed Description

Definition at line 43 of file G4VMoleculeCounter.hh.

Member Typedef Documentation

Reactant

using G4VMoleculeCounter::Reactant = const G4MolecularConfiguration

Definition at line 58 of file G4VMoleculeCounter.hh.

Constructor & Destructor Documentation

G4VMoleculeCounter()

G4VMoleculeCounter::G4VMoleculeCounter ( )

protecteddefault

~G4VMoleculeCounter()

virtual G4VMoleculeCounter::~G4VMoleculeCounter ( )

protectedvirtualdefault

Member Function Documentation

AddAMoleculeAtTime()

virtual void G4VMoleculeCounter::AddAMoleculeAtTime ( Reactant *  , G4double  time, const G4ThreeVector *  position = nullptr, int  number = 1  )

pure virtual

Implemented in G4MoleculeCounter.

Referenced by G4DNAUpdateSystemModel::CreateMolecule().

DeleteInstance()

void G4VMoleculeCounter::DeleteInstance ( )

static

Definition at line 78 of file G4VMoleculeCounter.cc.

{
    if (fpInstance != nullptr)
    {
        delete fpInstance;
        fpInstance = nullptr;
    }
}

References fpInstance.

Referenced by G4DNAChemistryManager::Clear().

DontRegister()

virtual void G4VMoleculeCounter::DontRegister ( const G4MoleculeDefinition *  )

inlinevirtual

Reimplemented in G4MoleculeCounter.

Definition at line 94 of file G4VMoleculeCounter.hh.

    {
    }

Initialize()

virtual void G4VMoleculeCounter::Initialize ( )

pure virtual

Implemented in G4MoleculeCounter.

Referenced by InitializeInstance().

InitializeInstance()

void G4VMoleculeCounter::InitializeInstance ( )

static

Definition at line 89 of file G4VMoleculeCounter.cc.

{
    if (fpInstance)
    {
        fpInstance->Initialize();
    }
}

References fpInstance, and Initialize().

Referenced by G4DNAChemistryManager::InitializeThread().

Instance()

G4VMoleculeCounter * G4VMoleculeCounter::Instance ( )

static

Definition at line 67 of file G4VMoleculeCounter.cc.

{
    if (fpInstance == nullptr)
    {
        fpInstance = new G4MoleculeCounter();
    }
    return fpInstance;
}

References fpInstance.

Referenced by G4Molecule::BuildTrack(), G4DNAEventScheduler::ClearAndReChargeCounter(), G4DNAUpdateSystemModel::CreateMolecule(), G4DNAUpdateSystemModel::KillMolecule(), G4DNAElectronHoleRecombination::MakeReaction(), G4DNAChemistryManager::Run(), and G4Molecule::~G4Molecule().

InUse()

G4bool G4VMoleculeCounter::InUse ( )

static

Definition at line 106 of file G4VMoleculeCounter.cc.

{
    return fUse;
}

References fUse.

Referenced by G4Molecule::BuildTrack(), G4DNAUpdateSystemModel::CreateMolecule(), and G4DNAElectronHoleRecombination::MakeReaction().

IsRegistered()

virtual bool G4VMoleculeCounter::IsRegistered ( const G4MoleculeDefinition *  )

inlinevirtual

Reimplemented in G4MoleculeCounter.

Definition at line 98 of file G4VMoleculeCounter.hh.

    {
        return false;
    }

RegisterAll()

virtual void G4VMoleculeCounter::RegisterAll ( )

inlinevirtual

Reimplemented in G4MoleculeCounter.

Definition at line 103 of file G4VMoleculeCounter.hh.

    {
    }

RemoveAMoleculeAtTime()

virtual void G4VMoleculeCounter::RemoveAMoleculeAtTime ( Reactant *  , G4double  time, const G4ThreeVector *  position = nullptr, int  number = 1  )

pure virtual

Implemented in G4MoleculeCounter.

Referenced by G4DNAUpdateSystemModel::KillMolecule().

ResetCounter()

virtual void G4VMoleculeCounter::ResetCounter ( )

pure virtual

Implemented in G4MoleculeCounter.

Referenced by G4DNAChemistryManager::Run().

SetInstance()

void G4VMoleculeCounter::SetInstance ( G4VMoleculeCounter *  pCounterInstance )

static

Definition at line 43 of file G4VMoleculeCounter.cc.

{
    if (fpInstance != nullptr)
    {
        G4ExceptionDescription errMsg;
        errMsg << "The G4MoleculeCounter was already initialized." << G4endl
               << "The previous instance will be deleted in order to use yours." << G4endl
               << "However this can generate conflicts. Make sure you call G4MoleculeCounter::SetInstance"
                  "at the beginning of your application."
               << "A good place would be ActionInitialization::Build & BuildForMaster"
               << G4endl;
 
        G4Exception("G4MoleculeCounter::SetInstance",
                    "SINGLETON_ALREADY_INITIALIZED",
                    JustWarning, errMsg);
        delete fpInstance;
        fpInstance = nullptr;
    }
 
    fpInstance = pCounterInstance;
}

References fpInstance, G4endl, G4Exception(), and JustWarning.

Use()

void G4VMoleculeCounter::Use ( G4bool  flag = true )

static

Definition at line 99 of file G4VMoleculeCounter.cc.

{
    fUse = flag;
}

References fUse.

Referenced by G4DNAEventScheduler::ClearAndReChargeCounter().

Field Documentation

fpInstance

G4ThreadLocal G4VMoleculeCounter * G4VMoleculeCounter::fpInstance = nullptr

staticprotected

Definition at line 46 of file G4VMoleculeCounter.hh.

Referenced by DeleteInstance(), InitializeInstance(), G4MoleculeCounter::Instance(), Instance(), and SetInstance().

fUse

G4bool G4VMoleculeCounter::fUse = false

staticprotected

Definition at line 47 of file G4VMoleculeCounter.hh.

Referenced by InUse(), and Use().

---

The documentation for this class was generated from the following files:

• source/processes/electromagnetic/dna/molecules/management/include/G4VMoleculeCounter.hh
• source/processes/electromagnetic/dna/molecules/management/src/G4VMoleculeCounter.cc