G4WeightWindowStore Class Reference

G4WeightWindowStore is an concrete implementation of a weight window store according to the G4VWeightWindowStore interface. More...

#include <G4WeightWindowStore.hh>

Inheritance diagram for G4WeightWindowStore:

Public Member Functions
G4double	GetLowerWeight (const G4GeometryCell &gCell, G4double partEnergy) 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	AddLowerWeights (const G4GeometryCell &gCell, const std::vector< G4double > &lowerWeights)
void	AddUpperEboundLowerWeightPairs (const G4GeometryCell &gCell, const G4UpperEnergyToLowerWeightMap &enWeMap)
void	SetGeneralUpperEnergyBounds (const std::set< G4double, std::less< G4double > > &enBounds)
Public Member Functions inherited from G4VWeightWindowStore
	G4VWeightWindowStore ()=default
virtual	~G4VWeightWindowStore ()=default

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

Detailed Description

G4WeightWindowStore is an concrete implementation of a weight window store according to the G4VWeightWindowStore interface.

Definition at line 50 of file G4WeightWindowStore.hh.

Member Function Documentation

AddLowerWeights()

void G4WeightWindowStore::AddLowerWeights	(	const G4GeometryCell &	gCell,
		const std::vector< G4double > &	lowerWeights )

Adds lower weights. Only if general upper energy bounds have been set.

Definition at line 154 of file G4WeightWindowStore.cc.

{
  if (fGeneralUpperEnergyBounds.empty())
  {
    Error("AddLowerWeights() - No general upper energy limits set!");
  }
  if (IsKnown(gCell))
  {
    Error("AddLowerWeights() - Cell already in the store.");
  }
  if (lowerWeights.size() != fGeneralUpperEnergyBounds.size())
  {
    std::ostringstream err_mess;
    err_mess << "AddLowerWeights() - Mismatch between "
             << "number of lower weights (" << lowerWeights.size()
             << ") and energy bounds (" << fGeneralUpperEnergyBounds.size()
             << ")!";
    Error(err_mess.str());
  }
  G4UpperEnergyToLowerWeightMap map;
  G4int i = 0;
  for (G4double fGeneralUpperEnergyBound : fGeneralUpperEnergyBounds)
  {
    map[fGeneralUpperEnergyBound] = lowerWeights[i];
    ++i;
  }
  fCellToUpEnBoundLoWePairsMap[gCell] = std::move(map);
}

AddUpperEboundLowerWeightPairs()

void G4WeightWindowStore::AddUpperEboundLowerWeightPairs	(	const G4GeometryCell &	gCell,
		const G4UpperEnergyToLowerWeightMap &	enWeMap )

Sets upper energy - lower weight pairs for a cell.

Definition at line 185 of file G4WeightWindowStore.cc.

{
  if (IsKnown(gCell))
  {
    Error("AddUpperEboundLowerWeightPairs() - Cell already in the store.");
  }
  if (IsKnown(gCell))
  {
    Error("AddUpperEboundLowerWeightPairs() - Cell already in the store.");
  }
  fCellToUpEnBoundLoWePairsMap[gCell] = enWeMap;
 
}

Clear()

void G4WeightWindowStore::Clear

(

)

Clears the cells weights map.

Definition at line 122 of file G4WeightWindowStore.cc.

{
  fCellToUpEnBoundLoWePairsMap.clear();
}

GetInstance() [1/2]

G4WeightWindowStore * G4WeightWindowStore::GetInstance ( )

static

Returns a pointer to the singleton instance of the class.

Definition at line 223 of file G4WeightWindowStore.cc.

{
  if (fInstance == nullptr)
  {
    fInstance = new G4WeightWindowStore();
  }
  return fInstance;    
}

Referenced by G4WeightWindowBiasing::ConstructProcess().

GetInstance() [2/2]

G4WeightWindowStore * G4WeightWindowStore::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 237 of file G4WeightWindowStore.cc.

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

GetLowerWeight()

G4double G4WeightWindowStore::GetLowerWeight ( const G4GeometryCell & gCell, G4double partEnergy ) const

overridevirtual

Derives a lower weight bound value of a "cell" addressed by a G4GeometryCell and the corresponding energy from the store.

Implements G4VWeightWindowStore.

Definition at line 59 of file G4WeightWindowStore.cc.

{
  SetInternalIterator(gCell);
  auto gCellIterator = fCurrentIterator;
  if (gCellIterator == fCellToUpEnBoundLoWePairsMap.cend())
  {
    Error("GetLowerWitgh() - Cell does not exist!");
    return 0.;
  }
  G4UpperEnergyToLowerWeightMap upEnLoWeiPairs = fCurrentIterator->second;
  G4double lowerWeight = -1;
  G4bool found = false;
  for (const auto & upEnLoWeiPair : upEnLoWeiPairs)
  {
    if (partEnergy < upEnLoWeiPair.first)
    {
      lowerWeight = upEnLoWeiPair.second;
      found = true;
      break;
    }
  }
  if (!found)
  {
    std::ostringstream err_mess;
    err_mess << "GetLowerWitgh() - Couldn't find lower weight bound." << G4endl
             << "Energy: " << partEnergy << ".";
    Error(err_mess.str());
  }
  return lowerWeight;
}

GetParallelWorldVolumePointer()

const G4VPhysicalVolume * G4WeightWindowStore::GetParallelWorldVolumePointer

(

)

const

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

Definition at line 148 of file G4WeightWindowStore.cc.

{
  return fWorldVolume;
}

GetWorldVolume()

const G4VPhysicalVolume & G4WeightWindowStore::GetWorldVolume ( ) const

overridevirtual

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

Implements G4VWeightWindowStore.

Definition at line 143 of file G4WeightWindowStore.cc.

{
  return *fWorldVolume;
}

IsKnown()

G4bool G4WeightWindowStore::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 G4VWeightWindowStore.

Definition at line 109 of file G4WeightWindowStore.cc.

{
  G4bool inWorldKnown(IsInWorld(gCell.GetPhysicalVolume()));
                      
  if ( inWorldKnown )
  {
    SetInternalIterator(gCell);
    inWorldKnown = (fCurrentIterator!=fCellToUpEnBoundLoWePairsMap.cend());
  }
  return inWorldKnown;
}

Referenced by AddLowerWeights(), and AddUpperEboundLowerWeightPairs().

SetGeneralUpperEnergyBounds()

void G4WeightWindowStore::SetGeneralUpperEnergyBounds

(

const std::set< G4double, std::less< G4double > > &

enBounds

)

Sets the energy bounds.

Definition at line 201 of file G4WeightWindowStore.cc.

{
  if (!fGeneralUpperEnergyBounds.empty())
  {
    Error("SetGeneralUpperEnergyBounds() - Energy bounds already set.");
  }
  fGeneralUpperEnergyBounds = enBounds;
}

SetParallelWorldVolume()

void G4WeightWindowStore::SetParallelWorldVolume

(

const G4String &

paraName

)

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

Definition at line 136 of file G4WeightWindowStore.cc.

{
  fWorldVolume = G4TransportationManager::GetTransportationManager()
                 ->GetParallelWorld(paraName);
  // fGeometryCelli = new G4GeometryCellImportance;
}

SetWorldVolume()

void G4WeightWindowStore::SetWorldVolume

(

)

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

Definition at line 127 of file G4WeightWindowStore.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:

• G4WeightWindowStore.hh
• G4WeightWindowStore.cc