update to geant4 4.0 (not yet released)

[u/mrichter/AliRoot.git] / TGeant4 / TG4GeometryServices.cxx

// $Id$
// Category: geometry
//
// Author: I. Hrivnacova
//
// Class TG4GeometryServices
// -------------------------
// See the class description in the header file.

#include "TG4GeometryServices.h"
#include "TG4Limits.h"
#include "TG4IntMap.h"
#include "TG4NameMap.h"
#include "TG4G3Units.h"
#include "TG4G3ControlVector.h"
#include "TG4Globals.h"

#include <G4LogicalVolumeStore.hh>
#include <G4LogicalVolume.hh>
#include <G4Material.hh>
#include <G4Element.hh>
#include <G4UserLimits.hh>
#include <G3toG4.hh> 
#include <G3EleTable.hh> 
#include <g4std/vector>

#include <math.h>

TG4GeometryServices* TG4GeometryServices::fgInstance = 0;
const G4double       TG4GeometryServices::fgkAZTolerance = 0.001;      
const G4double       TG4GeometryServices::fgkDensityTolerance = 0.005; 

//_____________________________________________________________________________
TG4GeometryServices::TG4GeometryServices(TG4IntMap* mediumMap, 
                                         TG4NameMap* nameMap) 
  : fMediumMap(mediumMap),
    fNameMap(nameMap)				 
{
//
  if (fgInstance) {
    TG4Globals::Exception(
      "TG4GeometryServices: attempt to create two instances of singleton.");
  }

  fgInstance = this;
}

//_____________________________________________________________________________
TG4GeometryServices::TG4GeometryServices() {
// 
  TG4Globals::Exception(
    "TG4GeometryServices default constructor is protected.");
}


//_____________________________________________________________________________
TG4GeometryServices::TG4GeometryServices(const TG4GeometryServices& right) {
// 
  TG4Globals::Exception(
    "Attempt to copy TG4GeometryServices singleton.");
}


//_____________________________________________________________________________
TG4GeometryServices::~TG4GeometryServices() {
//
}

//=============================================================================
//
// operators
//
//=============================================================================

//_____________________________________________________________________________
TG4GeometryServices& 
TG4GeometryServices::operator=(const TG4GeometryServices& right)
{
  // check assignement to self
  if (this == &right) return *this;

  TG4Globals::Exception(
    "Attempt to assign TG4GeometryServices singleton.");
    
  return *this;  
}    
          
//=============================================================================
//
// private methods
//
//=============================================================================

//_____________________________________________________________________________
G4bool TG4GeometryServices::IsG3Volume(const G4String& lvName) const
{
// Returns true if the logical volume of given volumeName
// was not created by Gsposp method with a generic name 
// (name_copyNo).
// ---

  if (lvName.contains(gSeparator))
    return false;  
  else
    return true;   
}

//_____________________________________________________________________________
G4bool TG4GeometryServices::CompareElement(G4double a, G4double z, 
                                           const G4Element* element) const
{
// Compares given parameters with those of a given element,
// returns true if they are equal, false otherwise.
// ---

  G4double ae = element->GetA()/TG4G3Units::AtomicWeight();
  G4double ze = element->GetZ();

  // g3tog4 can redefine A
  G4double ax;
  if (z<1) {
    // vacuum 
    ax = 1.01*g/mole; 
  }
  else  
    ax = G3Ele.GetEle(z)->GetA()/TG4G3Units::AtomicWeight();

  if (abs(ax - ae) < fgkAZTolerance && abs(z  - ze) < fgkAZTolerance) 
    return true;
  else  
    return false;   
}					     

//_____________________________________________________________________________
G4bool TG4GeometryServices::CompareMaterial(G4int nofElements, G4double density, 
                                            const G4Material* material) const
{
// Compares given density with those of a given material,
// returns true if they are equal, false otherwise.
// ---

  G4double dm = material->GetDensity()/TG4G3Units::MassDensity();
  G4int ne = material->GetNumberOfElements();
  
  // density percentual difference
  G4double diff = abs(density - dm)/(density + dm)*2.;
  
  if (nofElements == ne && diff < fgkDensityTolerance) 
    return true;
  else  	
    return false;
}					     

//_____________________________________________________________________________
G4double* TG4GeometryServices::ConvertAtomWeight(G4int nmat,  
                                                 G4double* a, G4double* wmat) const
{
// In case of proportions given in atom counts (nmat<0),
// the wmat[i] are converted to weight fractions.
// (From g3tog4 G4gsmixt.)
// The new array has to be delete by client.
// ---
 
  G4double* weight = new G4double[abs(nmat)];
  
  if (nmat<0) {
    G4double aMol = 0.;
    G4int i;
    for (i=0; i<abs(nmat); i++) { 
      // total molecular weight 
      aMol += wmat[i]*a[i]; 
    }  
    if (aMol == 0.) {
      G4String text = "TG4GeometryServices::ConvertAtomWeight:\n";
      text = text + " Total molecular weight = 0";   
      TG4Globals::Warning(text);
    }         
    for (G4int i=0; i<abs(nmat); i++) {
      // weight fractions
      weight[i] = wmat[i]*a[i]/aMol;
    }
  }
  else 
    for (G4int j=0; j<nmat; j++) weight[j] = wmat[j];
    
  return weight;  
}

//=============================================================================
//
// public methods
//
//=============================================================================

//_____________________________________________________________________________
G4double* TG4GeometryServices::CreateG4doubleArray(Float_t* array, 
               G4int size) const
{
// Converts Float_t* array to G4double*,
// !! The new array has to be deleted by user.
// ---

  G4double* doubleArray;
  if (size>0) {
    doubleArray = new G4double[size]; 
    for (G4int i=0; i<size; i++) doubleArray[i] = array[i];
  }
  else {
    doubleArray = 0; 
  }  
  return doubleArray;
}

//_____________________________________________________________________________
G4String TG4GeometryServices::CutName(const char* name) const
{
// Removes spaces after the name if present.
// ---

  G4String cutName = name;
  G4int i = cutName.length();
  while (cutName(--i) == ' ') cutName = cutName(0,i);

  return cutName;
}  

//_____________________________________________________________________________
G4String TG4GeometryServices::CutMaterialName(const char* name) const
{
// Removes the $ with precedent spaces at the name if present.
// ---

  G4String cutName = name;
  cutName = cutName.substr(0,cutName.find('$'));

  return CutName(cutName);
}  

//_____________________________________________________________________________
G4String  TG4GeometryServices::G4ToG3VolumeName(const G4String& name) const
{
// Cuts _copyNo extension added to logical volume name in case 
// the logical volume was created by Gsposp method.
// ---

  G4String cutName = name;
  if (cutName.contains(gSeparator)) 
  cutName = cutName(0,cutName.first(gSeparator));
  
  return cutName;
}

//_____________________________________________________________________________
G4String  TG4GeometryServices::GenerateLimitsName(G4int id, 
                                       const G4String& medName,
                                       const G4String& matName) const
{
// Generate unique name for user limits composed from the tracking medium id,
// name and its material name.
//
  G4String name = "";
  TG4Globals::AppendNumberToString(name, id);
  name = name + "__med_" + medName + "__mat_" + matName;
  
  return name;
}

//_____________________________________________________________________________
G4Material* TG4GeometryServices::MixMaterials(G4String name, G4double density, 
                                    const TG4StringVector& matNames, 
				    const TG4doubleVector& matWeights)
{
// Creates a mixture of selected materials
// ---

  // number of materials to be mixed  
  G4int nofMaterials = matNames.size();
  if (nofMaterials != matWeights.size()) {
    G4String text = "TG4GeometryServices::MixMaterials: ";
    text = text +  "different number of material names and weigths.";
    TG4Globals::Exception(text);
  }    
  // add verbose
  // G4cout << "Nof of materials to be mixed: " << nofMaterials << G4endl;

  // fill vector of materials
  G4std::vector<G4Material*> matVector;  
  G4int im;
  for (im=0; im< nofMaterials; im++) {
    // material
    G4Material* material = G4Material::GetMaterial(matNames[im]);
    matVector.push_back(material);
  } 

  // create the mixed material
  G4Material* mixture = new G4Material(name, density, nofMaterials);
  for (im=0; im< nofMaterials; im++) {
    G4Material* material = matVector[im];
    G4double fraction = matWeights[im];
    mixture->AddMaterial(material, fraction);
  }

  return mixture;
}  

//_____________________________________________________________________________
void TG4GeometryServices::PrintNameMap() const
{
// Prints the map of volumes names to second names.
// ---

  fNameMap->PrintAll();
}
 
//_____________________________________________________________________________
void TG4GeometryServices::PrintLimits(const G4String& name) const
{
// Finds the limits with the specified name and prints them.
// ---

  TG4Limits* limits = FindLimits(name, true);
  
  if (limits)  limits->Print();    
}            

//_____________________________________________________________________________
void TG4GeometryServices::PrintVolumeLimits(const G4String& volumeName) const
{
// Finds a logical volume with the specified name and prints
// its limits.
// ---

  G4LogicalVolume* lv = FindLogicalVolume(volumeName, false);
  
  if (lv) {
    TG4Limits* limits = GetLimits(lv->GetUserLimits());
    G4cout << volumeName << "  ";
    if (limits) 
      limits->Print();
    else
      G4cout << "has not the limits set." << G4endl;
  }    
}            

//_____________________________________________________________________________
void TG4GeometryServices::PrintStatistics(G4bool open, G4bool close) const
{
// Print G4 geometry statistics
// ---
  

  if (open)  TG4Globals::PrintStars(true);
     
  G4cout << "    GEANT4 Geometry statistics: " << G4endl
         << "          " << NofG4LogicalVolumes()  
	                 << " logical volumes" << G4endl
	 << "          " 
	                 << NofG4PhysicalVolumes() 
	                 << " physical volumes" << G4endl
	 << "          " 
	                 << G4Material::GetNumberOfMaterials()
			 << " materials"        << G4endl
	 << "          " 
	                 << TG4Limits::GetNofLimits()
			 << " user limits"      << G4endl;

  if (close) TG4Globals::PrintStars(false);
}

//_____________________________________________________________________________
Int_t TG4GeometryServices::NofG3Volumes() const
{
// Returns the total number of logical volumes corresponding
// to G3 volumes. (
// The logical volume that were created by Gsposp method 
// with a generic name (name_copyNo) are NOT included.
// ---

  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();

  G4int counter = 0;  
  for (G4int i=0; i<lvStore->size(); i++) {
    G4LogicalVolume* lv = (*lvStore)[i];
    if (IsG3Volume(lv->GetName())) counter++;
  }
  
  return counter;  
}

//_____________________________________________________________________________
Int_t TG4GeometryServices::NofG4LogicalVolumes() const
{
// Returns the total number of logical volumes in the geometry.
// ---

  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  return lvStore->size();
}

//_____________________________________________________________________________
Int_t TG4GeometryServices::NofG4PhysicalVolumes() const
{
// Returns the total number of physical volumes in the geometry.
// ---

  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();

  G4int counter = 0;
  for (G4int i=0; i<lvStore->size(); i++) {
    counter += ((*lvStore)[i])->GetNoDaughters();
  }
  
  return counter;  
}


//______________________________________________________________________________
G4bool TG4GeometryServices::IsSpecialControls()  const
{
// Returns true if a process control in some limits instance is set. 
// ---

  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();

  for (G4int i=0; i<lvStore->size(); i++) {
    TG4Limits* limits = GetLimits((*lvStore)[i]->GetUserLimits());
    if (limits && limits->IsControl()) return true;
  }
  
  return false;    
}

//_____________________________________________________________________________
TG4Limits* TG4GeometryServices::GetLimits(G4UserLimits* limits) const
{
// Checks and converts type of the given limits.
// ---

  if (!limits) return 0;
  
  TG4Limits* tg4Limits = dynamic_cast<TG4Limits*> (limits);

  if (!tg4Limits) {
    G4Exception("TG4GeometryServices::GetLimits: Wrong limits type.");
    return 0;
  }  
  else 
    return tg4Limits;  
}        

//_____________________________________________________________________________
const G4String& TG4GeometryServices::GetMapSecond(const G4String& name)
{ 
// Returns the second string associated with the name in
// the name map.
// ---

  return fNameMap->GetSecond(name); 
}

//_____________________________________________________________________________
G4LogicalVolume* 
TG4GeometryServices::FindLogicalVolume(const G4String& name, G4bool silent) const
{
// Finds a logical volume with the specified name in G4LogicalVolumeStore.
// ---

  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  
  for (G4int i=0; i<lvStore->size(); i++) {
    G4LogicalVolume* lv = (*lvStore)[i];
    if (lv->GetName() == name) return lv;
  }
  
  if (!silent) {
    G4String text = "TG4GeometryServices:: FindLogicalVolume:\n"; 
    text = text + "    Logical volume " + name + " does not exist.";
    TG4Globals::Warning(text);
  }
  return 0;	       	         
}  


//_____________________________________________________________________________
TG4Limits* 
TG4GeometryServices::FindLimits(const G4String& name, G4bool silent) const
{
// Finds limits with the specified name.
// ---

  G4LogicalVolumeStore* lvStore = G4LogicalVolumeStore::GetInstance();
  
  for (G4int i=0; i<lvStore->size(); i++) {
    G4LogicalVolume* lv = (*lvStore)[i];
    TG4Limits* limits = GetLimits(lv->GetUserLimits());
    if (limits && limits->GetName() == name) return limits;
  }
  
  if (!silent) {
    G4String text = "TG4GeometryServices:: FindLimits:\n"; 
    text = text + "    Logical volume " + name + " does not exist.";
    TG4Globals::Warning(text);
  }
  return 0;	       	         
}  

//_____________________________________________________________________________
G4int TG4GeometryServices::GetMediumId(G4LogicalVolume* lv) const
{
// Returns the second index for materials (having its origin in
// G4 tracking media concept)
// ---

  return fMediumMap->GetSecond(lv->GetName());
}  

//_____________________________________________________________________________
G4double TG4GeometryServices::GetEffA(G4Material* material) const
{
// Returns A or effective A=sum(pi*Ai) (if compound/mixture)
// of given material.
// ---

  G4double a = 0.;
  G4int nofElements = material->GetNumberOfElements();
  if (nofElements > 1) {
    G4String text = "Effective A for material mixture (";
    text = text + material->GetName();
    text = text + ") is used.";
    //TG4Globals::Warning(text);

    for (G4int i=0; i<nofElements; i++) {
      G4double aOfElement = material->GetElement(i)->GetA();
      G4double massFraction = material->GetFractionVector()[i];      
      a += aOfElement*massFraction /(TG4G3Units::AtomicWeight());
    }
  }
  else { 
    a = material->GetA();
    a /= TG4G3Units::AtomicWeight();
  }
  return a;
}

//_____________________________________________________________________________
G4double TG4GeometryServices::GetEffZ(G4Material* material) const
{
// Returns Z or effective Z=sum(pi*Zi) (if compound/mixture)
// of given material.
// ---

  G4double z = 0.;
  G4int nofElements = material->GetNumberOfElements();
  if (nofElements > 1) {
    G4String text = "Effective Z for material mixture (";
    text = text + material->GetName();
    text = text + ") is used.";
    //TG4Globals::Warning(text);

    for (G4int i=0; i<nofElements; i++) {
      G4double zOfElement = material->GetElement(i)->GetZ();
      G4double massFraction = material->GetFractionVector()[i];
      z += zOfElement*massFraction;
    }
  }
  else { 
    z = material->GetZ(); 
  }  
  return z;
}

//_____________________________________________________________________________
G4Material* TG4GeometryServices::FindMaterial(G4double a, G4double z, 
                                             G4double density) const
{
// Finds material in G4MaterialTable with specified parameters,
// returns 0 if not found.
// ---

  const G4MaterialTable* kpMatTable = G4Material::GetMaterialTable();    
  
  for (G4int i=0; i<G4Material::GetNumberOfMaterials(); i++) {  

    G4Material* material = (*kpMatTable)[i];
    
    if (CompareElement(a, z, material->GetElement(0)) &&
        CompareMaterial(1, density, material))
	
	return material;
  }	
    
  return 0;   
}					     

//_____________________________________________________________________________
G4Material* TG4GeometryServices::FindMaterial(G4double* a, G4double* z,
                                              G4double density, 
                                              G4int nmat, G4double* wmat) const
{					      
// Finds material in G4MaterialTable with specified parameters,
// returns 0 if not found.
// ---

  G4double* weight = ConvertAtomWeight(nmat, a, wmat);

  // loop over materials
  G4Material* found = 0;  
  for (G4int i=0; i<G4Material::GetNumberOfMaterials(); i++) {  
    
    G4Material* material = (*G4Material::GetMaterialTable())[i];
    G4int nm = material->GetNumberOfElements();
    
    if (CompareMaterial(nm, density, material)) {

      // loop over elements
      G4bool equal = true;
      for (G4int ie=0; ie<nm; ie++) { 

	G4double we = (material->GetFractionVector())[ie];
    
        if (!CompareElement(a[ie], z[ie], material->GetElement(ie)) ||
	    abs(weight[ie] - we) > fgkAZTolerance) {

          equal = false;
	  break;		
        }
      }
      if (equal) {
        found = material;
	break;
      }	
    }  
  }  	 
    
  delete [] weight;  
  return found;   
}