G4Region Class Reference

#include <G4Region.hh>

Public Member Functions
	G4Region (const G4String &name)
virtual	~G4Region ()
	G4Region (const G4Region &)=delete
G4Region &	operator= (const G4Region &)=delete
G4bool	operator== (const G4Region &rg) const
void	AddRootLogicalVolume (G4LogicalVolume *lv, G4bool search=true)
void	RemoveRootLogicalVolume (G4LogicalVolume *lv, G4bool scan=true)
void	SetName (const G4String &name)
const G4String &	GetName () const
void	RegionModified (G4bool flag)
G4bool	IsModified () const
void	SetProductionCuts (G4ProductionCuts *cut)
G4ProductionCuts *	GetProductionCuts () const
std::vector< G4LogicalVolume * >::iterator	GetRootLogicalVolumeIterator ()
std::vector< G4Material * >::const_iterator	GetMaterialIterator () const
size_t	GetNumberOfMaterials () const
size_t	GetNumberOfRootVolumes () const
void	UpdateMaterialList ()
void	ClearMaterialList ()
void	ScanVolumeTree (G4LogicalVolume *lv, G4bool region)
void	SetUserInformation (G4VUserRegionInformation *ui)
G4VUserRegionInformation *	GetUserInformation () const
void	SetUserLimits (G4UserLimits *ul)
G4UserLimits *	GetUserLimits () const
void	ClearMap ()
void	RegisterMaterialCouplePair (G4Material *mat, G4MaterialCutsCouple *couple)
G4MaterialCutsCouple *	FindCouple (G4Material *mat)
void	SetFastSimulationManager (G4FastSimulationManager *fsm)
G4FastSimulationManager *	GetFastSimulationManager () const
void	ClearFastSimulationManager ()
void	SetFieldManager (G4FieldManager *fm)
G4FieldManager *	GetFieldManager () const
G4VPhysicalVolume *	GetWorldPhysical () const
void	SetWorld (G4VPhysicalVolume *wp)
G4bool	BelongsTo (G4VPhysicalVolume *thePhys) const
G4Region *	GetParentRegion (G4bool &unique) const
void	SetRegionalSteppingAction (G4UserSteppingAction *rusa)
G4UserSteppingAction *	GetRegionalSteppingAction () const
	G4Region (__void__ &)
G4int	GetInstanceID () const
void	UsedInMassGeometry (G4bool val=true)
void	UsedInParallelGeometry (G4bool val=true)
G4bool	IsInMassGeometry () const
G4bool	IsInParallelGeometry () const

Static Public Member Functions
static const G4RegionManager &	GetSubInstanceManager ()
static void	Clean ()

Detailed Description

Definition at line 95 of file G4Region.hh.

Constructor & Destructor Documentation

G4Region() [1/3]

G4Region::G4Region

(

const G4String &

name

)

Definition at line 65 of file G4Region.cc.

  : fName(pName)
{
 
  instanceID = subInstanceManager.CreateSubInstance();
  G4MT_fsmanager = nullptr;
  G4MT_rsaction = nullptr;
 
  G4RegionStore* rStore = G4RegionStore::GetInstance();
  if (rStore->GetRegion(pName, false))
  {
    std::ostringstream message;
    message << "The region has NOT been registered !" << G4endl
            << "          Region " << pName << " already existing in store !"
            << G4endl;
    G4Exception("G4Region::G4Region()", "GeomMgt1001",
                JustWarning, message);
  }
  else
  {
    rStore->Register(this);
  }
}

~G4Region()

G4Region::~G4Region ( )

virtual

Definition at line 111 of file G4Region.cc.

{
  G4RegionStore::GetInstance()->DeRegister(this);
  if(fUserInfo != nullptr)  { delete fUserInfo; }
}

G4Region() [2/3]

G4Region::G4Region ( const G4Region &  )

delete

G4Region() [3/3]

G4Region::G4Region

(

__void__ &

)

Definition at line 94 of file G4Region.cc.

  : fName("")
{
  instanceID = subInstanceManager.CreateSubInstance();
  G4MT_fsmanager = nullptr;
  G4MT_rsaction = nullptr;
 
  // Register to store
  //
  G4RegionStore::GetInstance()->Register(this);
}

Member Function Documentation

AddRootLogicalVolume()

void G4Region::AddRootLogicalVolume	(	G4LogicalVolume *	lv,
		G4bool	search = true
	)

Definition at line 283 of file G4Region.cc.

{
  // Check the logical volume is not already in the list
  //
  if (search) 
  {
    auto pos = std::find(fRootVolumes.cbegin(),fRootVolumes.cend(),lv);
    if (pos == fRootVolumes.cend())
    {
      // Insert the root volume in the list and set it as root region
      //
      fRootVolumes.push_back(lv);
      lv->SetRegionRootFlag(true);
    }
  }
  else  // WARNING: user *MUST* guarantee lv is not already inserted.
  {     // Providing speedup for very complex flat geometries
    fRootVolumes.push_back(lv);
    lv->SetRegionRootFlag(true);
  }
  // Scan recursively the tree of daugther volumes and set regions
  //
  ScanVolumeTree(lv, true);
 
  // Set region as modified
  //
  fRegionMod = true;
}

Referenced by G4RunManagerKernel::CheckRegions(), and G4RunManagerKernel::DefineWorldVolume().

BelongsTo()

G4bool G4Region::BelongsTo

(

G4VPhysicalVolume *

thePhys

)

const

Definition at line 404 of file G4Region.cc.

{
  G4LogicalVolume* currLog = thePhys->GetLogicalVolume();
  if (currLog->GetRegion()==this) {return true;}
 
  G4int nDaughters = currLog->GetNoDaughters();
  while (nDaughters--)  // Loop checking, 06.08.2015, G.Cosmo
  {
    if (BelongsTo(currLog->GetDaughter(nDaughters))) {return true;}
  }
 
  return false;
}

Referenced by BelongsTo(), G4RunManagerKernel::CheckRegions(), and SetWorld().

Clean()

void G4Region::Clean ( )

static

Definition at line 346 of file G4Region.cc.

{
  subInstanceManager.FreeSlave();
}

Referenced by G4RegionStore::~G4RegionStore().

ClearFastSimulationManager()

void G4Region::ClearFastSimulationManager

(

)

Definition at line 424 of file G4Region.cc.

{
  G4bool isUnique;
  G4Region* parent = GetParentRegion(isUnique);
  if(parent != nullptr)
  {
    if (isUnique)
    {
      G4MT_fsmanager = parent->GetFastSimulationManager();
    }
    else
    {
      std::ostringstream message;
      message << "Region <" << fName << "> belongs to more than"
              << " one parent region !" << G4endl
              << "A region cannot belong to more than one direct parent region,"
              << G4endl
              << "to have fast-simulation assigned.";
      G4Exception("G4Region::ClearFastSimulationManager()",
                  "GeomMgt1002", JustWarning, message);
      G4MT_fsmanager = nullptr;
    }
  }
  else
  {
    G4MT_fsmanager = nullptr;
  }
}

Referenced by G4FastSimulationManager::~G4FastSimulationManager().

ClearMap()

void G4Region::ClearMap ( )

inline

ClearMaterialList()

void G4Region::ClearMaterialList

(

)

Definition at line 356 of file G4Region.cc.

{
  fMaterials.clear();
}

Referenced by UpdateMaterialList().

FindCouple()

G4MaterialCutsCouple * G4Region::FindCouple ( G4Material *  mat )

inline

Referenced by G4PAIModel::Initialise(), G4PAIPhotModel::Initialise(), and G4LogicalVolume::UpdateMaterial().

GetFastSimulationManager()

G4FastSimulationManager * G4Region::GetFastSimulationManager

(

)

const

Definition at line 130 of file G4Region.cc.

{
  return G4MT_fsmanager;
}

Referenced by ClearFastSimulationManager(), G4RunManagerKernel::DumpRegion(), G4VFastSimulationModel::G4VFastSimulationModel(), G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster(), and G4FastSimulationManager::~G4FastSimulationManager().

GetFieldManager()

G4FieldManager * G4Region::GetFieldManager ( ) const

inline

Referenced by G4VFieldModel::DescribeYourselfTo(), and G4PropagatorInField::FindAndSetFieldManager().

GetInstanceID()

G4int G4Region::GetInstanceID ( ) const

inline

GetMaterialIterator()

std::vector< G4Material * >::const_iterator G4Region::GetMaterialIterator ( ) const

inline

Referenced by G4RunManagerKernel::DumpRegion().

GetName()

const G4String & G4Region::GetName ( ) const

inline

Referenced by G4RunManagerKernel::CheckRegions(), G4PhysicalVolumeModel::CreateCurrentAttValues(), G4RunManagerKernel::DefineWorldVolume(), G4EmModelManager::DumpModelList(), G4RunManagerKernel::DumpRegion(), G4EmCalculator::FindCouple(), G4NeutrinoElectronProcess::GetMeanFreePath(), G4ElNeutrinoNucleusProcess::GetMeanFreePath(), G4MuNeutrinoNucleusProcess::GetMeanFreePath(), G4EmBiasingManager::Initialise(), G4PAIModel::Initialise(), G4PAIPhotModel::Initialise(), G4EmModelManager::Initialise(), G4FastSimulationManager::ListTitle(), G4NeutrinoElectronProcess::PostStepDoIt(), G4ElNeutrinoNucleusProcess::PostStepDoIt(), G4MuNeutrinoNucleusProcess::PostStepDoIt(), G4VEnergyLossProcess::PreparePhysicsTable(), and G4GlobalFastSimulationManager::ShowSetup().

GetNumberOfMaterials()

size_t G4Region::GetNumberOfMaterials ( ) const

inline

Referenced by G4RunManagerKernel::DumpRegion().

GetNumberOfRootVolumes()

size_t G4Region::GetNumberOfRootVolumes ( ) const

inline

Referenced by G4RunManagerKernel::DumpRegion(), and G4RunManagerKernel::SetupDefaultRegion().

GetParentRegion()

G4Region * G4Region::GetParentRegion

(

G4bool &

unique

)

const

Definition at line 459 of file G4Region.cc.

{
  G4Region* parent = nullptr; unique = true;
  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
 
  // Loop over all logical volumes in the store
  //
  for(auto lvItr=lvStore->cbegin(); lvItr!=lvStore->cend(); ++lvItr)
  {
    G4int nD = (*lvItr)->GetNoDaughters();
    G4Region* aR = (*lvItr)->GetRegion();
 
    // Loop over all daughters of each logical volume
    //
    for(auto iD=0; iD<nD; ++iD)
    {
      if((*lvItr)->GetDaughter(iD)->GetLogicalVolume()->GetRegion()==this)
      { 
        if(parent)
        {
          if(parent!=aR) { unique = false; }
        }
        else  // Cache LV parent region which includes a daughter volume
              // with the same associated region as the current one
        {
          parent = aR;
        }
      }
    }
  }
  return parent;
}

Referenced by ClearFastSimulationManager().

GetProductionCuts()

G4ProductionCuts * G4Region::GetProductionCuts ( ) const

inline

Referenced by G4RunManagerKernel::CheckRegions(), G4RunManagerKernel::DumpRegion(), G4GDMLWriteStructure::ExportEnergyCuts(), G4EmCalculator::FindCouple(), G4VUserPhysicsList::GetCutValue(), G4VAtomDeexcitation::InitialiseAtomicDeexcitation(), G4VUserPhysicsList::SetParticleCuts(), and G4ParallelWorldProcess::SwitchMaterial().

GetRegionalSteppingAction()

G4UserSteppingAction * G4Region::GetRegionalSteppingAction

(

)

const

Definition at line 148 of file G4Region.cc.

{
  return G4MT_rsaction;
}

Referenced by G4RunManagerKernel::DumpRegion(), G4SteppingManager::Stepping(), and G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster().

GetRootLogicalVolumeIterator()

std::vector< G4LogicalVolume * >::iterator G4Region::GetRootLogicalVolumeIterator ( )

inline

Referenced by G4RunManagerKernel::DumpRegion(), and G4RunManagerKernel::SetupDefaultRegion().

GetSubInstanceManager()

const G4RegionManager & G4Region::GetSubInstanceManager ( )

static

Definition at line 55 of file G4Region.cc.

{
  return subInstanceManager;
}

Referenced by G4GeometryWorkspace::G4GeometryWorkspace().

GetUserInformation()

G4VUserRegionInformation * G4Region::GetUserInformation ( ) const

inline

Referenced by G4RunManagerKernel::DumpRegion().

GetUserLimits()

G4UserLimits * G4Region::GetUserLimits ( ) const

inline

Referenced by G4RunManagerKernel::DumpRegion().

GetWorldPhysical()

G4VPhysicalVolume * G4Region::GetWorldPhysical ( ) const

inline

Referenced by G4RunManagerKernel::DumpRegion(), and G4FastSimulationManager::ListTitle().

IsInMassGeometry()

G4bool G4Region::IsInMassGeometry ( ) const

inline

Referenced by G4RunManagerKernel::CheckRegions(), and G4RunManagerKernel::DumpRegion().

IsInParallelGeometry()

G4bool G4Region::IsInParallelGeometry ( ) const

inline

Referenced by G4RunManagerKernel::CheckRegions(), and G4RunManagerKernel::DumpRegion().

IsModified()

G4bool G4Region::IsModified ( ) const

inline

operator=()

G4Region & G4Region::operator= ( const G4Region &  )

delete

operator==()

G4bool G4Region::operator== ( const G4Region &  rg ) const

inline

RegionModified()

void G4Region::RegionModified ( G4bool  flag )

inline

Referenced by G4LogicalVolume::AddDaughter(), G4LogicalVolume::ClearDaughters(), and G4LogicalVolume::RemoveDaughter().

RegisterMaterialCouplePair()

void G4Region::RegisterMaterialCouplePair ( G4Material *  mat, G4MaterialCutsCouple *  couple  )

inline

RemoveRootLogicalVolume()

void G4Region::RemoveRootLogicalVolume	(	G4LogicalVolume *	lv,
		G4bool	scan = true
	)

Definition at line 318 of file G4Region.cc.

{
  // Find and remove logical volume from the list
  //
  auto pos = std::find(fRootVolumes.cbegin(),fRootVolumes.cend(),lv);
  if (pos != fRootVolumes.cend())
  {
    if (fRootVolumes.size() != 1)  // Avoid resetting flag for world since
    {                              // volume may be already deleted !
      lv->SetRegionRootFlag(false);
    }
    fRootVolumes.erase(pos);
  }
 
  if (scan)  // Update the materials list
  {
    UpdateMaterialList();
  }
 
  // Set region as modified
  //
  fRegionMod = true;
}

Referenced by G4RunManagerKernel::SetupDefaultRegion(), and G4LogicalVolume::~G4LogicalVolume().

ScanVolumeTree()

void G4Region::ScanVolumeTree	(	G4LogicalVolume *	lv,
		G4bool	region
	)

Definition at line 162 of file G4Region.cc.

{
  // If logical volume is going to become a region, add 
  // its material to the list if not already present
  //
  G4Region* currentRegion = nullptr;
  size_t noDaughters = lv->GetNoDaughters();
  G4Material* volMat = lv->GetMaterial();
  if((volMat == nullptr) && fInMassGeometry)
  {
    std::ostringstream message;
    message << "Logical volume <" << lv->GetName() << ">" << G4endl
            << "does not have a valid material pointer." << G4endl
            << "A logical volume belonging to the (tracking) world volume "
            << "must have a valid material.";
    G4Exception("G4Region::ScanVolumeTree()", "GeomMgt0002",
                FatalException, message, "Check your geometry construction.");
  }
  if (region)
  {
    currentRegion = this;
    if (volMat != nullptr)
    { 
      AddMaterial(volMat); 
      G4Material* baseMat = const_cast<G4Material*>(volMat->GetBaseMaterial());
      if (baseMat != nullptr) { AddMaterial(baseMat); }
    }
  }
 
  // Set the LV region to be either the current region or NULL,
  // according to the boolean selector
  //
  lv->SetRegion(currentRegion);
 
  // Stop recursion here if no further daughters are involved
  //
  if(noDaughters==0) return;
 
  G4VPhysicalVolume* daughterPVol = lv->GetDaughter(0);
  if (daughterPVol->IsParameterised())
  {
    // Adopt special treatment in case of parameterised volumes,
    // where parameterisation involves a new material scan
    //
    G4VPVParameterisation* pParam = daughterPVol->GetParameterisation();
 
    if (pParam->GetMaterialScanner() != nullptr)
    {
      size_t matNo = pParam->GetMaterialScanner()->GetNumberOfMaterials();
      for (size_t mat=0; mat<matNo; ++mat)
      {
        volMat = pParam->GetMaterialScanner()->GetMaterial(mat);
        if(!volMat && fInMassGeometry)
        {
          std::ostringstream message;
          message << "The parameterisation for the physical volume <"
                  << daughterPVol->GetName() << ">" << G4endl
                  << "does not return a valid material pointer." << G4endl
                  << "A volume belonging to the (tracking) world volume must "
                  << "have a valid material.";
          G4Exception("G4Region::ScanVolumeTree()", "GeomMgt0002",
                      FatalException, message, "Check your parameterisation.");
        }
        if (volMat != nullptr)
        { 
          AddMaterial(volMat); 
          G4Material* baseMat = const_cast<G4Material*>(volMat->GetBaseMaterial());
          if (baseMat != nullptr) { AddMaterial(baseMat); }
        }
      }
    }
    else
    {
      size_t repNo = daughterPVol->GetMultiplicity();
      for (size_t rep=0; rep<repNo; ++rep)
      {
        volMat = pParam->ComputeMaterial(rep, daughterPVol);
        if((volMat == nullptr) && fInMassGeometry)
        {
          std::ostringstream message;
          message << "The parameterisation for the physical volume <"
                  << daughterPVol->GetName() << ">" << G4endl
                  << "does not return a valid material pointer." << G4endl
                  << "A volume belonging to the (tracking) world volume must "
                  << "have a valid material.";
          G4Exception("G4Region::ScanVolumeTree()", "GeomMgt0002",
                      FatalException, message, "Check your parameterisation.");
        }
        if(volMat != nullptr)
        { 
          AddMaterial(volMat);
          G4Material* baseMat = const_cast<G4Material*>(volMat->GetBaseMaterial());
          if (baseMat != nullptr) { AddMaterial(baseMat); }
        }
      }
    }
    G4LogicalVolume* daughterLVol = daughterPVol->GetLogicalVolume();
    ScanVolumeTree(daughterLVol, region);
  }
  else
  {
    for (size_t i=0; i<noDaughters; ++i)
    {
      G4LogicalVolume* daughterLVol = lv->GetDaughter(i)->GetLogicalVolume();
      if (!daughterLVol->IsRootRegion())
      {
        // Set daughter's LV to be a region and store materials in
        // the materials list, if the LV is not already a root region
        //
        ScanVolumeTree(daughterLVol, region);
      }
    }
  }
}

Referenced by AddRootLogicalVolume(), ScanVolumeTree(), and UpdateMaterialList().

SetFastSimulationManager()

void G4Region::SetFastSimulationManager

(

G4FastSimulationManager *

fsm

)

Definition at line 121 of file G4Region.cc.

{
  G4MT_fsmanager = fsm;
}

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

SetFieldManager()

void G4Region::SetFieldManager ( G4FieldManager *  fm )

inline

SetName()

void G4Region::SetName ( const G4String &  name )

inline

SetProductionCuts()

void G4Region::SetProductionCuts ( G4ProductionCuts *  cut )

inline

Referenced by G4RunManagerKernel::CheckRegions(), G4RunManagerKernel::DumpRegion(), G4RunManagerKernel::G4RunManagerKernel(), and G4VUserPhysicsList::SetParticleCuts().

SetRegionalSteppingAction()

void G4Region::SetRegionalSteppingAction

(

G4UserSteppingAction *

rusa

)

Definition at line 139 of file G4Region.cc.

{
  G4MT_rsaction = rusa;
}

Referenced by G4WorkerThread::UpdateGeometryAndPhysicsVectorFromMaster().

SetUserInformation()

void G4Region::SetUserInformation ( G4VUserRegionInformation *  ui )

inline

SetUserLimits()

void G4Region::SetUserLimits ( G4UserLimits *  ul )

inline

SetWorld()

void G4Region::SetWorld

(

G4VPhysicalVolume *

wp

)

Definition at line 388 of file G4Region.cc.

{
  if(!wp)
  { fWorldPhys = 0; }
  else
  { if(BelongsTo(wp)) fWorldPhys = wp; }
 
  return;
}

Referenced by G4RunManagerKernel::CheckRegions().

UpdateMaterialList()

void G4Region::UpdateMaterialList

(

)

Definition at line 367 of file G4Region.cc.

{
  // Reset the materials list
  //
  ClearMaterialList();
 
  // Loop over the root logical volumes and rebuild the list
  // of materials from scratch
  //
  for (auto pLV=fRootVolumes.cbegin(); pLV!=fRootVolumes.cend(); ++pLV)
  {
    ScanVolumeTree(*pLV, true);
  }
}

Referenced by RemoveRootLogicalVolume().

UsedInMassGeometry()

void G4Region::UsedInMassGeometry ( G4bool  val = true )

inline

Referenced by G4RunManagerKernel::CheckRegions().

UsedInParallelGeometry()

void G4Region::UsedInParallelGeometry ( G4bool  val = true )

inline

Referenced by G4RunManagerKernel::CheckRegions().

---

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

• G4Region.hh
• G4Region.cc