FANGSCreator Class Reference

The creator for the FANGS geometry. More...

#include <FANGSCreator.h>

Inheritance diagram for FANGSCreator:

Public Member Functions
	FANGSCreator (Simulation::SensitiveDetectorBase *sensitive=nullptr)
	Constructor.
virtual	~FANGSCreator ()
	Destructor.
void	createShape (const std::string &prefix, const GearDir &params, G4LogicalVolume *parent, double roffset, bool check)
	create a shape (box or cylinder) from XML description and place all child shapes in it by recursively calling this function for all children.
virtual void	create (const GearDir &content, G4LogicalVolume &topVolume, geometry::GeometryTypes type)
	Creation of the detector geometry from Gearbox (XML).
	BELLE2_DEFINE_EXCEPTION (DBNotImplemented, "Cannot create geometry from Database.")
	Exception that will be thrown in createFromDB if member is not yet implemented by creator.
virtual void	createFromDB (const std::string &name, G4LogicalVolume &topVolume, GeometryTypes type)
	Function to create the geometry from the Database.
virtual void	createPayloads (const GearDir &content, const IntervalOfValidity &iov)
	Function to create the geometry database.

Protected Attributes
Simulation::SensitiveDetectorBase *	m_sensitive {nullptr}
	pointer to the sensitive detector implementation
G4Material *	m_topMaterial {nullptr}
	pointer to the material in the top volume to use as default
G4UserLimits *	m_stepLength {nullptr}
	pointer to the G4Userlimits to set for sensitive volumes (if any)

Detailed Description

The creator for the FANGS geometry.

Definition at line 29 of file FANGSCreator.h.

Constructor & Destructor Documentation

FANGSCreator()

FANGSCreator

(

Simulation::SensitiveDetectorBase *

sensitive = nullptr

)

Constructor.

Parameters

sensitive

detector instance to use, if null a fangs::SensitiveDetector instance will be created.

Definition at line 36 of file FANGSCreator.cc.

                                                                        : m_sensitive(sensitive)
    {
      /*if (!m_sensitive) {
        m_sensitive = new SensitiveDetector();
      }*/
    }

~FANGSCreator()

~FANGSCreator ( )

virtual

Destructor.

Definition at line 43 of file FANGSCreator.cc.

    {
      delete m_sensitive;
      delete m_stepLength;
    }

Member Function Documentation

create()

void create ( const GearDir &  content, G4LogicalVolume &  topVolume, geometry::GeometryTypes  type  )

virtual

Creation of the detector geometry from Gearbox (XML).

Parameters

[in]	content	XML data directory.
[in]	topVolume	Geant world volume.
[in]	type	Geometry type.

Implements CreatorBase.

Definition at line 106 of file FANGSCreator.cc.

    {
      m_topMaterial = topVolume.GetMaterial();
      double stepLength = content.getLength("stepLength", 0) / Unit::mm * CLHEP::mm;
      if (stepLength > 0) {
        if (m_stepLength) delete m_stepLength;
        m_stepLength = new G4UserLimits(stepLength);
      }
      for (auto shape : content.getNodes("shape")) {
        createShape("", shape, &topVolume, 0, false);
      }
    }

createFromDB()

void createFromDB ( const std::string &  name, G4LogicalVolume &  topVolume, GeometryTypes  type  )

virtualinherited

Function to create the geometry from the Database.

Parameters

name	name of the component in the database, could be used to disambiguate multiple components created with the same creator
topVolume	Top volume in which the geometry has to be placed
type	Type of geometry to be build

Reimplemented in GeoMagneticField, GeoARICHCreator, BeamabortCreator, GeoCDCCreator, GeoCDCCreatorReducedCDC, GeoECLCreator, MyDBCreator, GeoBeamPipeCreator, GeoCryostatCreator, GeoFarBeamLineCreator, GeoBKLMCreator, GeoEKLMCreator, GeoKLMCreator, GeoPXDCreator, GeoCOILCreator, GeoServiceMaterialCreator, GeoSTRCreator, GeoSVDCreator, GeoTOPCreator, GeoHeavyMetalShieldCreator, and GeoVXDServiceCreator.

Definition at line 17 of file CreatorBase.cc.

    {
      //Do nothing but raise exception that we don't do anything
      throw DBNotImplemented();
    }

createPayloads()

void createPayloads ( const GearDir &  content, const IntervalOfValidity &  iov  )

virtualinherited

Function to create the geometry database.

This function should be implemented to convert Gearbox parameters to one ore more database payloads

Parameters

content	GearDir pointing to the parameters which should be used for construction
iov	interval of validity to use when generating payloads

Reimplemented in GeoARICHCreator, BeamabortCreator, GeoCDCCreator, GeoCDCCreatorReducedCDC, GeoECLCreator, GeoMagneticField, MyDBCreator, GeoBeamPipeCreator, GeoCryostatCreator, GeoFarBeamLineCreator, GeoBKLMCreator, GeoEKLMCreator, GeoKLMCreator, GeoPXDCreator, GeoCOILCreator, GeoServiceMaterialCreator, GeoSTRCreator, GeoSVDCreator, GeoTOPCreator, GeoHeavyMetalShieldCreator, and GeoVXDServiceCreator.

Definition at line 24 of file CreatorBase.cc.

{}

createShape()

void createShape	(	const std::string &	prefix,
		const GearDir &	params,
		G4LogicalVolume *	parent,
		double	roffset,
		bool	check
	)

create a shape (box or cylinder) from XML description and place all child shapes in it by recursively calling this function for all children.

Parameters

prefix	prefix of the volume names
params	XML parameters
parent	Logical Volume where to place the shape
roffset	radial offset for the placement
check	if true check for overlaps when placing the volumes

Definition at line 49 of file FANGSCreator.cc.

    {
 
      if (!m_sensitive) {
        m_sensitive = new SensitiveDetector();
      }
 
      std::string name = params.getString("@name");
      if (!prefix.empty()) {
        name = prefix + "." + name;
      }
      const std::string type = params.getString("@type");
      const std::string material = params.getString("material", "");
      const double r = params.getLength("r", 0) / Unit::mm * CLHEP::mm;
      const double top = params.getLength("top", 0) / Unit::mm * CLHEP::mm;
      const double u = params.getLength("u", 0) / Unit::mm * CLHEP::mm;
      const bool active = params.getBool("active", false);
 
      G4Material* mat = m_topMaterial;
      if (!material.empty()) {
        mat = geometry::Materials::get(material);
      }
      G4VSolid* shape{nullptr};
      double height{0};
      if (type == "box") {
        const double length = params.getLength("length") / Unit::mm * CLHEP::mm;
        const double width = params.getLength("width") / Unit::mm * CLHEP::mm;
        height = params.getLength("height") / Unit::mm * CLHEP::mm;
        shape = new G4Box(name, width / 2, height / 2, length / 2);
      } else if (type == "tube") {
        const double length = params.getLength("length") / Unit::mm * CLHEP::mm;
        height = params.getLength("diameter") / Unit::mm * CLHEP::mm;
        shape = new G4Tubs(name, 0, height / 2, length / 2, 0, 2 * M_PI);
      }
      G4LogicalVolume* volume = new G4LogicalVolume(shape, mat, name);
      if (active) {
        volume->SetSensitiveDetector(m_sensitive);
        if (m_stepLength) {
          volume->SetUserLimits(m_stepLength);
        }
      }
      for (const GearDir& child : params.getNodes("shape")) {
        createShape(name, child, volume, height / 2, true);
      }
 
      int copyNo = 1;
      const double center = r + roffset - height / 2 - top;
      for (double phi : params.getArray("phi", {M_PI / 2})) {
        for (double z : params.getArray("z", {0})) {
          z *= CLHEP::mm / Unit::mm;
          G4Transform3D transform = G4RotateZ3D(phi - M_PI / 2) * G4Translate3D(u, center, z);
          new G4PVPlacement(transform, volume, name, parent, false, copyNo++, check);
        }
      }
    }

Member Data Documentation

m_sensitive

Simulation::SensitiveDetectorBase* m_sensitive {nullptr}

protected

pointer to the sensitive detector implementation

Definition at line 61 of file FANGSCreator.h.

m_stepLength

G4UserLimits* m_stepLength {nullptr}

protected

pointer to the G4Userlimits to set for sensitive volumes (if any)

Definition at line 65 of file FANGSCreator.h.

m_topMaterial

G4Material* m_topMaterial {nullptr}

protected

pointer to the material in the top volume to use as default

Definition at line 63 of file FANGSCreator.h.

---

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

• beast/fangs/geometry/include/FANGSCreator.h
• beast/fangs/geometry/src/FANGSCreator.cc