Simple detector construction with a box volume placed in a world. More...

#include <Doxymodules_common.h>

Inheritance diagram for Common::DetectorConstruction:

Public Member Functions
	DetectorConstruction (const G4String &boxMaterialName="G4_AIR", G4double boxHx=40 CLHEP::cm, G4double boxHy=40 CLHEP::cm, G4double boxHz=40 *CLHEP::cm, const G4String &worldMaterialName="G4_AIR", G4double worldSizeFactor=1.25)

	~DetectorConstruction () override

G4VPhysicalVolume *	Construct () override

void	SetBoxMaterial (const G4String &materialName)

void	SetWorldMaterial (const G4String &materialName)

void	SetBoxDimensions (G4ThreeVector dimensions)

void	SetWorldSizeFactor (G4double factor)

Private Member Functions
void	DefineCommands ()

Private Attributes
G4GenericMessenger *	fMessenger = nullptr

G4String	fBoxMaterialName

G4String	fWorldMaterialName

G4ThreeVector	fBoxDimensions

G4double	fWorldSizeFactor = 0.

G4LogicalVolume *	fBoxVolume = nullptr

G4LogicalVolume *	fWorldVolume = nullptr

Detailed Description

Simple detector construction with a box volume placed in a world.

Definition at line 12 of file Doxymodules_common.h.

Constructor & Destructor Documentation

◆ DetectorConstruction()

Common::DetectorConstruction::DetectorConstruction	(	const G4String &	boxMaterialName = `"G4_AIR"`,
		G4double	boxHx = `40*CLHEP::cm`,
		G4double	boxHy = `40*CLHEP::cm`,
		G4double	boxHz = `40*CLHEP::cm`,
		const G4String &	worldMaterialName = `"G4_AIR"`,
		G4double	worldSizeFactor = `1.25`
	)

Definition at line 44 of file DetectorConstruction.cc.

 : fBoxMaterialName(boxMaterialName),
   fWorldMaterialName(worldMaterialName),
   fBoxDimensions(boxHx*2, boxHy*2, boxHz*2),
   fWorldSizeFactor(worldSizeFactor)
{
  DefineCommands();
}

◆ ~DetectorConstruction()

Common::DetectorConstruction::~DetectorConstruction ( )

override

Definition at line 59 of file DetectorConstruction.cc.

{
  delete fMessenger;
}

Member Function Documentation

◆ Construct()

G4VPhysicalVolume * Common::DetectorConstruction::Construct ( )

override

Definition at line 66 of file DetectorConstruction.cc.

{
  // Define materials via NIST manager
  //
  auto nistManager = G4NistManager::Instance();
 
  auto worldMaterial = nistManager->FindOrBuildMaterial(fWorldMaterialName);
  auto boxMaterial = nistManager->FindOrBuildMaterial(fBoxMaterialName);
 
  // Geometry parameters
  //
  G4ThreeVector worldDimensions = fBoxDimensions * fWorldSizeFactor;
 
  // World
  //
  auto sWorld
    = new G4Box("World",                        //name
                 worldDimensions.x(),           //dimensions (half-lentghs)
                 worldDimensions.y(),
                 worldDimensions.z());
 
  fWorldVolume
    = new G4LogicalVolume(sWorld,               //shape
                          worldMaterial,        //material
                          "World");             //name
 
  auto pWorld
    = new G4PVPlacement(0,                      //no rotation
                        G4ThreeVector(),        //at (0,0,0)
                        fWorldVolume,           //logical volume
                        "World",                //name
                        0,                      //mother  volume
                        false,                  //no boolean operation
                        0);                     //copy number
 
  // Box
  //
  auto sBox
    = new G4Box("Box",                          //its name
                 fBoxDimensions.x(),            //dimensions (half-lengths)
                 fBoxDimensions.y(),
                 fBoxDimensions.z());
 
  fBoxVolume
    = new G4LogicalVolume(sBox,                 //its shape
                          boxMaterial,          //its material
                          "Box");               //its name
 
  new G4PVPlacement(0,                          //no rotation
                    G4ThreeVector(),            //at (0,0,0)
                    fBoxVolume,                 //its logical volume
                    "Box",                      //its name
                    fWorldVolume,               //its mother  volume
                    false,                      //no boolean operation
                    0);                         //copy number
 
  //always return the root volume
  //
  return pWorld;
}

◆ SetBoxMaterial()

void Common::DetectorConstruction::SetBoxMaterial ( const G4String & materialName )

Definition at line 129 of file DetectorConstruction.cc.

{
  auto nistManager = G4NistManager::Instance();
 
  auto newMaterial = nistManager->FindOrBuildMaterial(materialName);
  if ( ! newMaterial ) {
    G4cerr << "Material " << materialName << " not found." << G4endl;
    G4cerr << "The box material was not changed." << G4endl;
    return;
  }
 
  if ( fBoxVolume ) fBoxVolume->SetMaterial(newMaterial);
  G4cout << "Material of box changed to " << materialName << G4endl;
}

◆ SetWorldMaterial()

void Common::DetectorConstruction::SetWorldMaterial ( const G4String & materialName )

Definition at line 146 of file DetectorConstruction.cc.

{
  auto nistManager = G4NistManager::Instance();
 
  auto newMaterial = nistManager->FindOrBuildMaterial(materialName);
  if ( ! newMaterial ) {
    G4cerr << "Material " << materialName << " not found." << G4endl;
    G4cerr << "The box material was not changed." << G4endl;
    return;
  }
 
  if ( fWorldVolume ) fWorldVolume->SetMaterial(newMaterial);
  G4cout << "Material of box changed to " << materialName << G4endl;
}

◆ SetBoxDimensions()

void Common::DetectorConstruction::SetBoxDimensions ( G4ThreeVector dimensions )

Set box dimension (in half lengths). This setting has effect only if called in PreInit> phase

Definition at line 163 of file DetectorConstruction.cc.

{
/// Set box dimension (in half lengths).
/// This setting has effect only if called in PreInit> phase
 
  fBoxDimensions = dimensions;
}

◆ SetWorldSizeFactor()

void Common::DetectorConstruction::SetWorldSizeFactor ( G4double factor )

Set the multiplication factor from box dimensions to world dimensions. This setting has effect only if called in PreInit> phase

Definition at line 173 of file DetectorConstruction.cc.

{
/// Set the multiplication factor from box dimensions to world dimensions.
/// This setting has effect only if called in PreInit> phase
 
  fWorldSizeFactor = factor;
}

◆ DefineCommands()

void Common::DetectorConstruction::DefineCommands ( )

private

Definition at line 183 of file DetectorConstruction.cc.

{
  // Define /B5/detector command directory using generic messenger class
  fMessenger = new G4GenericMessenger(this,
                                      "/detector/",
                                      "Detector control");
 
  // setBoxMaterial command
  auto& setBoxMaterialCmd
    = fMessenger->DeclareMethod("setBoxMaterial",
        &DetectorConstruction::SetBoxMaterial,
        "Set box material name.");
  setBoxMaterialCmd.SetParameterName("boxMaterialName", false);
  setBoxMaterialCmd.SetDefaultValue("G4_AIR");
 
  // setWorldMaterial command
  auto& setWorldMaterialCmd
    = fMessenger->DeclareMethod("setWorldMaterial",
        &DetectorConstruction::SetWorldMaterial,
        "Set world material name.");
  setWorldMaterialCmd.SetParameterName("worldMaterialName", false);
  setWorldMaterialCmd.SetDefaultValue("G4_AIR");
 
  // setBoxDimensions command
  auto& setBoxDimensionsCmd
    = fMessenger->DeclareMethodWithUnit("setBoxDimensions", "mm",
        &DetectorConstruction::SetBoxDimensions,
        "Set box dimensions (in half lentgh).");
  setBoxDimensionsCmd.SetParameterName("boxDimensions", false);
  setBoxDimensionsCmd.SetStates(G4State_PreInit);
 
  // setWorldSizeFactor command
  auto& setWorldSizeFactorCmd
    = fMessenger->DeclareMethod("setWorldSizeFactor",
        &DetectorConstruction::SetWorldSizeFactor,
        "Set the multiplication factor from box dimensions to world dimensions.");
  setWorldSizeFactorCmd.SetParameterName("worldSizeFactor", false);
  setWorldSizeFactorCmd.SetRange("WorldSizeFactor >= 1");
  setWorldSizeFactorCmd.SetStates(G4State_PreInit);
}

Member Data Documentation

◆ fMessenger

G4GenericMessenger* Common::DetectorConstruction::fMessenger = nullptr

private

Definition at line 71 of file DetectorConstruction.hh.

◆ fBoxMaterialName

G4String Common::DetectorConstruction::fBoxMaterialName

private

Definition at line 72 of file DetectorConstruction.hh.

◆ fWorldMaterialName

G4String Common::DetectorConstruction::fWorldMaterialName

private

Definition at line 73 of file DetectorConstruction.hh.

◆ fBoxDimensions

G4ThreeVector Common::DetectorConstruction::fBoxDimensions

private

Definition at line 74 of file DetectorConstruction.hh.

◆ fWorldSizeFactor

G4double Common::DetectorConstruction::fWorldSizeFactor = 0.

private

Definition at line 75 of file DetectorConstruction.hh.

◆ fBoxVolume

G4LogicalVolume* Common::DetectorConstruction::fBoxVolume = nullptr

private

Definition at line 76 of file DetectorConstruction.hh.

◆ fWorldVolume

G4LogicalVolume* Common::DetectorConstruction::fWorldVolume = nullptr

private

Definition at line 77 of file DetectorConstruction.hh.

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

.doxygen/Doxymodules_common.h
extended/common/include/DetectorConstruction.hh
extended/common/src/DetectorConstruction.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DetectorConstruction()

◆ ~DetectorConstruction()

Member Function Documentation

◆ Construct()

◆ SetBoxMaterial()

◆ SetWorldMaterial()

◆ SetBoxDimensions()

◆ SetWorldSizeFactor()

◆ DefineCommands()

Member Data Documentation

◆ fMessenger

◆ fBoxMaterialName

◆ fWorldMaterialName

◆ fBoxDimensions

◆ fWorldSizeFactor

◆ fBoxVolume

◆ fWorldVolume