#include <G4IStore.hh>

Inheritance diagram for G4IStore:

Public Member Functions
void	AddImportanceGeometryCell (G4double importance, const G4GeometryCell &gCell)

void	AddImportanceGeometryCell (G4double importance, const G4VPhysicalVolume &, G4int aRepNum=0)

void	ChangeImportance (G4double importance, const G4GeometryCell &gCell)

void	ChangeImportance (G4double importance, const G4VPhysicalVolume &, G4int aRepNum=0)

void	Clear ()

virtual G4double	GetImportance (const G4GeometryCell &gCell) const

G4double	GetImportance (const G4VPhysicalVolume &, G4int aRepNum=0) const

virtual const G4VPhysicalVolume *	GetParallelWorldVolumePointer () const

virtual const G4VPhysicalVolume &	GetWorldVolume () const

virtual G4bool	IsKnown (const G4GeometryCell &gCell) const

void	SetParallelWorldVolume (const G4String &paraName)

void	SetWorldVolume ()

Static Public Member Functions
static G4IStore *	GetInstance ()

static G4IStore *	GetInstance (const G4String &ParallelWorldName)

Protected Member Functions
	G4IStore ()

	G4IStore (const G4String &ParallelWorldName)

	~G4IStore ()

Private Member Functions
void	Error (const G4String &m) const

G4bool	IsInWorld (const G4VPhysicalVolume &) const

void	SetInternalIterator (const G4GeometryCell &gCell) const

Private Attributes
G4GeometryCellImportance::const_iterator	fCurrentIterator

G4GeometryCellImportance	fGeometryCelli

const G4VPhysicalVolume *	fWorldVolume = nullptr

Static Private Attributes
static G4ThreadLocal G4IStore *	fInstance = nullptr

Detailed Description

Definition at line 49 of file G4IStore.hh.

Constructor & Destructor Documentation

◆ G4IStore() [1/2]

G4IStore::G4IStore ( )

explicitprotected

Definition at line 48 of file G4IStore.cc.

  : fWorldVolume(G4TransportationManager::GetTransportationManager()
                 ->GetNavigatorForTracking()->GetWorldVolume())
{
}

Referenced by GetInstance().

◆ G4IStore() [2/2]

G4IStore::G4IStore ( const G4String & ParallelWorldName )

explicitprotected

Definition at line 54 of file G4IStore.cc.

  : fWorldVolume(G4TransportationManager::GetTransportationManager()
                 ->GetParallelWorld(ParallelWorldName))
{
#ifdef G4VERBOSE
  G4cout << " G4IStore:: ParallelWorldName = "
         << ParallelWorldName << G4endl;
  G4cout << " G4IStore:: fParallelWorldVolume = "
         << fWorldVolume->GetName() << G4endl;
#endif
}

References fWorldVolume, G4cout, G4endl, and G4VPhysicalVolume::GetName().

◆ ~G4IStore()

G4IStore::~G4IStore ( )

protected

Definition at line 66 of file G4IStore.cc.

67{

68}

Member Function Documentation

◆ AddImportanceGeometryCell() [1/2]

void G4IStore::AddImportanceGeometryCell	(	G4double	importance,
		const G4GeometryCell &	gCell
	)

Definition at line 108 of file G4IStore.cc.

{
  if (importance < 0 )
  {
    Error("AddImportanceGeometryCell() - Invalid importance value given.");
  }  
  if (!IsInWorld(gCell.GetPhysicalVolume()) )
  {
    Error("AddImportanceGeometryCell() - Physical volume not found!");
  }
  SetInternalIterator(gCell);
  if (fCurrentIterator != fGeometryCelli.cend())
  {
    Error("AddImportanceGeometryCell() - Region already existing!");
  }
  fGeometryCelli[gCell] = importance;
}

References Error(), fCurrentIterator, fGeometryCelli, G4GeometryCell::GetPhysicalVolume(), IsInWorld(), and SetInternalIterator().

Referenced by AddImportanceGeometryCell().

◆ AddImportanceGeometryCell() [2/2]

void G4IStore::AddImportanceGeometryCell	(	G4double	importance,
		const G4VPhysicalVolume &	aVolume,
		G4int	aRepNum = `0`
	)

Definition at line 127 of file G4IStore.cc.

{
  AddImportanceGeometryCell(importance, G4GeometryCell(aVolume, aRepNum));
}

References AddImportanceGeometryCell().

◆ ChangeImportance() [1/2]

void G4IStore::ChangeImportance	(	G4double	importance,
		const G4GeometryCell &	gCell
	)

Definition at line 134 of file G4IStore.cc.

{
  if (importance < 0 )
  {
    Error("ChangeImportance() - Invalid importance value given.");
  }
  if (!IsInWorld(gCell.GetPhysicalVolume()))
  {
    Error("ChangeImportance() - Physical volume not found!");
  }
  SetInternalIterator(gCell);
  if (fCurrentIterator == fGeometryCelli.cend())
  {
    Error("ChangeImportance() - Region does not exist!");
  }
  fGeometryCelli[gCell] = importance;
 
}

References Error(), fCurrentIterator, fGeometryCelli, G4GeometryCell::GetPhysicalVolume(), IsInWorld(), and SetInternalIterator().

Referenced by ChangeImportance().

◆ ChangeImportance() [2/2]

void G4IStore::ChangeImportance	(	G4double	importance,
		const G4VPhysicalVolume &	aVolume,
		G4int	aRepNum = `0`
	)

Definition at line 154 of file G4IStore.cc.

{
  ChangeImportance(importance, G4GeometryCell(aVolume, aRepNum));
}

References ChangeImportance().

◆ Clear()

void G4IStore::Clear ( )

Definition at line 70 of file G4IStore.cc.

{
  fGeometryCelli.clear();
}

References fGeometryCelli.

◆ Error()

void G4IStore::Error ( const G4String & m ) const

private

Definition at line 233 of file G4IStore.cc.

{
  G4Exception("G4IStore::Error()", "GeomBias0002", FatalException, msg);
}

References FatalException, and G4Exception().

Referenced by AddImportanceGeometryCell(), ChangeImportance(), and GetImportance().

◆ GetImportance() [1/2]

G4double G4IStore::GetImportance ( const G4GeometryCell & gCell ) const

virtual

Implements G4VIStore.

Definition at line 181 of file G4IStore.cc.

{
#ifdef G4MULTITHREADED
  G4MUTEXLOCK(&G4IStore::IStoreMutex);
#endif
  SetInternalIterator(gCell);
  auto gCellIterator = fCurrentIterator;
  if (gCellIterator == fGeometryCelli.cend())
  {
    std::ostringstream err_mess;
    err_mess << "GetImportance() - Region does not exist!" << G4endl
             << "Geometry cell, " << gCell
             << ", not found in: " << fGeometryCelli << ".";
    Error(err_mess.str());
    return 0.;
  }
  G4double importance_value = (*fCurrentIterator).second;
#ifdef G4MULTITHREADED
  G4MUTEXUNLOCK(&G4IStore::IStoreMutex);
#endif
  return importance_value;
  // return (*fCurrentIterator).second;
}

References Error(), fCurrentIterator, fGeometryCelli, G4endl, G4MUTEXLOCK, G4MUTEXUNLOCK, and SetInternalIterator().

◆ GetImportance() [2/2]

G4double G4IStore::GetImportance	(	const G4VPhysicalVolume &	aVolume,
		G4int	aRepNum = `0`
	)		const

Definition at line 161 of file G4IStore.cc.

{  
#ifdef G4MULTITHREADED
  G4MUTEXLOCK(&G4IStore::IStoreMutex);
#endif
  SetInternalIterator(G4GeometryCell(aVolume, aRepNum));
  auto gCellIterator = fCurrentIterator;
  if (gCellIterator == fGeometryCelli.cend())
  {
    Error("GetImportance() - Region does not exist!");
    return 0.;
  }
  G4double importance_value = (*fCurrentIterator).second;
#ifdef G4MULTITHREADED
  G4MUTEXUNLOCK(&G4IStore::IStoreMutex);
#endif
  return importance_value;
}

References Error(), fCurrentIterator, fGeometryCelli, G4MUTEXLOCK, G4MUTEXUNLOCK, and SetInternalIterator().

◆ GetInstance() [1/2]

G4IStore * G4IStore::GetInstance ( )

static

Definition at line 243 of file G4IStore.cc.

{
  if (fInstance == nullptr)
  {
#ifdef G4VERBOSE
    G4cout << "G4IStore:: Creating new MASS IStore " << G4endl;
#endif
    fInstance = new G4IStore();
  }
  return fInstance;    
}

References fInstance, G4cout, G4endl, and G4IStore().

Referenced by G4ImportanceBiasing::ConstructProcess().

◆ GetInstance() [2/2]

G4IStore * G4IStore::GetInstance ( const G4String & ParallelWorldName )

static

Definition at line 260 of file G4IStore.cc.

{
  if (fInstance == nullptr)
  {
#ifdef G4VERBOSE
    G4cout << "G4IStore:: Creating new Parallel IStore "
           << ParallelWorldName << G4endl;
#endif
    fInstance = new G4IStore(ParallelWorldName);
  }
  return fInstance;    
}

References fInstance, G4cout, G4endl, and G4IStore().

◆ GetParallelWorldVolumePointer()

const G4VPhysicalVolume * G4IStore::GetParallelWorldVolumePointer ( ) const

virtual

Definition at line 98 of file G4IStore.cc.

{
  return fWorldVolume;
}

References fWorldVolume.

◆ GetWorldVolume()

const G4VPhysicalVolume & G4IStore::GetWorldVolume ( ) const

virtual

Implements G4VIStore.

Definition at line 93 of file G4IStore.cc.

{
  return *fWorldVolume;
}

References fWorldVolume.

◆ IsInWorld()

G4bool G4IStore::IsInWorld ( const G4VPhysicalVolume & aVolume ) const

private

Definition at line 223 of file G4IStore.cc.

{
  G4bool isIn(true);
  if (!(aVolume == *fWorldVolume))
  {
    isIn = fWorldVolume->GetLogicalVolume()->IsAncestor(&aVolume);
  }
  return isIn;
}

References fWorldVolume, G4VPhysicalVolume::GetLogicalVolume(), and G4LogicalVolume::IsAncestor().

Referenced by AddImportanceGeometryCell(), ChangeImportance(), and IsKnown().

◆ IsKnown()

G4bool G4IStore::IsKnown ( const G4GeometryCell & gCell ) const

virtual

Implements G4VIStore.

Definition at line 205 of file G4IStore.cc.

{
#ifdef G4MULTITHREADED
  G4MUTEXLOCK(&G4IStore::IStoreMutex);
#endif
  G4bool inWorldKnown(IsInWorld(gCell.GetPhysicalVolume()));
                      
  if ( inWorldKnown )
  {
    SetInternalIterator(gCell);
    inWorldKnown = (fCurrentIterator != fGeometryCelli.cend());
  }
#ifdef G4MULTITHREADED
  G4MUTEXUNLOCK(&G4IStore::IStoreMutex);
#endif
  return inWorldKnown;
}

References fCurrentIterator, fGeometryCelli, G4MUTEXLOCK, G4MUTEXUNLOCK, G4GeometryCell::GetPhysicalVolume(), IsInWorld(), and SetInternalIterator().

◆ SetInternalIterator()

void G4IStore::SetInternalIterator ( const G4GeometryCell & gCell ) const

private

Definition at line 103 of file G4IStore.cc.

{
  fCurrentIterator = fGeometryCelli.find(gCell);
}

References fCurrentIterator, and fGeometryCelli.

Referenced by AddImportanceGeometryCell(), ChangeImportance(), GetImportance(), and IsKnown().

◆ SetParallelWorldVolume()

void G4IStore::SetParallelWorldVolume ( const G4String & paraName )

Definition at line 84 of file G4IStore.cc.

{
  G4cout << " G4IStore:: SetParallelWorldVolume " << G4endl;
  fWorldVolume = G4TransportationManager::GetTransportationManager()
                 ->GetParallelWorld(paraName);
  G4cout << " ParallelWorld volume is: " << fWorldVolume->GetName() << G4endl;
  // fGeometryCelli = new G4GeometryCellImportance;
}

References fWorldVolume, G4cout, G4endl, G4VPhysicalVolume::GetName(), G4TransportationManager::GetParallelWorld(), and G4TransportationManager::GetTransportationManager().

◆ SetWorldVolume()

void G4IStore::SetWorldVolume ( )

Definition at line 75 of file G4IStore.cc.

{
  G4cout << " G4IStore:: SetWorldVolume " << G4endl;
  fWorldVolume = G4TransportationManager::GetTransportationManager()
                 ->GetNavigatorForTracking()->GetWorldVolume();
  G4cout << " World volume is: " << fWorldVolume->GetName() << G4endl;
  // fGeometryCelli = new G4GeometryCellImportance;
}

References fWorldVolume, G4cout, G4endl, G4VPhysicalVolume::GetName(), G4TransportationManager::GetNavigatorForTracking(), G4TransportationManager::GetTransportationManager(), and G4Navigator::GetWorldVolume().

Field Documentation

◆ fCurrentIterator

G4GeometryCellImportance::const_iterator G4IStore::fCurrentIterator

mutableprivate

Definition at line 115 of file G4IStore.hh.

Referenced by AddImportanceGeometryCell(), ChangeImportance(), GetImportance(), IsKnown(), and SetInternalIterator().

◆ fGeometryCelli

G4GeometryCellImportance G4IStore::fGeometryCelli

private

Definition at line 113 of file G4IStore.hh.

Referenced by AddImportanceGeometryCell(), ChangeImportance(), Clear(), GetImportance(), IsKnown(), and SetInternalIterator().

◆ fInstance

G4ThreadLocal G4IStore * G4IStore::fInstance = nullptr

staticprivate

Definition at line 117 of file G4IStore.hh.

Referenced by GetInstance().

◆ fWorldVolume

const G4VPhysicalVolume* G4IStore::fWorldVolume = nullptr

private

Definition at line 112 of file G4IStore.hh.

Referenced by G4IStore(), GetParallelWorldVolumePointer(), GetWorldVolume(), IsInWorld(), SetParallelWorldVolume(), and SetWorldVolume().

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

source/geometry/biasing/include/G4IStore.hh
source/geometry/biasing/src/G4IStore.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4IStore() [1/2]

◆ G4IStore() [2/2]

◆ ~G4IStore()

Member Function Documentation

◆ AddImportanceGeometryCell() [1/2]

◆ AddImportanceGeometryCell() [2/2]

◆ ChangeImportance() [1/2]

◆ ChangeImportance() [2/2]

◆ Clear()

◆ Error()

◆ GetImportance() [1/2]

◆ GetImportance() [2/2]

◆ GetInstance() [1/2]

◆ GetInstance() [2/2]

◆ GetParallelWorldVolumePointer()

◆ GetWorldVolume()

◆ IsInWorld()

◆ IsKnown()

◆ SetInternalIterator()

◆ SetParallelWorldVolume()

◆ SetWorldVolume()

Field Documentation

◆ fCurrentIterator

◆ fGeometryCelli

◆ fInstance

◆ fWorldVolume