#include <G4LogicalVolumeStore.hh>

Inheritance diagram for G4LogicalVolumeStore:

Public Member Functions
	G4LogicalVolumeStore (const G4LogicalVolumeStore &)=delete

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

G4LogicalVolume *	GetVolume (const G4String &name, G4bool verbose=true, G4bool reverseSearch=false) const

G4bool	IsMapValid () const

G4LogicalVolumeStore &	operator= (const G4LogicalVolumeStore &)=delete

void	SetMapValid (G4bool val)

void	UpdateMap ()

virtual	~G4LogicalVolumeStore ()

Static Public Member Functions
static void	Clean ()

static void	DeRegister (G4LogicalVolume *pVolume)

static G4LogicalVolumeStore *	GetInstance ()

static void	Register (G4LogicalVolume *pVolume)

static void	SetNotifier (G4VStoreNotifier *pNotifier)

Protected Member Functions
	G4LogicalVolumeStore ()

Private Attributes
std::map< G4String, std::vector< G4LogicalVolume * > >	bmap

G4bool	mvalid = false

Static Private Attributes
static G4LogicalVolumeStore *	fgInstance = nullptr

static G4ThreadLocal G4VStoreNotifier *	fgNotifier = nullptr

static G4ThreadLocal G4bool	locked = false

Detailed Description

Definition at line 55 of file G4LogicalVolumeStore.hh.

Constructor & Destructor Documentation

◆ ~G4LogicalVolumeStore()

G4LogicalVolumeStore::~G4LogicalVolumeStore ( )

virtual

Definition at line 65 of file G4LogicalVolumeStore.cc.

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

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

◆ G4LogicalVolumeStore() [1/2]

G4LogicalVolumeStore::G4LogicalVolumeStore ( const G4LogicalVolumeStore & )

delete

◆ G4LogicalVolumeStore() [2/2]

G4LogicalVolumeStore::G4LogicalVolumeStore ( )

protected

Definition at line 55 of file G4LogicalVolumeStore.cc.

 : std::vector<G4LogicalVolume*>()
{
  reserve(100);
}

Member Function Documentation

◆ Clean()

void G4LogicalVolumeStore::Clean ( )

static

Definition at line 75 of file G4LogicalVolumeStore.cc.

{
  // Do nothing if geometry is closed
  //
  if (G4GeometryManager::IsGeometryClosed())
  {
    G4cout << "WARNING - Attempt to delete the logical volume store"
           << " while geometry closed !" << G4endl;
    return;
  }
 
  // Locks store for deletion of volumes. De-registration will be
  // performed at this stage. G4LogicalVolumes will not de-register themselves.
  //
  locked = true;  
 
  std::size_t i = 0;
  G4LogicalVolumeStore* store = GetInstance();
 
#ifdef G4GEOMETRY_VOXELDEBUG
  G4cout << "Deleting Logical Volumes ... ";
#endif
 
  for(auto pos=store->cbegin(); pos!=store->cend(); ++pos)
  {
    if (fgNotifier != nullptr) { fgNotifier->NotifyDeRegistration(); }
    if (*pos != nullptr) { (*pos)->Lock(); delete *pos; }
    ++i;
  }
 
#ifdef G4GEOMETRY_VOXELDEBUG
  if (store->size() < i-1)
    { G4cout << "No volumes deleted. Already deleted by user ?" << G4endl; }
  else
    { G4cout << i-1 << " volumes 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 ExN03DetectorConstruction::ConstructCalorimeter(), DetectorConstruction::ConstructVolumes(), G4RunManager::ReinitializeGeometry(), and ~G4LogicalVolumeStore().

◆ DeRegister()

void G4LogicalVolumeStore::DeRegister ( G4LogicalVolume * pVolume )

static

Definition at line 181 of file G4LogicalVolumeStore.cc.

{
  G4LogicalVolumeStore* 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==*pVolume)
      {
        store->erase(i);
        break;
      }
    }
    const G4String& vol_name = pVolume->GetName();
    auto it = store->bmap.find(vol_name);
    if (it != store->bmap.cend())
    {
      if (it->second.size() > 1)
      {
        for (auto i=it->second.cbegin(); i!=it->second.cend(); ++i)
        {
          if (**i==*pVolume)
          {
            it->second.erase(i);
            break;
          }
        }
      }
      else
      {
        store->bmap.erase(it);
      }
    }
  }
}

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

Referenced by G4LogicalVolume::~G4LogicalVolume().

◆ GetInstance()

G4LogicalVolumeStore * G4LogicalVolumeStore::GetInstance ( )

static

Definition at line 265 of file G4LogicalVolumeStore.cc.

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

References fgInstance.

Referenced by G4GeometryManager::BuildOptimisations(), G4RunManagerKernel::CheckRegularGeometry(), checkVol(), Clean(), G4VUserDetectorConstruction::CloneF(), G4VUserDetectorConstruction::CloneSD(), ExN03DetectorConstruction::ConstructCalorimeter(), DetectorConstruction::ConstructVolumes(), G4GeometryManager::DeleteOptimisations(), DeRegister(), G4RadioactiveDecay::DeselectAVolume(), G4ScoringCylinder::DumpLogVols(), G4Region::GetParentRegion(), G4GDMLReadStructure::GetVolume(), GetVolume(), G4GDMLParser::ImportRegions(), Register(), G4RunManager::ReinitializeGeometry(), G4RadioactiveDecay::SelectAllVolumes(), G4RadioactiveDecay::SelectAVolume(), G4VVisCommandGeometrySet::Set(), G4LogicalVolume::SetName(), G4GDMLMessenger::SetNewValue(), G4VisCommandGeometryList::SetNewValue(), G4VisCommandGeometryRestore::SetNewValue(), G4VisCommandSceneAddLogicalVolume::SetNewValue(), SetNotifier(), G4VUserDetectorConstruction::SetSensitiveDetector(), G4VUserParallelWorld::SetSensitiveDetector(), G4ScoringProbe::SetupGeometry(), G4ScoringRealWorld::SetupGeometry(), G4GDMLRead::StripNames(), G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster(), and UpdateMap().

◆ GetMap()

const std::map< G4String, std::vector< G4LogicalVolume * > > & G4LogicalVolumeStore::GetMap ( ) const

inline

Definition at line 80 of file G4LogicalVolumeStore.hh.

80{ return bmap; }

References bmap.

Referenced by G4GDMLParser::ImportRegions(), G4VUserDetectorConstruction::SetSensitiveDetector(), and G4VUserParallelWorld::SetSensitiveDetector().

◆ GetVolume()

G4LogicalVolume * G4LogicalVolumeStore::GetVolume	(	const G4String &	name,
		G4bool	verbose = `true`,
		G4bool	reverseSearch = `false`
	)		const

Definition at line 223 of file G4LogicalVolumeStore.cc.

{
  G4LogicalVolumeStore* 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 logical volume in store named: "
              << name << "!" << G4endl
              << "Returning the first found.";
      G4Exception("G4LogicalVolumeStore::GetVolume()",
                  "GeomMgt1001", JustWarning, message);
    }
    if(reverseSearch)
    {
      return pos->second[pos->second.size()-1];
    }
    else
    {
      return pos->second[0];
    }
  }
  if (verbose)
  {
     std::ostringstream message;
     message << "Volume NOT found in store !" << G4endl
             << "        Volume " << name << " NOT found in store !" << G4endl
             << "        Returning NULL pointer.";
     G4Exception("G4LogicalVolumeStore::GetVolume()",
                 "GeomMgt1001", JustWarning, message);
  }
  return nullptr;
}

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

Referenced by G4RadioactiveDecay::DeselectAVolume(), G4GDMLReadStructure::GetVolume(), G4RadioactiveDecay::SelectAVolume(), G4GDMLMessenger::SetNewValue(), G4VisCommandSceneAddLogicalVolume::SetNewValue(), and G4ScoringProbe::SetupGeometry().

◆ IsMapValid()

G4bool G4LogicalVolumeStore::IsMapValid ( ) const

inline

Definition at line 76 of file G4LogicalVolumeStore.hh.

76{ return mvalid; }

References mvalid.

◆ operator=()

G4LogicalVolumeStore & G4LogicalVolumeStore::operator= ( const G4LogicalVolumeStore & )

delete

◆ Register()

void G4LogicalVolumeStore::Register ( G4LogicalVolume * pVolume )

static

Definition at line 158 of file G4LogicalVolumeStore.cc.

{
  G4LogicalVolumeStore* store = GetInstance();
  store->push_back(pVolume);
  const G4String& vol_name = pVolume->GetName();
  auto it = store->bmap.find(vol_name);
  if (it != store->bmap.cend())
  {
    it->second.push_back(pVolume);
  }
  else
  {
    std::vector<G4LogicalVolume*> vol_vec { pVolume };
    store->bmap.insert(std::make_pair(vol_name, vol_vec));
  }
  if (fgNotifier) { fgNotifier->NotifyRegistration(); }
  store->mvalid = true;
}

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

Referenced by G4LogicalVolume::G4LogicalVolume().

◆ SetMapValid()

void G4LogicalVolumeStore::SetMapValid ( G4bool val )

inline

Definition at line 77 of file G4LogicalVolumeStore.hh.

77{ mvalid = val; }

References mvalid.

Referenced by G4LogicalVolume::SetName().

◆ SetNotifier()

void G4LogicalVolumeStore::SetNotifier ( G4VStoreNotifier * pNotifier )

static

Definition at line 121 of file G4LogicalVolumeStore.cc.

{
  GetInstance();
  fgNotifier = pNotifier;
}

References fgNotifier, and GetInstance().

◆ UpdateMap()

void G4LogicalVolumeStore::UpdateMap ( )

Definition at line 131 of file G4LogicalVolumeStore.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& vol_name = (*pos)->GetName();
    auto it = bmap.find(vol_name);
    if (it != bmap.cend())
    {
      it->second.push_back(*pos);
    }
    else
    {
      std::vector<G4LogicalVolume*> vol_vec { *pos };
      bmap.insert(std::make_pair(vol_name, vol_vec));
    }
  }
  mvalid = true;
  l.unlock();
}

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

Referenced by GetVolume(), and G4GDMLRead::StripNames().

Field Documentation

◆ bmap

std::map<G4String, std::vector<G4LogicalVolume*> > G4LogicalVolumeStore::bmap

private

Definition at line 102 of file G4LogicalVolumeStore.hh.

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

◆ fgInstance

G4LogicalVolumeStore * G4LogicalVolumeStore::fgInstance = nullptr

staticprivate

Definition at line 98 of file G4LogicalVolumeStore.hh.

Referenced by GetInstance().

◆ fgNotifier

G4ThreadLocal G4VStoreNotifier * G4LogicalVolumeStore::fgNotifier = nullptr

staticprivate

Definition at line 99 of file G4LogicalVolumeStore.hh.

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

◆ locked

G4ThreadLocal G4bool G4LogicalVolumeStore::locked = false

staticprivate

Definition at line 100 of file G4LogicalVolumeStore.hh.

Referenced by Clean(), and DeRegister().

◆ mvalid

G4bool G4LogicalVolumeStore::mvalid = false

private

Definition at line 103 of file G4LogicalVolumeStore.hh.

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

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

source/geometry/management/include/G4LogicalVolumeStore.hh
source/geometry/management/src/G4LogicalVolumeStore.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~G4LogicalVolumeStore()

◆ G4LogicalVolumeStore() [1/2]

◆ G4LogicalVolumeStore() [2/2]

Member Function Documentation

◆ Clean()

◆ DeRegister()

◆ GetInstance()

◆ GetMap()

◆ GetVolume()

◆ IsMapValid()

◆ operator=()

◆ Register()

◆ SetMapValid()

◆ SetNotifier()

◆ UpdateMap()

Field Documentation

◆ bmap

◆ fgInstance

◆ fgNotifier

◆ locked

◆ mvalid