G4DNAChemistryManager.hh

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// $Id: G4DNAChemistryManager.hh 100802 2016-11-02 14:55:27Z gcosmo $
//

// Author: Mathieu Karamitros
//
// The code is developed in the framework of the ESA AO7146
//
// We would be very happy hearing from you, send us your feedback! :)
//
// In order for Geant4-DNA to be maintained and still open-source,
// article citations are crucial. 
// If you use Geant4-DNA chemistry and you publish papers about your software, 
// in addition to the general paper on Geant4-DNA:
//
// Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
//
// we would be very happy if you could please also cite the following
// reference papers on chemistry:
//
// J. Comput. Phys. 274 (2014) 841-882
// Prog. Nucl. Sci. Tec. 2 (2011) 503-508

#ifndef G4DNACHEMISTRYMANAGER_HH
#define G4DNACHEMISTRYMANAGER_HH

#include "globals.hh"
#include "G4ThreeVector.hh"
#include <fstream>
#include <memory>
#include "G4UImessenger.hh"
#include "G4VStateDependent.hh"

class G4Track;
class G4DNAWaterExcitationStructure;
class G4DNAWaterIonisationStructure;
class G4Molecule;
class G4VUserChemistryList;
class G4UIcmdWithABool;
class G4UIcmdWithADoubleAndUnit;
class G4UIcmdWithoutParameter;
class G4ITGun;

enum ElectronicModification
{
  eIonizedMolecule,
  eExcitedMolecule,
  eDissociativeAttachment
};

class G4DNAChemistryManager : public G4UImessenger, public G4VStateDependent
{
protected:
  virtual ~G4DNAChemistryManager();

public:
  //============================================================================
  // STATIC METHODS
  //============================================================================
  static G4DNAChemistryManager* Instance();
  static G4DNAChemistryManager* GetInstanceIfExists();

  static void DeleteInstance();
  G4bool IsChemistryActivated();
  void SetChemistryActivation(G4bool);
  static G4bool IsActivated();
  static void Activated(G4bool flag = true);

  //============================================================================
  // VIRTUAL METHODS
  //============================================================================
  virtual G4bool Notify(G4ApplicationState requestedState);
  virtual void SetNewValue(G4UIcommand*, G4String);
  virtual G4String GetCurrentValue(G4UIcommand * command);

  //============================================================================
  // INITIALIZATION AND FINALIZATION METHODS
  //============================================================================
  void Initialize();
  inline void SetChemistryList(G4VUserChemistryList*);
  inline void Deregister(G4VUserChemistryList*);
  void SetGlobalTemperature(double temp_K);

  inline void ForceMasterReinitialization();
  inline void TagThreadForReinitialization();

  void Run();
  void Clear();
  void Gun(G4ITGun*, bool physicsTableToBuild = true);
  inline void ForceThreadReinitialization();
  inline void ForceRebuildingPhysicsTable();

  //============================================================================
  // FILE OPERATIONS
  //============================================================================
  void WriteInto(const G4String&, std::ios_base::openmode mode =
      std::ios_base::out);
  void AddEmptyLineInOuputFile();

  void CloseFile();

  //============================================================================
  // PUSH MOLECULES
  //============================================================================
  void CreateWaterMolecule(ElectronicModification,
                           G4int /*electronicLevel*/,
                           const G4Track* /*theIncomingTrack*/);

  void CreateSolvatedElectron(const G4Track* /*theIncomingTrack*/,
                              G4ThreeVector* finalPosition = 0);

  void PushMolecule(G4Molecule*& molecule,
                    double time,
                    const G4ThreeVector& position,
                    int parentID);

  void PushMoleculeAtParentTimeAndPlace(G4Molecule*& molecule,
                                        const G4Track* /*theIncomingTrack*/);


  inline void SetVerbose(G4int verbose)
  {
    fVerbose = verbose;
  }

  inline void SetBuildPhysicsTable(bool flag)
  {fBuildPhysicsTable = flag;}

  G4bool IsCounterResetWhenRunEnds() const
  {
    return fResetCounterWhenRunEnds;
  }

  void ResetCounterWhenRunEnds(G4bool resetCounterWhenRunEnds)
  {
    fResetCounterWhenRunEnds = resetCounterWhenRunEnds;
  }

protected:
  G4DNAWaterExcitationStructure* GetExcitationLevel();
  G4DNAWaterIonisationStructure* GetIonisationLevel();
  void InitializeFile();
  void InitializeMaster();
  void InitializeThread();

  G4DNAChemistryManager();

private:
  G4UIdirectory* fpChemDNADirectory;
  G4UIcmdWithABool* fpActivateChem;
  G4UIcmdWithoutParameter* fpRunChem;
  G4UIcmdWithoutParameter* fpSkipReactionsFromChemList;
  //G4UIcmdWithADoubleAndUnit* fpGridSize;
  G4UIcmdWithADoubleAndUnit* fpScaleForNewTemperature;
  G4UIcmdWithoutParameter* fpInitChem;

  static G4DNAChemistryManager* fgInstance;
//  static bool fActiveChemistry;
  bool fActiveChemistry;
  G4bool fFileInitialized;
  G4bool fWriteFile;
  static G4ThreadLocal std::ofstream* fpgOutput_tl;
  static G4ThreadLocal G4bool* fpgThreadInitialized_tl;
  G4bool fMasterInitialized;
  G4bool fForceThreadReinitialization;

  G4DNAWaterExcitationStructure* fpExcitationLevel;
  G4DNAWaterIonisationStructure* fpIonisationLevel;

  G4VUserChemistryList* fpUserChemistryList;
  G4bool fBuildPhysicsTable;
  G4bool fPhysicsTableBuilt;
  G4bool fSkipReactions;

  G4bool fGeometryClosed;

  G4int fVerbose;
  G4bool fResetCounterWhenRunEnds;
};

inline void G4DNAChemistryManager::ForceRebuildingPhysicsTable()
{
  fPhysicsTableBuilt = false;
}

inline void G4DNAChemistryManager::SetChemistryList(G4VUserChemistryList* chemistryList)
{
  fpUserChemistryList = chemistryList;
  Activated();
}

inline void G4DNAChemistryManager::Deregister(G4VUserChemistryList* chemistryList)
{
  if (fpUserChemistryList == chemistryList) fpUserChemistryList = 0;
}

inline void G4DNAChemistryManager::ForceMasterReinitialization()
{
  fMasterInitialized = false;
  InitializeMaster();
}

inline void G4DNAChemistryManager::ForceThreadReinitialization()
{
  // TODO
  fForceThreadReinitialization = true;
}

inline void G4DNAChemistryManager::TagThreadForReinitialization()
{
  if (fpgThreadInitialized_tl) delete fpgThreadInitialized_tl;
}

#endif // G4DNACHEMISTRYMANAGER_HH