DetectorConstruction.cc

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file DetectorConstruction.cc

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//

#include "DetectorConstruction.hh"

#include "G4Material.hh"
#include "G4NistManager.hh"
#include "G4Box.hh"
#include "G4LogicalVolume.hh"
#include "G4PVPlacement.hh"
#include "G4GenericMessenger.hh"

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

DetectorConstruction::DetectorConstruction(
                              const G4String& boxMaterialName,
                              G4double boxHx, G4double boxHy, G4double boxHz,
                              const G4String& worldMaterialName,
                              G4double worldSizeFactor)
 : G4VUserDetectorConstruction(),
   fMessenger(nullptr),
   fBoxMaterialName(boxMaterialName),
   fWorldMaterialName(worldMaterialName),
   fBoxDimensions(boxHx*2, boxHy*2, boxHz*2),
   fWorldSizeFactor(worldSizeFactor),
   fBoxVolume(nullptr),
   fWorldVolume(nullptr)
{
  DefineCommands();
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

DetectorConstruction::~DetectorConstruction()
{
  delete fMessenger;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

G4VPhysicalVolume* DetectorConstruction::Construct()
{
  // 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;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
void DetectorConstruction::SetBoxMaterial(const G4String& materialName)
{
  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;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
void DetectorConstruction::SetWorldMaterial(const G4String& materialName)
{
  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;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 
void DetectorConstruction::SetBoxDimensions(G4ThreeVector dimensions) 
{

  fBoxDimensions = dimensions;
}  
                                     
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

void DetectorConstruction::SetWorldSizeFactor(G4double factor) 
{

  fWorldSizeFactor = factor;
}  
                                     
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

void DetectorConstruction::DefineCommands()
{
  // 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);
}
                                     
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......