Geo2G4Builder Class Reference

Main builder to create/position all volumes described in a GeoModel Tree. More...

#include <Geo2G4Builder.h>

Inheritance diagram for Geo2G4Builder:

Collaboration diagram for Geo2G4Builder:

Public Member Functions
	Geo2G4Builder (const std::string &detectorName)
	~Geo2G4Builder ()=default
G4LogicalVolume *	BuildTree ()
void	BuildOpticalSurfaces (const GeoBorderSurfaceContainer *surface_container, const OpticalVolumesMap *optical_volumes)
VolumeBuilder *	GetVolumeBuilder (std::string)
HepGeom::Transform3D	GetDetectorTransform ()
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::string	m_detectorName
GeoTrf::Transform3D	m_motherTransform
std::vector< PVConstLink >	m_treeTops
VolumeBuilder *	m_theBuilder
const GeoMaterial *	m_matAir {nullptr}
ServiceHandle< StoreGateSvc >	m_pDetStore {"DetectorStore", "Geo2G4Builder"}
ServiceHandle< IGeo2G4Svc >	m_g2gSvc {"Geo2G4Svc", "Geo2G4Builder"}
GeoModelExperiment *	m_theExpt {nullptr}
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Main builder to create/position all volumes described in a GeoModel Tree.

Definition at line 33 of file Geo2G4Builder.h.

Constructor & Destructor Documentation

Geo2G4Builder()

Geo2G4Builder::Geo2G4Builder

(

const std::string &

detectorName

)

Definition at line 32 of file Geo2G4Builder.cxx.

  : AthMessaging("Geo2G4Builder")
  , m_detectorName(detectorName)
  , m_motherTransform(GeoTrf::Transform3D::Identity()) {
  if (m_pDetStore.retrieve().isFailure()) {
    THROW_EXCEPTION("ERROR: Geo2G4Builder for detector "<< detectorName << " could not access the detector store.");
  }
 
  StatusCode sc = m_pDetStore->retrieve( m_theExpt, "ATLAS" );
  if(sc.isFailure()){
    THROW_EXCEPTION(detectorName<<" could not get GeoModelExperiment");
  }
 
  const GeoVDetectorManager *theManager = m_theExpt->getManager(detectorName);
  if (!theManager) {
      THROW_EXCEPTION("Failed to retrieve manager "<<detectorName);
  }
  ATH_MSG_DEBUG("Recieve detctor manager "<<detectorName);
  for(unsigned int i=0; i<theManager->getNumTreeTops(); ++i) {
    m_treeTops.push_back(theManager->getTreeTop(i));
  }
 
  ATH_MSG_DEBUG("Found detector: top volume(s)");
  for(unsigned int i=0; i<m_treeTops.size();++i) {
      ATH_MSG_DEBUG( "   Tree Top " << i << " " << m_treeTops[i]->getLogVol()->getName() );
  }
 
  if(m_treeTops.size()>1) {
      // -------- -------- MATERIAL MANAGER -------- ----------
      StoredMaterialManager* theMaterialManager = m_pDetStore->tryRetrieve<StoredMaterialManager>("MATERIALS");
      if(theMaterialManager) {
              m_matAir = theMaterialManager->getMaterial("std::Air");
      } else {
        m_matAir = m_treeTops[0]->getLogVol()->getMaterial();
      }
  }
 
  if (m_g2gSvc.retrieve().isFailure()) {
    THROW_EXCEPTION("Failed to retrieve manager Geo2G4Svc");
  }
 
  m_theBuilder = m_g2gSvc->GetDefaultBuilder();
  if(m_theBuilder) {
    ATH_MSG_INFO("Set volume builder ---> "<< m_theBuilder->GetKey());
  } else {
    ATH_MSG_WARNING("0 pointer to volume builder."
                    <<"\n Use 'DefaultBuilder' property of Geo2G4Svc or"
                    <<"\n 'GetVolumeBuilder' method of Geo2G4Builder");
  }
}

~Geo2G4Builder()

Geo2G4Builder::~Geo2G4Builder ( )

default

Member Function Documentation

BuildOpticalSurfaces()

void Geo2G4Builder::BuildOpticalSurfaces	(	const GeoBorderSurfaceContainer *	surface_container,
		const OpticalVolumesMap *	optical_volumes )

Definition at line 170 of file Geo2G4Builder.cxx.

{
  Geo2G4OpticalSurfaceFactory surfaceFactory;
 
  for (const GeoBorderSurface& border_surface : *surface_container)
    {
      // Build Optical Surface
      G4OpticalSurface* g4OptSurface = surfaceFactory.Build(border_surface.getOptSurface());
 
      G4VPhysicalVolume* g4PV1 = 0;
      G4VPhysicalVolume* g4PV2 = 0;
      OpticalVolumesMap::const_iterator volIt;
 
      // First physical volume
      volIt = optical_volumes->find(border_surface.getPV1());
      if(volIt == optical_volumes->end())
        {
          ATH_MSG_WARNING("Unable to find " << border_surface.getPV1()->getLogVol()->getName() << " in Optical Volumes map");
          continue;
        }
      g4PV1 = volIt.operator->()->second;
 
      // Second physical volume
      volIt = optical_volumes->find(border_surface.getPV2());
      if(volIt == optical_volumes->end())
        {
          ATH_MSG_WARNING("Unable to find " << border_surface.getPV2()->getLogVol()->getName() << " in Optical Volumes map");
          continue;
        }
      g4PV2 = volIt.operator->()->second;
 
      // G4LogicalBorderSurface
      G4LogicalBorderSurface* g4BorderSurface __attribute__((unused)) = new G4LogicalBorderSurface(border_surface.getName(),g4PV1,g4PV2,g4OptSurface);
    }
}

BuildTree()

G4LogicalVolume * Geo2G4Builder::BuildTree

(

)

Definition at line 83 of file Geo2G4Builder.cxx.

{
  ATH_MSG_DEBUG("Entering Geo2G4Builder::BuildTree()...");
  G4LogicalVolume* result = nullptr;
  std::unique_ptr<OpticalVolumesMap> optical_volumes{};
  const GeoBorderSurfaceContainer* surface_container = nullptr;
 
  // Check whether we have to deal with optical surfaces
  if(m_pDetStore->contains<GeoBorderSurfaceContainer>(m_detectorName)) {
    StatusCode sc = m_pDetStore->retrieve(surface_container,m_detectorName);
    if(sc.isSuccess() && surface_container->size()>0) {
      optical_volumes = std::make_unique<OpticalVolumesMap>();
    }
  }
 
  if(m_theBuilder) {
    if(m_treeTops.size()==1) {
      m_motherTransform = m_treeTops[0]->getX();
      result = m_theBuilder->Build(m_treeTops[0], optical_volumes.get());
    } else if (!m_treeTops.empty()) {
      // Create temporary GeoModel physical volume
      // The shape is composed by TreeTop shapes + their transforms
      const GeoShape& shFirst = (*(m_treeTops[0]->getLogVol()->getShape()))<<(m_treeTops[0]->getX());
      GeoIntrusivePtr<const GeoShape> shResult{&shFirst};
 
      for(unsigned int i=1; i<m_treeTops.size(); i++) {
        GeoIntrusivePtr<const GeoShape> booleanOp{&shResult->add((*(m_treeTops[i]->getLogVol()->getShape()))<<(m_treeTops[i]->getX()))};
        shResult = booleanOp;
      }
 
      auto lvEnvelope = make_intrusive<GeoLogVol>(m_detectorName, shResult, m_matAir);
      auto pvEnvelope = make_intrusive<GeoPhysVol>(lvEnvelope);
      m_theExpt->addTmpVolume(pvEnvelope);
      result = m_theBuilder->Build(pvEnvelope);
 
      // Get pointer to the World
      PVConstLink world = m_treeTops[0]->getParent();
 
      // Add all tree tops to the result
      for(unsigned int i=0; i<m_treeTops.size(); i++) {
        // Current Tree Top and its index
        PVConstLink pv = m_treeTops[i];
        std::optional<unsigned int> childIndx = world->indexOf(pv);
 
        // Tree Top transformation
        G4Transform3D theG4Position(Amg::EigenTransformToCLHEP(world->getXToChildVol(*childIndx)));
 
        // Copy number
        int id = 16969;
        std::optional<int> Qint = world->getIdOfChildVol(*childIndx);
        if(Qint) id = *Qint;
 
        // PV Tree Top name
        std::string nameTT =  world->getNameOfChildVol(*childIndx);
        if (nameTT == "ANON") nameTT = pv->getLogVol()->getName();
 
 
        G4LogicalVolume* g4LV = m_theBuilder->Build(pv, optical_volumes.get());
        G4ReflectionFactory::Instance()->Place(theG4Position,
                                               nameTT,
                                               g4LV,
                                               result,
                                               false,
                                               id);
      }
    }
  }
 
  // build optical surfaces if necessary
  if(optical_volumes) {
    if(optical_volumes->size()>0) {
      BuildOpticalSurfaces(surface_container,optical_volumes.get());
    } else {
      ATH_MSG_WARNING("Optical volumes apparently requested, but none found!  Deleting temps");
    }
  }
 
  return result;
}

GetDetectorTransform()

HepGeom::Transform3D Geo2G4Builder::GetDetectorTransform ( )

inline

Definition at line 51 of file Geo2G4Builder.h.

{return Amg::EigenTransformToCLHEP(m_motherTransform);}

GetVolumeBuilder()

VolumeBuilder * Geo2G4Builder::GetVolumeBuilder

(

std::string

bname

)

Definition at line 164 of file Geo2G4Builder.cxx.

{
  m_theBuilder = m_g2gSvc->GetVolumeBuilder(std::move(bname));
  return m_theBuilder;
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_detectorName

std::string Geo2G4Builder::m_detectorName

private

Definition at line 56 of file Geo2G4Builder.h.

m_g2gSvc

ServiceHandle<IGeo2G4Svc> Geo2G4Builder::m_g2gSvc {"Geo2G4Svc", "Geo2G4Builder"}

private

Definition at line 64 of file Geo2G4Builder.h.

{"Geo2G4Svc", "Geo2G4Builder"};

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_matAir

const GeoMaterial* Geo2G4Builder::m_matAir {nullptr}

private

Definition at line 62 of file Geo2G4Builder.h.

{nullptr};

m_motherTransform

GeoTrf::Transform3D Geo2G4Builder::m_motherTransform

private

Definition at line 57 of file Geo2G4Builder.h.

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_pDetStore

ServiceHandle<StoreGateSvc> Geo2G4Builder::m_pDetStore {"DetectorStore", "Geo2G4Builder"}

private

Definition at line 63 of file Geo2G4Builder.h.

{"DetectorStore", "Geo2G4Builder"};

m_theBuilder

VolumeBuilder* Geo2G4Builder::m_theBuilder

private

Definition at line 59 of file Geo2G4Builder.h.

m_theExpt

GeoModelExperiment* Geo2G4Builder::m_theExpt {nullptr}

private

Definition at line 65 of file Geo2G4Builder.h.

{nullptr};

m_treeTops

std::vector<PVConstLink> Geo2G4Builder::m_treeTops

private

Definition at line 58 of file Geo2G4Builder.h.

---

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

• Geo2G4Builder.h
• Geo2G4Builder.cxx