G4EnergyRangeManager.cc

Go to the documentation of this file.

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// $Id: G4EnergyRangeManager.cc 98067 2016-07-01 16:33:54Z gcosmo $
//
 // Hadronic Process: Energy Range Manager
 // original by H.P. Wellisch
 // modified by J.L. Chuma, TRIUMF, 22-Nov-1996
 // Last modified: 24-Mar-1997
 // fix in the counter-hndling: H.P. Wellisch 04-Apr-97
 // throw an exception if no model found:  J.L. Chuma  04-Apr-97
 
#include "G4EnergyRangeManager.hh"
#include "Randomize.hh"
#include "G4HadronicException.hh"

G4EnergyRangeManager::G4EnergyRangeManager()
 : theHadronicInteractionCounter(0)
{}

G4EnergyRangeManager::~G4EnergyRangeManager()
{}

G4EnergyRangeManager::G4EnergyRangeManager(const G4EnergyRangeManager& right)
{
  theHadronicInteractionCounter = right.theHadronicInteractionCounter;
  theHadronicInteraction = right.theHadronicInteraction;
}
 
G4EnergyRangeManager& G4EnergyRangeManager::operator=(
   const G4EnergyRangeManager& right)
{
  if (this != &right) {
    theHadronicInteractionCounter = right.theHadronicInteractionCounter;
    theHadronicInteraction = right.theHadronicInteraction;
  }
  return *this;
}

void G4EnergyRangeManager::RegisterMe(G4HadronicInteraction* a)
{
  if(!a) { return; }
  if(0 < theHadronicInteractionCounter) {
    for(G4int i=0; i<theHadronicInteractionCounter; ++i) {
      if(a == theHadronicInteraction[i]) { return; }
    }
  }
  theHadronicInteraction.push_back(a);
  ++theHadronicInteractionCounter;
}


G4HadronicInteraction*
G4EnergyRangeManager::GetHadronicInteraction(const G4HadProjectile & aHadProjectile, 
                                             G4Nucleus & aTargetNucleus,
                                             const G4Material* aMaterial,
                                             const G4Element* anElement) const
{
  if(0 == theHadronicInteractionCounter) {
    throw G4HadronicException(__FILE__, __LINE__,
                  "GetHadronicInteraction: NO MODELS STORED");
  }

  G4double kineticEnergy = aHadProjectile.GetKineticEnergy();
  // For ions, get kinetic energy per nucleon
  if ( aHadProjectile.GetDefinition()->GetBaryonNumber() > 1.5 ) {
    kineticEnergy /= aHadProjectile.GetDefinition()->GetBaryonNumber();
  }

  G4int cou = 0, memory = 0, memor2 = 0;
  G4double emi1 = 0.0, ema1 = 0.0, emi2 = 0.0, ema2 = 0.0;

  for (G4int i = 0; i<theHadronicInteractionCounter; ++i) {
    if ( theHadronicInteraction[i]->IsApplicable( aHadProjectile, aTargetNucleus ) ) {
      G4double low  = theHadronicInteraction[i]->GetMinEnergy( aMaterial, anElement );
      // Work-around for particles with 0 kinetic energy, which still
      // require a model to return a ParticleChange
      //if (low == 0.) low = -DBL_MIN;
      G4double high = theHadronicInteraction[i]->GetMaxEnergy( aMaterial, anElement );
      if (low <= kineticEnergy && high > kineticEnergy) {
        ++cou;
        emi2 = emi1;
        ema2 = ema1;
        emi1 = low;
        ema1 = high;
        memor2 = memory;
        memory = i;
      }
    }
  }

  G4int mem = -1;
  G4double rand;
  switch (cou) {
    case 0:
       G4cout<<"G4EnergyRangeManager:GetHadronicInteraction: counter="
         <<theHadronicInteractionCounter<<", Ek="
             <<kineticEnergy<<", Material = "<<aMaterial->GetName()
         <<", Element = "
             <<anElement->GetName()<<G4endl;
       for( G4int j=0; j<theHadronicInteractionCounter; ++j)
       {
         G4HadronicInteraction* HInt=theHadronicInteraction[j];
         G4cout<<"*"<<j<<"* low=" <<HInt->GetMinEnergy(aMaterial,anElement)
               <<", high="<<HInt->GetMaxEnergy(aMaterial,anElement)<<G4endl;
       }
       throw G4HadronicException(__FILE__, __LINE__,
          "GetHadronicInteraction: No Model found");
       return 0;
    case 1:
       mem = memory;
       break;
    case 2:
       if( (emi2<=emi1 && ema2>=ema1) || (emi2>=emi1 && ema2<=ema1) )
       {
         G4cout<<"G4EnergyRangeManager:GetHadronicInteraction: counter="
           <<theHadronicInteractionCounter<<", Ek="
               <<kineticEnergy<<", Material = "<<aMaterial->GetName()
           <<", Element = "
               <<anElement->GetName()<<G4endl;
         for( G4int j=0; j<theHadronicInteractionCounter; ++j)
         {
           G4HadronicInteraction* HInt=theHadronicInteraction[j];
           G4cout<<"*"<<j<<"* low=" <<HInt->GetMinEnergy(aMaterial,anElement)
               <<", high="<<HInt->GetMaxEnergy(aMaterial,anElement)<<G4endl;
         }
         throw G4HadronicException(__FILE__, __LINE__,
         "GetHadronicInteraction: Energy ranges of two models fully overlapping");
       }
       rand = G4UniformRand();
       if( emi1 < emi2 )
       {
         if( (ema1-kineticEnergy) < rand*(ema1-emi2) ) {
           mem = memor2;
         } else {
           mem = memory;
     }
       } else {
         if( (ema2-kineticEnergy) < rand*(ema2-emi1) ) {
           mem = memory;
     } else {
           mem = memor2;
     }
       }
       break;
    default:
      throw G4HadronicException(__FILE__, __LINE__,
      "GetHadronicInteraction: More than two competing models in this energy range");
  }

  return theHadronicInteraction[mem];
} 


G4HadronicInteraction*
G4EnergyRangeManager::GetHadronicInteraction(const G4double kineticEnergy,
                                             const G4Material* aMaterial,
                                             const G4Element* anElement) const
{
  if(0 == theHadronicInteractionCounter) {
    throw G4HadronicException(__FILE__, __LINE__,
                  "GetHadronicInteraction: NO MODELS STORED");
  } 
  G4int cou = 0, memory = 0, memor2 = 0;
  G4double emi1 = 0.0, ema1 = 0.0, emi2 = 0.0, ema2 = 0.0;

  for (G4int i = 0; i<theHadronicInteractionCounter; ++i) {
      G4double low  = theHadronicInteraction[i]->GetMinEnergy( aMaterial, anElement );
    // Work-around for particles with 0 kinetic energy, which still
    // require a model to return a ParticleChange
    //if (low == 0.) low = -DBL_MIN;
    G4double high = theHadronicInteraction[i]->GetMaxEnergy( aMaterial, anElement );
    if (low <= kineticEnergy && high > kineticEnergy) {
      ++cou;
      emi2 = emi1;
      ema2 = ema1;
      emi1 = low;
      ema1 = high;
      memor2 = memory;
      memory = i;
    }
  }

  G4int mem = -1;
  G4double rand;
  switch (cou) {
    case 0:
       G4cout<<"G4EnergyRangeManager:GetHadronicInteraction: counter="
         <<theHadronicInteractionCounter<<", Ek="
             <<kineticEnergy<<", Material = "<<aMaterial->GetName()
         <<", Element = "
             <<anElement->GetName()<<G4endl;
       for( G4int j=0; j<theHadronicInteractionCounter; ++j)
       {
         G4HadronicInteraction* HInt=theHadronicInteraction[j];
         G4cout<<"*"<<j<<"* low=" <<HInt->GetMinEnergy(aMaterial,anElement)
               <<", high="<<HInt->GetMaxEnergy(aMaterial,anElement)<<G4endl;
       }
       throw G4HadronicException(__FILE__, __LINE__,
          "GetHadronicInteraction: No Model found");
       return 0;
    case 1:
       mem = memory;
       break;
    case 2:
       if( (emi2<=emi1 && ema2>=ema1) || (emi2>=emi1 && ema2<=ema1) )
       {
         G4cout<<"G4EnergyRangeManager:GetHadronicInteraction: counter="
           <<theHadronicInteractionCounter<<", Ek="
               <<kineticEnergy<<", Material = "<<aMaterial->GetName()
           <<", Element = "
               <<anElement->GetName()<<G4endl;
         for( G4int j=0; j<theHadronicInteractionCounter; ++j)
         {
           G4HadronicInteraction* HInt=theHadronicInteraction[j];
           G4cout<<"*"<<j<<"* low=" <<HInt->GetMinEnergy(aMaterial,anElement)
               <<", high="<<HInt->GetMaxEnergy(aMaterial,anElement)<<G4endl;
         }
         throw G4HadronicException(__FILE__, __LINE__,
         "GetHadronicInteraction: Energy ranges of two models fully overlapping");
       }
       rand = G4UniformRand();
       if( emi1 < emi2 )
       {
         if( (ema1-kineticEnergy) < rand*(ema1-emi2) ) {
           mem = memor2;
         } else {
           mem = memory;
     }
       } else {
         if( (ema2-kineticEnergy) < rand*(ema2-emi1) ) {
           mem = memory;
     } else {
           mem = memor2;
     }
       }
       break;
    default:
      throw G4HadronicException(__FILE__, __LINE__,
      "GetHadronicInteraction: More than two competing models in this energy range");
  }

  return theHadronicInteraction[mem];
} 

std::vector<G4HadronicInteraction*>& 
G4EnergyRangeManager::GetHadronicInteractionList()
{
  return theHadronicInteraction;
}

#include "G4SystemOfUnits.hh"
void G4EnergyRangeManager::Dump( G4int verbose )
{
  G4cout << "G4EnergyRangeManager " << this << G4endl;
  for (G4int i = 0 ; i < theHadronicInteractionCounter; i++) {
    G4cout << "   HadronicModel " << i <<":"
           << theHadronicInteraction[i]->GetModelName() << G4endl;
    if (verbose > 0) {
      G4cout << "      Minimum Energy " 
         << theHadronicInteraction[i]->GetMinEnergy()/GeV << " [GeV], "
             << "Maximum Energy " 
         << theHadronicInteraction[i]->GetMaxEnergy()/GeV << " [GeV]"
             << G4endl;
    }
  }
}

void
G4EnergyRangeManager::BuildPhysicsTable(const G4ParticleDefinition& aParticleType)
{
   for ( std::vector<G4HadronicInteraction*>::iterator 
         it = theHadronicInteraction.begin() ; it != theHadronicInteraction.end() ; it++ ) {
      (*it)->BuildPhysicsTable( aParticleType );
   }
}
 /* end of file */