G4IStore Class Reference

G4IStore is a concrete implementation of an "importance store", as derived from G4VIStore. It is a singleton, using G4GeometryCellImportance as the container to store the "cells" together with the importance values. Giving a cell, the importance 0 is allowed as a flagging that no biasing should happen between this cell and its neighbors. If a cell is not known by the importance store no biasing should be applied between this cell and its nighbors. More...

#include <G4IStore.hh>

Inheritance diagram for G4IStore:

Public Member Functions
G4double	GetImportance (const G4GeometryCell &gCell) const override
G4bool	IsKnown (const G4GeometryCell &gCell) const override
void	Clear ()
void	SetWorldVolume ()
void	SetParallelWorldVolume (const G4String &paraName)
const G4VPhysicalVolume &	GetWorldVolume () const override
const G4VPhysicalVolume *	GetParallelWorldVolumePointer () const
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)
G4double	GetImportance (const G4VPhysicalVolume &vol, G4int rpNum=0) const
Public Member Functions inherited from G4VIStore
	G4VIStore ()=default
virtual	~G4VIStore ()=default

Static Public Member Functions
static G4IStore *	GetInstance ()
static G4IStore *	GetInstance (const G4String &ParallelWorldName)

Detailed Description

G4IStore is a concrete implementation of an "importance store", as derived from G4VIStore. It is a singleton, using G4GeometryCellImportance as the container to store the "cells" together with the importance values. Giving a cell, the importance 0 is allowed as a flagging that no biasing should happen between this cell and its neighbors. If a cell is not known by the importance store no biasing should be applied between this cell and its nighbors.

Definition at line 59 of file G4IStore.hh.

Member Function Documentation

AddImportanceGeometryCell() [1/2]

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

Methods to add a "cell" together with an importance value to the store.

Definition at line 107 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;
}

Referenced by AddImportanceGeometryCell().

AddImportanceGeometryCell() [2/2]

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

Definition at line 126 of file G4IStore.cc.

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

ChangeImportance() [1/2]

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

Methods to change an importance value of a "cell".

Definition at line 133 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;
 
}

Referenced by ChangeImportance().

ChangeImportance() [2/2]

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

Definition at line 153 of file G4IStore.cc.

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

Clear()

void G4IStore::Clear

(

)

Clears the cells importance store.

Definition at line 69 of file G4IStore.cc.

{
  fGeometryCelli.clear();
}

GetImportance() [1/2]

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

overridevirtual

Returns the importance value of a "cell" from the store addressed by 'gCell'.

Parameters

[in]

gCell

The cell of reference.

Returns

The associated importance weight.

Implements G4VIStore.

Definition at line 177 of file G4IStore.cc.

{
  G4AutoLock l(&IStoreMutex);
  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;
  l.unlock();
 
  return importance_value;
}

GetImportance() [2/2]

G4double G4IStore::GetImportance	(	const G4VPhysicalVolume &	vol,
		G4int	rpNum = 0 ) const

Returns the importance weight, given the volume and replica number.

Definition at line 160 of file G4IStore.cc.

{  
  G4AutoLock l(&IStoreMutex);
  SetInternalIterator(G4GeometryCell(aVolume, aRepNum));
  auto gCellIterator = fCurrentIterator;
  if (gCellIterator == fGeometryCelli.cend())
  {
    Error("GetImportance() - Region does not exist!");
    return 0.;
  }
  G4double importance_value = (*fCurrentIterator).second;
  l.unlock();
 
  return importance_value;
}

GetInstance() [1/2]

G4IStore * G4IStore::GetInstance ( )

static

Returns a pointer to the singleton instance of the class.

Definition at line 232 of file G4IStore.cc.

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

Referenced by G4ImportanceBiasing::ConstructProcess().

GetInstance() [2/2]

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

static

Returns a pointer to the singleton instance of the class, given the name of the parallel world of reference.

Definition at line 249 of file G4IStore.cc.

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

GetParallelWorldVolumePointer()

const G4VPhysicalVolume * G4IStore::GetParallelWorldVolumePointer

(

)

const

Returns a pointer to the world volume of the "importance" geometry.

Definition at line 97 of file G4IStore.cc.

{
  return fWorldVolume;
}

GetWorldVolume()

const G4VPhysicalVolume & G4IStore::GetWorldVolume ( ) const

overridevirtual

Returns a reference to the world volume of the "importance" geometry.

Implements G4VIStore.

Definition at line 92 of file G4IStore.cc.

{
  return *fWorldVolume;
}

IsKnown()

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

overridevirtual

Returns true if 'gCell' is in the store, else false.

Parameters

[in]

gCell

The cell of reference.

Returns

true if present in the store, false otherwise.

Implements G4VIStore.

Definition at line 197 of file G4IStore.cc.

{
  G4AutoLock l(&IStoreMutex);
  G4bool inWorldKnown(IsInWorld(gCell.GetPhysicalVolume()));
                      
  if ( inWorldKnown )
  {
    SetInternalIterator(gCell);
    inWorldKnown = (fCurrentIterator != fGeometryCelli.cend());
  }
  l.unlock();
 
  return inWorldKnown;
}

SetParallelWorldVolume()

void G4IStore::SetParallelWorldVolume

(

const G4String &

paraName

)

Sets a reference to parallel world volume of the "importance" geometry.

Definition at line 83 of file G4IStore.cc.

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

SetWorldVolume()

void G4IStore::SetWorldVolume

(

)

Sets a reference to world volume of the "importance" geometry.

Definition at line 74 of file G4IStore.cc.

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

---

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

• G4IStore.hh
• G4IStore.cc