G4RegionStore Class Reference

#include <G4RegionStore.hh>

Inheritance diagram for G4RegionStore:

Public Member Functions
G4Region *	FindOrCreateRegion (const G4String &name)
	G4RegionStore (const G4RegionStore &)=delete
const std::map< G4String, std::vector< G4Region * > > &	GetMap () const
G4Region *	GetRegion (const G4String &name, G4bool verbose=true) const
G4bool	IsMapValid () const
G4bool	IsModified () const
G4RegionStore &	operator= (const G4RegionStore &)=delete
void	ResetRegionModified ()
void	SetMapValid (G4bool val)
void	SetWorldVolume ()
void	UpdateMap ()
void	UpdateMaterialList (G4VPhysicalVolume *currentWorld=nullptr)
virtual	~G4RegionStore ()

Static Public Member Functions
static void	Clean ()
static void	DeRegister (G4Region *pRegion)
static G4RegionStore *	GetInstance ()
static void	Register (G4Region *pRegion)
static void	SetNotifier (G4VStoreNotifier *pNotifier)

Protected Member Functions
	G4RegionStore ()

Private Attributes
std::map< G4String, std::vector< G4Region * > >	bmap
G4bool	mvalid = false

Static Private Attributes
static G4RegionStore *	fgInstance = nullptr
static G4ThreadLocal G4VStoreNotifier *	fgNotifier = nullptr
static G4ThreadLocal G4bool	locked = false

Detailed Description

Definition at line 58 of file G4RegionStore.hh.

Constructor & Destructor Documentation

~G4RegionStore()

G4RegionStore::~G4RegionStore ( )

virtual

Definition at line 68 of file G4RegionStore.cc.

{
  Clean();  // Delete all regions in the store
  G4Region::Clean();  // Delete allocated sub-instance data
}

References G4Region::Clean(), and Clean().

G4RegionStore() [1/2]

G4RegionStore::G4RegionStore ( const G4RegionStore &  )

delete

G4RegionStore() [2/2]

G4RegionStore::G4RegionStore ( )

protected

Definition at line 58 of file G4RegionStore.cc.

  : std::vector<G4Region*>()
{
  reserve(20);
}

Member Function Documentation

Clean()

void G4RegionStore::Clean ( )

static

Definition at line 78 of file G4RegionStore.cc.

{
  // Do nothing if geometry is closed
  //
  if (G4GeometryManager::IsGeometryClosed())
  {
    G4cout << "WARNING - Attempt to delete the region store"
           << " while geometry closed !" << G4endl;
    return;
  }
 
  // Locks store for deletion of regions. De-registration will be
  // performed at this stage. G4Regions will not de-register themselves.
  //
  locked = true;  
 
  std::size_t i=0;
  G4RegionStore* store = GetInstance();
 
#ifdef G4GEOMETRY_VOXELDEBUG
  G4cout << "Deleting Regions ... ";
#endif
 
  for(auto pos=store->cbegin(); pos!=store->cend(); ++pos)
  {
    if (fgNotifier != nullptr) { fgNotifier->NotifyDeRegistration(); }
    delete *pos; ++i;
  }
 
#ifdef G4GEOMETRY_VOXELDEBUG
  if (store->size() < i-1)
    { G4cout << "No regions deleted. Already deleted by user ?" << G4endl; }
  else
    { G4cout << i-1 << " regions deleted !" << G4endl; }
#endif
 
  store->bmap.clear(); store->mvalid = false;
  locked = false;
  store->clear();
}

References bmap, fgNotifier, G4cout, G4endl, GetInstance(), G4GeometryManager::IsGeometryClosed(), locked, mvalid, G4VNotifier::NotifyDeRegistration(), and pos.

Referenced by ~G4RegionStore().

DeRegister()

void G4RegionStore::DeRegister ( G4Region *  pRegion )

static

Definition at line 183 of file G4RegionStore.cc.

{
  G4RegionStore* store = GetInstance();
  if (!locked)    // Do not de-register if locked !
  {
    if (fgNotifier != nullptr)  { fgNotifier->NotifyDeRegistration(); }
    for (auto i=store->cbegin(); i!=store->cend(); ++i)
    {
      if (**i==*pRegion)
      {
        store->erase(i);
        break;
      }
    }
    const G4String& reg_name = pRegion->GetName();
    auto it = store->bmap.find(reg_name);
    if (it != store->bmap.cend())
    {
      if (it->second.size() > 1)
      {
        for (auto i=it->second.cbegin(); i!=it->second.cend(); ++i)
        {
          if (**i==*pRegion)
          {
            it->second.erase(i);
            break;
          }
        }
      }
      else
      {
        store->bmap.erase(it);
      }
    }
  }
}

References bmap, fgNotifier, GetInstance(), G4Region::GetName(), locked, and G4VNotifier::NotifyDeRegistration().

Referenced by G4Region::~G4Region().

FindOrCreateRegion()

G4Region * G4RegionStore::FindOrCreateRegion

(

const G4String &

name

)

Definition at line 315 of file G4RegionStore.cc.

{
  G4Region* target = GetRegion(name,false);
  if (target == nullptr)
  {
    target = new G4Region(name);
  }
  return target;
}

References GetRegion(), and G4InuclParticleNames::name().

GetInstance()

G4RegionStore * G4RegionStore::GetInstance ( )

static

Definition at line 224 of file G4RegionStore.cc.

{
  static G4RegionStore worldStore;
  if (fgInstance == nullptr)
  {
    fgInstance = &worldStore;
  }
  return fgInstance;
}

References fgInstance.

Referenced by G4EmBiasingManager::ActivateForcedInteraction(), G4EmModelActivator::ActivatePAI(), G4EmBiasingManager::ActivateSecondaryBiasing(), G4LowECapture::BuildPhysicsTable(), G4RunManagerKernel::CheckRegions(), Clean(), G4TheRayTracer::CreateBitMap(), G4EmExtraParameters::DefineRegParamForLoss(), DeRegister(), G4RunManagerKernel::DumpRegion(), G4GDMLParser::ExportRegions(), G4EmCalculator::FindCouple(), G4EmCalculator::FindRegion(), G4EmConfigurator::FindRegion(), G4ProductionCutsTable::G4ProductionCutsTable(), G4Region::G4Region(), G4RunManagerKernel::G4RunManagerKernel(), G4VUserPhysicsList::GetCutValue(), GetRegion(), G4PAIModel::Initialise(), G4PAIPhotModel::Initialise(), G4EmModelManager::Initialise(), G4VAtomDeexcitation::InitialiseAtomicDeexcitation(), IsModified(), Register(), G4RunManager::ReinitializeGeometry(), ResetRegionModified(), G4VUserPhysicsList::SetCutValue(), G4VAtomDeexcitation::SetDeexcitationActiveRegion(), G4ScoringProbe::SetMaterial(), G4Region::SetName(), SetNotifier(), G4VUserPhysicsList::SetParticleCuts(), G4MaterialScanner::SetRegionName(), G4ScoringProbe::SetupGeometry(), SetWorldVolume(), G4GlobalFastSimulationManager::ShowSetup(), G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster(), UpdateMap(), UpdateMaterialList(), G4RunManagerKernel::UpdateRegion(), and G4Region::~G4Region().

GetMap()

const std::map< G4String, std::vector< G4Region * > > & G4RegionStore::GetMap ( ) const

inline

Definition at line 94 of file G4RegionStore.hh.

{ return bmap; }

References bmap.

GetRegion()

G4Region * G4RegionStore::GetRegion	(	const G4String &	name,
		G4bool	verbose = true
	)		const

Definition at line 279 of file G4RegionStore.cc.

{
  G4RegionStore* store = GetInstance();
  if (!store->mvalid)  { store->UpdateMap(); }
  auto pos = store->bmap.find(name);
  if(pos != store->bmap.cend())
  {
    if ((verbose) && (pos->second.size()>1))
    {
      std::ostringstream message;
      message << "There exists more than ONE region in store named: "
              << name << "!" << G4endl
              << "Returning the first found.";
      G4Exception("G4RegionStore::GetSolid()",
                  "GeomMgt1001", JustWarning, message);
    }
    return pos->second[0];
  }
  if (verbose)
  {
    std::ostringstream message;
    message << "Region NOT found in store !" << G4endl
            << "        Region " << name << " NOT found in store !" << G4endl
            << "        Returning NULL pointer.";
    G4Exception("G4RegionStore::GetRegion()",
                "GeomMgt1001", JustWarning, message);
  }
  return nullptr;
}

References bmap, G4endl, G4Exception(), GetInstance(), JustWarning, mvalid, G4InuclParticleNames::name(), pos, and UpdateMap().

Referenced by G4EmBiasingManager::ActivateForcedInteraction(), G4EmModelActivator::ActivatePAI(), G4EmBiasingManager::ActivateSecondaryBiasing(), G4LowECapture::BuildPhysicsTable(), G4ProductionCutsTable::CheckMaterialCutsCoupleInfo(), G4EmExtraParameters::DefineRegParamForLoss(), G4RunManagerKernel::DumpRegion(), FindOrCreateRegion(), G4EmCalculator::FindRegion(), G4EmConfigurator::FindRegion(), G4Region::G4Region(), G4RunManagerKernel::G4RunManagerKernel(), G4VUserPhysicsList::GetCutValue(), G4EmModelManager::Initialise(), G4VAtomDeexcitation::InitialiseAtomicDeexcitation(), G4VUserPhysicsList::SetCutValue(), G4ScoringProbe::SetMaterial(), G4VUserPhysicsList::SetParticleCuts(), G4MaterialScanner::SetRegionName(), and G4ScoringProbe::SetupGeometry().

IsMapValid()

G4bool G4RegionStore::IsMapValid ( ) const

inline

Definition at line 90 of file G4RegionStore.hh.

{ return mvalid; }

References mvalid.

IsModified()

G4bool G4RegionStore::IsModified

(

)

const

Definition at line 239 of file G4RegionStore.cc.

{
  for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
  {
    if ((*i)->IsModified()) { return true; }
  }
  return false;
}

References GetInstance().

operator=()

G4RegionStore & G4RegionStore::operator= ( const G4RegionStore &  )

delete

Register()

void G4RegionStore::Register ( G4Region *  pRegion )

static

Definition at line 160 of file G4RegionStore.cc.

{
  G4RegionStore* store = GetInstance();
  store->push_back(pRegion);
  const G4String& reg_name = pRegion->GetName();
  auto it = store->bmap.find(reg_name);
  if (it != store->bmap.cend())
  {
    it->second.push_back(pRegion);
  }
  else
  {
    std::vector<G4Region*> reg_vec { pRegion };
    store->bmap.insert(std::make_pair(reg_name, reg_vec));
  }
  if (fgNotifier) { fgNotifier->NotifyRegistration(); }
  store->mvalid = true;
}

References bmap, fgNotifier, GetInstance(), G4Region::GetName(), mvalid, and G4VNotifier::NotifyRegistration().

Referenced by G4Region::G4Region().

ResetRegionModified()

void G4RegionStore::ResetRegionModified

(

)

Definition at line 253 of file G4RegionStore.cc.

{
  for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
  {
    (*i)->RegionModified(false);
  }
}

References GetInstance().

SetMapValid()

void G4RegionStore::SetMapValid ( G4bool  val )

inline

Definition at line 91 of file G4RegionStore.hh.

{ mvalid = val; }

References mvalid.

Referenced by G4Region::SetName().

SetNotifier()

void G4RegionStore::SetNotifier ( G4VStoreNotifier *  pNotifier )

static

Definition at line 123 of file G4RegionStore.cc.

{
  GetInstance();
  fgNotifier = pNotifier;
}

References fgNotifier, and GetInstance().

SetWorldVolume()

void G4RegionStore::SetWorldVolume

(

)

Definition at line 330 of file G4RegionStore.cc.

{
  // Reset all pointers first
  //
  for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
  { (*i)->SetWorld(nullptr); }
 
  // Find world volumes
  //
  G4PhysicalVolumeStore* fPhysicalVolumeStore
    = G4PhysicalVolumeStore::GetInstance();
  size_t nPhys = fPhysicalVolumeStore->size();
  for(size_t iPhys=0; iPhys<nPhys; ++iPhys)
  {
    G4VPhysicalVolume* fPhys = (*fPhysicalVolumeStore)[iPhys];
    if(fPhys->GetMotherLogical() != nullptr) { continue; } // not a world volume
 
    // Now 'fPhys' is a world volume, set it to regions that belong to it.
    //
    for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
    { (*i)->SetWorld(fPhys); }
  }
}

References G4PhysicalVolumeStore::GetInstance(), GetInstance(), and G4VPhysicalVolume::GetMotherLogical().

UpdateMap()

void G4RegionStore::UpdateMap

(

)

Definition at line 133 of file G4RegionStore.cc.

{
  G4AutoLock l(&mapMutex);  // to avoid thread contention at initialisation
  if (mvalid) return;
  bmap.clear();
  for(auto pos=GetInstance()->cbegin(); pos!=GetInstance()->cend(); ++pos)
  {
    const G4String& reg_name = (*pos)->GetName();
    auto it = bmap.find(reg_name);
    if (it != bmap.cend())
    {
      it->second.push_back(*pos);
    }
    else
    {
      std::vector<G4Region*> reg_vec { *pos };
      bmap.insert(std::make_pair(reg_name, reg_vec));
    }
  }
  mvalid = true;
  l.unlock();
}

References bmap, GetInstance(), anonymous_namespace{G4RegionStore.cc}::mapMutex, mvalid, pos, and G4TemplateAutoLock< _Mutex_t >::unlock().

Referenced by GetRegion().

UpdateMaterialList()

void G4RegionStore::UpdateMaterialList

(

G4VPhysicalVolume *

currentWorld = nullptr

)

Definition at line 265 of file G4RegionStore.cc.

{
  for (auto i=GetInstance()->cbegin(); i!=GetInstance()->cend(); ++i)
  {
    if((*i)->IsInMassGeometry() || (*i)->IsInParallelGeometry()
                                || (currentWorld != nullptr))
    { (*i)->UpdateMaterialList(); }
  }
}

References GetInstance().

Referenced by G4TheRayTracer::CreateBitMap(), and G4RunManagerKernel::UpdateRegion().

Field Documentation

bmap

std::map<G4String, std::vector<G4Region*> > G4RegionStore::bmap

private

Definition at line 127 of file G4RegionStore.hh.

Referenced by Clean(), DeRegister(), GetMap(), GetRegion(), Register(), and UpdateMap().

fgInstance

G4RegionStore * G4RegionStore::fgInstance = nullptr

staticprivate

Definition at line 123 of file G4RegionStore.hh.

Referenced by GetInstance().

fgNotifier

G4ThreadLocal G4VStoreNotifier * G4RegionStore::fgNotifier = nullptr

staticprivate

Definition at line 124 of file G4RegionStore.hh.

Referenced by Clean(), DeRegister(), Register(), and SetNotifier().

locked

G4ThreadLocal G4bool G4RegionStore::locked = false

staticprivate

Definition at line 125 of file G4RegionStore.hh.

Referenced by Clean(), and DeRegister().

mvalid

G4bool G4RegionStore::mvalid = false

private

Definition at line 128 of file G4RegionStore.hh.

Referenced by Clean(), GetRegion(), IsMapValid(), Register(), SetMapValid(), and UpdateMap().

---

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

• source/geometry/management/include/G4RegionStore.hh
• source/geometry/management/src/G4RegionStore.cc