TG4VRegionsManager.h

Go to the documentation of this file.

#ifndef TG4_V_REGIONS_MANAGER_H
#define TG4_V_REGIONS_MANAGER_H
 
//------------------------------------------------
// The Geant4 Virtual Monte Carlo package
// Copyright (C) 2007 - 2023 Ivana Hrivnacova
// All rights reserved.
//
// For the licensing terms see geant4_vmc/LICENSE.
// Contact: root-vmc@cern.ch
//-------------------------------------------------
 
 
#include "TG4G3Cut.h"
#include "TG4RegionsMessenger.h"
#include "TG4Verbose.h"
 
#include <globals.hh>
 
#include <map>
 
class TG4Limits;
 
class G4Region;
class G4Material;
class G4VRangeToEnergyConverter;
class G4MaterialCutsCouple;
 
 
class TG4VRegionsManager : public TG4Verbose
{
 public:
  TG4VRegionsManager();
  virtual ~TG4VRegionsManager();
 
  static TG4VRegionsManager* Instance();
 
  // methods
  virtual void DefineRegions() = 0;
  virtual void UpdateProductionCutsTable() = 0;
 
  virtual void CheckRegions() const;
  virtual void PrintRegions(std::ostream& output) const;
  virtual void SaveRegions();
  virtual void DumpRegionStore() const;
 
  // set methods
  void SetFileName(const G4String& fileName);
  void SetApplyForGamma(G4bool applyForGamma);
  void SetApplyForElectron(G4bool applyForElectron);
  void SetApplyForPositron(G4bool applyForPositron);
  void SetApplyForProton(G4bool applyForProton);
  void SetCheck(G4bool isCheck);
  void SetPrint(G4bool isPrint);
  void SetSave(G4bool isSave);
 
  // get methods
  G4String GetFileName() const;
  G4bool GetApplyForGamma() const;
  G4bool GetApplyForElectron() const;
  G4bool GetApplyForPositron() const;
  G4bool GetApplyForProton() const;
  G4bool IsCheck() const;
  G4bool IsPrint() const;
  G4bool IsSave() const;
 
 protected:
  // constants
  static constexpr size_t fgkRangeGamIdx = 0;
  static constexpr size_t fgkRangeEleIdx = 1;
  static constexpr size_t fgkCutGamIdx = 2;
  static constexpr size_t fgkCutEleIdx = 3;
  static constexpr size_t fgkVmcCutGamIdx = 4;
  static constexpr size_t fgkVmcCutEleIdx = 5;
  static constexpr size_t fgkValuesSize = 6;
 
  using TG4RegionData = std::array<G4double, fgkValuesSize>;
 
  TG4VRegionsManager(const TG4VRegionsManager& right) = delete;
  TG4VRegionsManager& operator=(const TG4VRegionsManager& right) = delete;
 
  // methods
  G4double GetGlobalEnergyCut(TG4G3Cut cutType) const;
 
  G4double GetEnergyCut(
    TG4Limits* limits, TG4G3Cut cutType, G4double globalCutValue) const;
 
  G4bool IsCoupleUsedInTheRegion(
    const G4MaterialCutsCouple* couple, const G4Region* region) const;
 
  void CheckRegionsInGeometry() const;
  void PrintLegend(std::ostream& output) const;
  void PrintRegionData(std::ostream& output, const G4String& matName,
    const TG4RegionData& values) const;
  void PrintFromG4Table(std::ostream& output) const;
 
  //
  // static data members
 
  static TG4VRegionsManager* fgInstance;
  static const G4String fgkDefaultRegionName;
  static const G4String fgkDefaultFileName;
 
  //
  // data members
 
  G4String fFileName;
  G4bool fApplyForGamma = true;
  G4bool fApplyForElectron = true;
  G4bool fApplyForPositron = true;
  G4bool fApplyForProton = true;
  G4bool fIsCheck = false;
  G4bool fIsPrint = false;
  G4bool fIsSave = false;
};
 
inline TG4VRegionsManager* TG4VRegionsManager::Instance() { return fgInstance; }
 
inline void TG4VRegionsManager::SetFileName(const G4String& fileName)
{ fFileName = fileName; }
 
inline void TG4VRegionsManager::SetApplyForGamma(G4bool applyForGamma)
{
  fApplyForGamma = applyForGamma;
}
 
inline void TG4VRegionsManager::SetApplyForElectron(G4bool applyForElectron)
{
  fApplyForElectron = applyForElectron;
}
 
inline void TG4VRegionsManager::SetApplyForPositron(G4bool applyForPositron)
{
  fApplyForPositron = applyForPositron;
}
 
inline void TG4VRegionsManager::SetApplyForProton(G4bool applyForProton)
{
  fApplyForProton = applyForProton;
}
 
inline void TG4VRegionsManager::SetCheck(G4bool isCheck)
{ fIsCheck = isCheck; }
 
inline void TG4VRegionsManager::SetPrint(G4bool isPrint)
{ fIsPrint = isPrint; }
 
inline void TG4VRegionsManager::SetSave(G4bool isSave)
{ fIsSave = isSave; }
 
inline G4String TG4VRegionsManager::GetFileName() const
{ return fFileName; }
 
inline G4bool TG4VRegionsManager::GetApplyForGamma() const
{
  return fApplyForGamma;
}
 
inline G4bool TG4VRegionsManager::GetApplyForElectron() const
{
  return fApplyForElectron;
}
 
inline G4bool TG4VRegionsManager::GetApplyForPositron() const
{
  return fApplyForPositron;
}
 
inline G4bool TG4VRegionsManager::GetApplyForProton() const
{
  return fApplyForProton;
}
 
inline G4bool TG4VRegionsManager::IsCheck() const { return fIsCheck; }
 
inline G4bool TG4VRegionsManager::IsPrint() const { return fIsPrint; }
 
inline G4bool TG4VRegionsManager::IsSave() const { return fIsSave; }
 
#endif // TG4_V_REGIONS_MANAGER_H