source: trunk/source/global/management/include/G4PhysicsVector.icc @ 869

//
// ********************************************************************
// * 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: G4PhysicsVector.icc,v 1.14 2008/09/05 18:04:45 vnivanch Exp $
// GEANT4 tag $Name: HEAD $
//
// 
//---------------------------------------------------------------
//      GEANT 4 class source file
//
//  G4PhysicsVector.icc
//
//  Description:
//    A physics vector which has values of energy-loss, cross-section, 
//    and other physics values of a particle in matter in a given 
//    range of the energy, momentum, etc.
//    This class serves as the base class for a vector having various 
//    energy scale, for example like 'log', 'linear', 'free', etc.
//
// Modified:
// 05 Sep. 2008, V.Ivanchenko : added protections for zero-length vector
//---------------------------------------------------------------

inline
 G4double G4PhysicsVector::operator[](const size_t binNumber) const
{
  return dataVector[binNumber];
}

//---------------------------------------------------------------

inline
 G4double G4PhysicsVector::operator()(const size_t binNumber) const
{
  return dataVector[binNumber];
}

//---------------------------------------------------------------

inline 
 size_t G4PhysicsVector::GetVectorLength() const
{
  return numberOfBin;
}

//---------------------------------------------------------------

inline
 G4double G4PhysicsVector::LinearInterpolation()
{
  // Linear interpolation is used to get the value. If the give energy
  // is in the highest bin, no interpolation will be Done. Because 
  // there is an extra bin hidden from a user at locBin=numberOfBin, 
  // the following interpolation is valid even the current locBin=
  // numberOfBin-1. 

  G4double intplFactor = (lastEnergy-binVector[lastBin]) 
     / (binVector[lastBin+1]-binVector[lastBin]); // Interpolation factor

  return dataVector[lastBin] +
         ( dataVector[lastBin+1]-dataVector[lastBin] ) * intplFactor;
}

//---------------------------------------------------------------

inline
 G4double G4PhysicsVector::SplineInterpolation()
{
  // Spline interpolation is used to get the value. If the give energy
  // is in the highest bin, no interpolation will be Done. Because 
  // there is an extra bin hidden from a user at locBin=numberOfBin, 
  // the following interpolation is valid even the current locBin=
  // numberOfBin-1. 

  if( !secDerivative ) { FillSecondDerivatives(); }

  // check bin value
  G4double delta = binVector[lastBin+1] - binVector[lastBin];

  G4double a = (binVector[lastBin+1] - lastEnergy)/delta;
  G4double b = (lastEnergy - binVector[lastBin])/delta;
   
  // Final evaluation of cubic spline polynomial for return   
  G4double y1 = dataVector[lastBin];
  G4double y2 = dataVector[lastBin+1];

  G4double res = a*y1 + b*y2 + 
        ((a*a*a - a)*secDerivative[lastBin] +
         (b*b*b - b)*secDerivative[lastBin+1])*delta*delta/6.0  ;

  return res;
}

//---------------------------------------------------------------

inline
 G4double G4PhysicsVector::GetValue(G4double theEnergy, G4bool&) 
{
  // Use cache for speed up - check if the value 'theEnergy' is same as the 
  // last call. If it is same, then use the last bin location. Also the
  // value 'theEnergy' lies between the last energy and low edge of of the 
  // bin of last call, then the last bin location is used.

  if( theEnergy == lastEnergy ) {

  } else if( theEnergy <= edgeMin ) {
     lastBin = 0;
     lastEnergy = theEnergy;
     lastValue  = dataVector[0];

  } else if(theEnergy < lastEnergy && theEnergy >= binVector[lastBin]) {
     lastEnergy = theEnergy;
     Interpolation();

  } else if(theEnergy < lastEnergy && theEnergy >= binVector[lastBin-1]) {
     lastBin--;
     lastEnergy = theEnergy;
     Interpolation();

  } else if( theEnergy >= edgeMax ){
     lastBin = numberOfBin-1;
     lastEnergy = edgeMax;
     lastValue  = dataVector[lastBin];

  } else {
     lastBin = FindBinLocation(theEnergy); 
     lastEnergy = theEnergy;
     Interpolation();
  }
  return lastValue;        
}

//---------------------------------------------------------------

inline 
 void G4PhysicsVector::Interpolation()
{
  if(useSpline) { lastValue = SplineInterpolation(); }
  else          { lastValue = LinearInterpolation(); }
}

//---------------------------------------------------------------

inline 
 void G4PhysicsVector::PutValue(size_t binNumber, G4double theValue)
{
  if(binNumber < numberOfBin) {
    dataVector[binNumber] = theValue;

    // Fill the bin which is hidden to user with theValue. This is to 
    // handle correctly when Energy=theEmax in getValue.

    if(binNumber==numberOfBin-1) { dataVector[binNumber+1] = theValue; }
  }
}

//---------------------------------------------------------------

inline 
 G4bool G4PhysicsVector::IsFilledVectorExist() const
{
  G4bool status=false;

  if(numberOfBin > 0) { status=true; }
  return status;
}

//---------------------------------------------------------------

inline 
 void G4PhysicsVector::PutComment(const G4String& theComment)
{
  comment = theComment;
}

//---------------------------------------------------------------

inline 
 const G4String& G4PhysicsVector::GetComment() const
{
  return comment;
}

//---------------------------------------------------------------

inline 
 G4PhysicsVectorType G4PhysicsVector::GetType() const
{
  return type;
}

//---------------------------------------------------------------

inline 
 void G4PhysicsVector::SetSpline(G4bool val)
{
  useSpline = val;
}