G4WeightWindowStore Class Reference

#include <G4WeightWindowStore.hh>

Inheritance diagram for G4WeightWindowStore:

Public Member Functions
void	AddLowerWeights (const G4GeometryCell &gCell, const std::vector< G4double > &lowerWeights)
void	AddUpperEboundLowerWeightPairs (const G4GeometryCell &gCell, const G4UpperEnergyToLowerWeightMap &enWeMap)
void	Clear ()
virtual G4double	GetLowerWeight (const G4GeometryCell &gCell, G4double partEnergy) const
virtual const G4VPhysicalVolume *	GetParallelWorldVolumePointer () const
virtual const G4VPhysicalVolume &	GetWorldVolume () const
virtual G4bool	IsKnown (const G4GeometryCell &gCell) const
void	SetGeneralUpperEnergyBounds (const std::set< G4double, std::less< G4double > > &enBounds)
void	SetParallelWorldVolume (const G4String &paraName)
void	SetWorldVolume ()

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

Protected Member Functions
	G4WeightWindowStore ()
	G4WeightWindowStore (const G4String &ParallelWorldName)
	~G4WeightWindowStore ()

Private Member Functions
void	Error (const G4String &m) const
G4bool	IsInWorld (const G4VPhysicalVolume &) const
void	SetInternalIterator (const G4GeometryCell &gCell) const

Private Attributes
G4GeometryCellWeight	fCellToUpEnBoundLoWePairsMap
G4GeometryCellWeight::const_iterator	fCurrentIterator
std::set< G4double, std::less< G4double > >	fGeneralUpperEnergyBounds
const G4VPhysicalVolume *	fWorldVolume = nullptr

Static Private Attributes
static G4ThreadLocal G4WeightWindowStore *	fInstance = nullptr

Detailed Description

Definition at line 45 of file G4WeightWindowStore.hh.

Constructor & Destructor Documentation

G4WeightWindowStore() [1/2]

G4WeightWindowStore::G4WeightWindowStore ( )

explicitprotected

Definition at line 43 of file G4WeightWindowStore.cc.

 : fWorldVolume(G4TransportationManager::GetTransportationManager()
                ->GetNavigatorForTracking()->GetWorldVolume()),
   fGeneralUpperEnergyBounds(),
   fCellToUpEnBoundLoWePairsMap(),
   fCurrentIterator(fCellToUpEnBoundLoWePairsMap.cend())
{
}

Referenced by GetInstance().

G4WeightWindowStore() [2/2]

G4WeightWindowStore::G4WeightWindowStore ( const G4String &  ParallelWorldName )

explicitprotected

Definition at line 53 of file G4WeightWindowStore.cc.

 : fWorldVolume(G4TransportationManager::GetTransportationManager()
                ->GetParallelWorld(ParallelWorldName)),
   fGeneralUpperEnergyBounds(),
   fCellToUpEnBoundLoWePairsMap(),
   fCurrentIterator(fCellToUpEnBoundLoWePairsMap.cend())
{
}

~G4WeightWindowStore()

G4WeightWindowStore::~G4WeightWindowStore ( )

protected

Definition at line 63 of file G4WeightWindowStore.cc.

{
}

Member Function Documentation

AddLowerWeights()

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

Definition at line 163 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 (auto it = fGeneralUpperEnergyBounds.cbegin(); 
            it != fGeneralUpperEnergyBounds.cend(); ++it)
  {
    map[*it] = lowerWeights[i];
    ++i;
  }
  fCellToUpEnBoundLoWePairsMap[gCell] = map;
}

References Error(), fCellToUpEnBoundLoWePairsMap, fGeneralUpperEnergyBounds, IsKnown(), and anonymous_namespace{G4QuasiElRatios.cc}::map.

AddUpperEboundLowerWeightPairs()

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

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

References Error(), fCellToUpEnBoundLoWePairsMap, and IsKnown().

Clear()

void G4WeightWindowStore::Clear

(

)

Definition at line 131 of file G4WeightWindowStore.cc.

{
  fCellToUpEnBoundLoWePairsMap.clear();
}

References fCellToUpEnBoundLoWePairsMap.

Error()

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

private

Definition at line 222 of file G4WeightWindowStore.cc.

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

References FatalException, and G4Exception().

Referenced by AddLowerWeights(), AddUpperEboundLowerWeightPairs(), GetLowerWeight(), and SetGeneralUpperEnergyBounds().

GetInstance() [1/2]

G4WeightWindowStore * G4WeightWindowStore::GetInstance ( )

static

Definition at line 233 of file G4WeightWindowStore.cc.

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

References fInstance, and G4WeightWindowStore().

Referenced by G4WeightWindowBiasing::ConstructProcess().

GetInstance() [2/2]

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

static

Definition at line 247 of file G4WeightWindowStore.cc.

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

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

GetLowerWeight()

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

virtual

Implements G4VWeightWindowStore.

Definition at line 68 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 (auto it = upEnLoWeiPairs.cbegin(); it != upEnLoWeiPairs.cend(); ++it)
  {
    if (partEnergy < it->first)
    {
      lowerWeight = it->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;
}

References Error(), fCellToUpEnBoundLoWePairsMap, fCurrentIterator, G4endl, and SetInternalIterator().

GetParallelWorldVolumePointer()

const G4VPhysicalVolume * G4WeightWindowStore::GetParallelWorldVolumePointer ( ) const

virtual

Definition at line 157 of file G4WeightWindowStore.cc.

{
  return fWorldVolume;
}

References fWorldVolume.

GetWorldVolume()

const G4VPhysicalVolume & G4WeightWindowStore::GetWorldVolume ( ) const

virtual

Implements G4VWeightWindowStore.

Definition at line 152 of file G4WeightWindowStore.cc.

{
  return *fWorldVolume;
}

References fWorldVolume.

IsInWorld()

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

private

Definition at line 107 of file G4WeightWindowStore.cc.

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

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

Referenced by IsKnown().

IsKnown()

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

virtual

Implements G4VWeightWindowStore.

Definition at line 118 of file G4WeightWindowStore.cc.

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

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

Referenced by AddLowerWeights(), and AddUpperEboundLowerWeightPairs().

SetGeneralUpperEnergyBounds()

void G4WeightWindowStore::SetGeneralUpperEnergyBounds

(

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

enBounds

)

Definition at line 211 of file G4WeightWindowStore.cc.

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

References Error(), and fGeneralUpperEnergyBounds.

SetInternalIterator()

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

private

Definition at line 101 of file G4WeightWindowStore.cc.

{
  fCurrentIterator = fCellToUpEnBoundLoWePairsMap.find(gCell);
}

References fCellToUpEnBoundLoWePairsMap, and fCurrentIterator.

Referenced by GetLowerWeight(), and IsKnown().

SetParallelWorldVolume()

void G4WeightWindowStore::SetParallelWorldVolume

(

const G4String &

paraName

)

Definition at line 145 of file G4WeightWindowStore.cc.

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

References fWorldVolume, G4TransportationManager::GetParallelWorld(), and G4TransportationManager::GetTransportationManager().

SetWorldVolume()

void G4WeightWindowStore::SetWorldVolume

(

)

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

fCellToUpEnBoundLoWePairsMap

G4GeometryCellWeight G4WeightWindowStore::fCellToUpEnBoundLoWePairsMap

private

Definition at line 106 of file G4WeightWindowStore.hh.

Referenced by AddLowerWeights(), AddUpperEboundLowerWeightPairs(), Clear(), GetLowerWeight(), IsKnown(), and SetInternalIterator().

fCurrentIterator

G4GeometryCellWeight::const_iterator G4WeightWindowStore::fCurrentIterator

mutableprivate

Definition at line 107 of file G4WeightWindowStore.hh.

Referenced by GetLowerWeight(), IsKnown(), and SetInternalIterator().

fGeneralUpperEnergyBounds

std::set<G4double, std::less<G4double> > G4WeightWindowStore::fGeneralUpperEnergyBounds

private

Definition at line 105 of file G4WeightWindowStore.hh.

Referenced by AddLowerWeights(), and SetGeneralUpperEnergyBounds().

fInstance

G4ThreadLocal G4WeightWindowStore * G4WeightWindowStore::fInstance = nullptr

staticprivate

Definition at line 109 of file G4WeightWindowStore.hh.

Referenced by GetInstance().

fWorldVolume

const G4VPhysicalVolume* G4WeightWindowStore::fWorldVolume = nullptr

private

Definition at line 103 of file G4WeightWindowStore.hh.

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

---

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

• source/geometry/biasing/include/G4WeightWindowStore.hh
• source/geometry/biasing/src/G4WeightWindowStore.cc