RegionCreator Class Reference

Concrete Tool to create G4 Physics Regions. More...

#include "G4AtlasTools/RegionCreator.h"

Inheritance diagram for RegionCreator:

Collaboration diagram for RegionCreator:

Public Member Functions
	RegionCreator (const std::string &type, const std::string &name, const IInterface *parent)
	~RegionCreator ()
virtual StatusCode	initialize () override
void	Dump () override
void	Construct () override

Private Attributes
Gaudi::Property< std::string >	m_regionName {this, "RegionName", "", "Region name (same as the Tool name if not set)"}
Gaudi::Property< double >	m_gammaCut {this, "GammaCut", 1.*Gaudi::Units::mm, "Cut to be applied for gammas"}
Gaudi::Property< double >	m_electronCut {this, "ElectronCut", 1., "Cut to be applied for electrons"}
Gaudi::Property< double >	m_positronCut {this, "PositronCut", 1., "Cut to be applied for positrons"}
Gaudi::Property< double >	m_protonCut {this, "ProtonCut", 1., "Cut to be applied for gammas"}
Gaudi::Property< std::vector< std::string > >	m_logicalVolumes {this, "VolumeList", {}, "List of volumes to be included in this region"}
BooleanProperty	m_dumpRegion {this, "DumpRegion", false, ""}

Detailed Description

Concrete Tool to create G4 Physics Regions.

Author

ADA

Date

2015-03-23

Definition at line 25 of file RegionCreator.h.

Constructor & Destructor Documentation

RegionCreator()

RegionCreator::RegionCreator	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 15 of file RegionCreator.cxx.

  : base_class(type,name,parent)
{
}

~RegionCreator()

RegionCreator::~RegionCreator ( )

inline

Definition at line 29 of file RegionCreator.h.

{}

Member Function Documentation

Construct()

void RegionCreator::Construct ( )

override

Definition at line 38 of file RegionCreator.cxx.

{
  //create a new G4Region
  G4Region* theRegion=new G4Region(m_regionName.value());
 
  // loop over volumes and fish for those in the list
  size_t nVolumes{0};
  G4LogicalVolumeStore* logStore=G4LogicalVolumeStore::GetInstance();
  for (const auto& vol: m_logicalVolumes) {
    size_t nVolumesCurrent{0};
    for (auto* it: *logStore)
      {
 
        if (vol == static_cast<const std::string&>(it->GetName()))
          {
            nVolumesCurrent++;
            it->SetRegion(theRegion);
            theRegion->AddRootLogicalVolume(it);
          }
      }
    if (nVolumesCurrent==0) {
      ATH_MSG_WARNING("No volumes matching \"" << vol << "\" found in G4 LogicalVolumeStore. " << m_regionName.value() << " G4PhysicsRegion may not behave as intended.");
    }
    nVolumes += nVolumesCurrent;
  }
 
  if (m_dumpRegion) { ATH_MSG_INFO("A total of "<<nVolumes<<" volumes was assigned to region "<<m_regionName.value() ); }
 
  // create a G4ProductionCuts object and set appropriate values
  G4ProductionCuts* cuts=new G4ProductionCuts();
  cuts->SetProductionCut(m_gammaCut,"gamma");
  cuts->SetProductionCut(m_electronCut,"e-");
  cuts->SetProductionCut(m_positronCut,"e+");
  cuts->SetProductionCut(m_protonCut,"proton");
 
  // assign cuts to the region and return succesfully
  theRegion->SetProductionCuts(cuts);
 
  if (m_dumpRegion) { Dump(); }
}

Dump()

void RegionCreator::Dump ( )

override

Definition at line 79 of file RegionCreator.cxx.

{
  ATH_MSG_INFO("+----------------------------------------------------+");
  ATH_MSG_INFO(" ");
  ATH_MSG_INFO("    Dump of region  "<<m_regionName.value());
  ATH_MSG_INFO("    Volumes being assigned to this region:");
  for (const auto& vol: m_logicalVolumes)
    {
      ATH_MSG_INFO("      "<<vol);
    }
  ATH_MSG_INFO(" ");
  ATH_MSG_INFO("    Cuts selected for this region:");
  ATH_MSG_INFO("      Gamma    ="<<m_gammaCut);
  ATH_MSG_INFO("      Electron ="<<m_electronCut);
  ATH_MSG_INFO("      Positron ="<<m_positronCut);
  ATH_MSG_INFO("      Proton   ="<<m_protonCut);
  ATH_MSG_INFO(" ");
  ATH_MSG_INFO("+----------------------------------------------------+");
}

initialize()

StatusCode RegionCreator::initialize ( )

overridevirtual

Definition at line 21 of file RegionCreator.cxx.

{
  ATH_MSG_VERBOSE(" initializing RegionCreator "<<name() );
  if (m_regionName.empty()) {
    m_regionName = this->name();
    // re-initialize m_regionName in order to take the real tool name rather than the path to it
    size_t ipos=m_regionName.value().find_last_of('.');
    size_t length=m_regionName.value().size();
    if (ipos<length) {
      ATH_MSG_VERBOSE( "m_regionName: " << m_regionName.value() << " needs to be reset.");
      m_regionName=m_regionName.value().substr(ipos+1,length-ipos-1);
    }
    ATH_MSG_VERBOSE( "m_regionName default value reset to "<<m_regionName.value());
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_dumpRegion

BooleanProperty RegionCreator::m_dumpRegion {this, "DumpRegion", false, ""}

private

Definition at line 44 of file RegionCreator.h.

{this, "DumpRegion", false, ""};

m_electronCut

Gaudi::Property<double> RegionCreator::m_electronCut {this, "ElectronCut", 1., "Cut to be applied for electrons"}

private

Definition at line 40 of file RegionCreator.h.

{this, "ElectronCut", 1., "Cut to be applied for electrons"};

m_gammaCut

Gaudi::Property<double> RegionCreator::m_gammaCut {this, "GammaCut", 1.*Gaudi::Units::mm, "Cut to be applied for gammas"}

private

Definition at line 39 of file RegionCreator.h.

{this, "GammaCut", 1.*Gaudi::Units::mm, "Cut to be applied for gammas"};

m_logicalVolumes

Gaudi::Property<std::vector<std::string> > RegionCreator::m_logicalVolumes {this, "VolumeList", {}, "List of volumes to be included in this region"}

private

Definition at line 43 of file RegionCreator.h.

{this, "VolumeList", {}, "List of volumes to be included in this region"};

m_positronCut

Gaudi::Property<double> RegionCreator::m_positronCut {this, "PositronCut", 1., "Cut to be applied for positrons"}

private

Definition at line 41 of file RegionCreator.h.

{this, "PositronCut", 1., "Cut to be applied for positrons"};

m_protonCut

Gaudi::Property<double> RegionCreator::m_protonCut {this, "ProtonCut", 1., "Cut to be applied for gammas"}

private

Definition at line 42 of file RegionCreator.h.

{this, "ProtonCut", 1., "Cut to be applied for gammas"};

m_regionName

Gaudi::Property<std::string> RegionCreator::m_regionName {this, "RegionName", "", "Region name (same as the Tool name if not set)"}

private

Definition at line 38 of file RegionCreator.h.

{this, "RegionName", "", "Region name (same as the Tool name if not set)"};

---

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

• RegionCreator.h
• RegionCreator.cxx