G4GeometryWorkspace Class Reference

G4GeometryWorkspace is a class managing the per-thread state of the geometry, spanning those which have a per-thread state and their dependents. In particular, it owns the arrays that implement 'split' classes and owns classes/objects which are owned by the split classes. More...

#include <G4GeometryWorkspace.hh>

Public Types
using	pool_type = G4TWorkspacePool<G4GeometryWorkspace>

Public Member Functions
	G4GeometryWorkspace ()
	~G4GeometryWorkspace ()=default
void	UseWorkspace ()
void	ReleaseWorkspace ()
void	DestroyWorkspace ()
void	InitialiseWorkspace ()

Static Public Member Functions
static pool_type *	GetPool ()

Protected Member Functions
void	InitialisePhysicalVolumes ()
G4bool	CloneReplicaSolid (G4PVReplica *)

Detailed Description

G4GeometryWorkspace is a class managing the per-thread state of the geometry, spanning those which have a per-thread state and their dependents. In particular, it owns the arrays that implement 'split' classes and owns classes/objects which are owned by the split classes.

Definition at line 63 of file G4GeometryWorkspace.hh.

Member Typedef Documentation

pool_type

using G4GeometryWorkspace::pool_type = G4TWorkspacePool<G4GeometryWorkspace>

Definition at line 67 of file G4GeometryWorkspace.hh.

Constructor & Destructor Documentation

G4GeometryWorkspace()

G4GeometryWorkspace::G4GeometryWorkspace

(

)

Constructor and default Destructor.

Definition at line 50 of file G4GeometryWorkspace.cc.

{
  fpLogicalVolumeSIM=
      &const_cast<G4LVManager&>(G4LogicalVolume::GetSubInstanceManager());
  fpPhysicalVolumeSIM=
      &const_cast<G4PVManager&>( G4VPhysicalVolume::GetSubInstanceManager() );
  fpReplicaSIM=
      &const_cast<G4PVRManager&>(G4PVReplica::GetSubInstanceManager());
  fpRegionSIM=
      &const_cast<G4RegionManager&>(G4Region::GetSubInstanceManager());
 
  // Create a work area for Logical Volumes in this thread
  // then capture its address
  //
  InitialiseWorkspace();
  
  fLogicalVolumeOffset = fpLogicalVolumeSIM->GetOffset();
 
  fPhysicalVolumeOffset = fpPhysicalVolumeSIM->GetOffset();
 
  fReplicaOffset = fpReplicaSIM->GetOffset();
 
  fRegionOffset = fpRegionSIM->GetOffset();
}

~G4GeometryWorkspace()

G4GeometryWorkspace::~G4GeometryWorkspace ( )

default

Member Function Documentation

CloneReplicaSolid()

G4bool G4GeometryWorkspace::CloneReplicaSolid ( G4PVReplica * replicaPV )

protected

Creates a clone of the solid for the given replica in this thread.

Definition at line 141 of file G4GeometryWorkspace.cc.

{
  G4LogicalVolume* logicalV = replicaPV->GetLogicalVolume();
  G4VSolid* solid = logicalV->GetSolid();
 
  G4AutoLock aLock(&mutex_init);
  G4VSolid* workerSolid = solid->Clone();
  aLock.unlock();
 
  if( workerSolid != nullptr )
  {
    logicalV->InitialiseWorker(logicalV,workerSolid,nullptr);
  }
  else
  {
    // In the case that not all solids support(ed) the Clone()
    // method, we do similar thing here to dynamically cast
    // and then get the clone method
    //
    G4ExceptionDescription ed;
    ed << "ERROR - Unable to initialise geometry for worker node." << "\n"
       << "A solid lacks the Clone() method - or Clone() failed." << "\n"
       << "   Type of solid: " << solid->GetEntityType() << "\n"
       << "   Parameters: " << *solid;
    G4Exception("G4GeometryWorkspace::CloneReplicaSolid()",
                "GeomVol0003", FatalException, ed);
    return false; 
  }
  return true; // It Worked
}

Referenced by InitialisePhysicalVolumes().

DestroyWorkspace()

void G4GeometryWorkspace::DestroyWorkspace

(

)

Definition at line 189 of file G4GeometryWorkspace.cc.

{
  G4PhysicalVolumeStore* physVolStore = G4PhysicalVolumeStore::GetInstance();
  for (auto physVol : *physVolStore)
  {
    G4LogicalVolume* logicalVol = physVol->GetLogicalVolume();
    auto g4PVReplica = dynamic_cast<G4PVReplica*>(physVol);
    if (g4PVReplica != nullptr)
    {
      g4PVReplica->TerminateWorker(g4PVReplica);
    }
    logicalVol->TerminateWorker(logicalVol);
  }
 
  // Threads may attempt to free memory simultaneously.
  // Need a lock to guarantee thread safety
  //
  G4AutoLock aLock(&mutex_init);
  fpLogicalVolumeSIM->FreeSlave();
  fpPhysicalVolumeSIM->FreeSlave();
  fpReplicaSIM->FreeSlave();
  fpRegionSIM->FreeSlave();
  aLock.unlock();
}

Referenced by G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster().

GetPool()

G4GeometryWorkspace::pool_type * G4GeometryWorkspace::GetPool ( )

static

Static accessor returning the global geometry pool.

Definition at line 43 of file G4GeometryWorkspace.cc.

{
  return &thePool;
}

Referenced by G4WorkerThread::BuildGeometryAndPhysicsVector(), G4WorkerThread::DestroyGeometryAndPhysicsVector(), G4VisManager::G4VisSubThread(), and G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster().

InitialisePhysicalVolumes()

void G4GeometryWorkspace::InitialisePhysicalVolumes ( )

protected

Initialises the workspace for all physical volumes in the store.

Definition at line 108 of file G4GeometryWorkspace.cc.

{
  G4PhysicalVolumeStore* physVolStore = G4PhysicalVolumeStore::GetInstance();
  for (auto physVol : *physVolStore)
  {
    G4LogicalVolume *logicalVol = physVol->GetLogicalVolume();
 
    // Use shadow pointer
    //
    G4VSolid* solid = logicalVol->GetMasterSolid();
    auto g4PVReplica = dynamic_cast<G4PVReplica*>(physVol);
    if (g4PVReplica == nullptr)
    {
      // Placement volume
      //
      logicalVol->InitialiseWorker(logicalVol,solid,nullptr);
    }
    else
    {          
      g4PVReplica->InitialiseWorker(g4PVReplica);
      logicalVol->InitialiseWorker(logicalVol,solid,nullptr);
 
      // If the replica's solid (in LV) is changed during navigation,
      // it must be thread-private
      //
      CloneReplicaSolid( g4PVReplica );
    }
  }
}

Referenced by InitialiseWorkspace().

InitialiseWorkspace()

void G4GeometryWorkspace::InitialiseWorkspace

(

)

Initialisation of the workspace. To be called at start of each run (especially 2nd and further runs).

Definition at line 174 of file G4GeometryWorkspace.cc.

{
  // Geometry related, split classes mechanism:
  // Do *NOT* instantiate sub-instance for this thread, just copy the contents!
  //
  fpLogicalVolumeSIM->SlaveCopySubInstanceArray();
  fpPhysicalVolumeSIM->SlaveCopySubInstanceArray();
  fpReplicaSIM->SlaveCopySubInstanceArray();
  fpRegionSIM->SlaveInitializeSubInstance();
 
  InitialisePhysicalVolumes();
}

Referenced by G4GeometryWorkspace(), and G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster().

ReleaseWorkspace()

void G4GeometryWorkspace::ReleaseWorkspace

(

)

Definition at line 97 of file G4GeometryWorkspace.cc.

{
  fpLogicalVolumeSIM->UseWorkArea(nullptr);
  fpPhysicalVolumeSIM->UseWorkArea(nullptr);
  
  fpReplicaSIM->UseWorkArea(nullptr);
  fpRegionSIM->UseWorkArea(nullptr);
}

UseWorkspace()

void G4GeometryWorkspace::UseWorkspace

(

)

Methods for the handling of the workspace. To take/release ownership and destroy.

Definition at line 78 of file G4GeometryWorkspace.cc.

{
  // Geometry related, split classes mechanism: instantiate sub-instance
  // for this thread
  //
  fpLogicalVolumeSIM->UseWorkArea(fLogicalVolumeOffset);
  fpPhysicalVolumeSIM->UseWorkArea(fPhysicalVolumeOffset);
  
  fpReplicaSIM->UseWorkArea(fReplicaOffset);
  fpRegionSIM->UseWorkArea(fRegionOffset);
 
  // When recycling a workspace 
  //   - it must be a lightweight operation, to reuse a valid work area
  //   - so it must NOT Initialise anything!
  // Do not call InitialisePhysicalVolumes();
}

---

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

• G4GeometryWorkspace.hh
• G4GeometryWorkspace.cc