G4VelocityTable Class Reference

#include <G4VelocityTable.hh>

Public Member Functions
G4double	Value (G4double theEnergy)

Static Public Member Functions
static G4double	GetMaxTOfVelocityTable ()
static G4double	GetMinTOfVelocityTable ()
static G4int	GetNbinOfVelocityTable ()
static G4VelocityTable *	GetVelocityTable ()
static void	SetVelocityTableProperties (G4double t_max, G4double t_min, G4int nbin)

Private Types
using	G4VTDataVector = std::vector< G4double >

Private Member Functions
std::size_t	FindBinLocation (G4double theEnergy) const
	G4VelocityTable ()
G4double	Interpolation () const
void	PrepareVelocityTable ()
	~G4VelocityTable ()

Private Attributes
G4double	baseBin = 0.0
G4VTDataVector	binVector
G4VTDataVector	dataVector
G4double	dBin = 0.0
G4double	edgeMax = 0.0
G4double	edgeMin = 0.0
std::size_t	lastBin = 0
G4double	lastEnergy = -DBL_MAX
G4double	lastValue = 0.0
G4double	maxT = 1000.0
G4double	minT = 0.0001
G4int	NbinT = 500
std::size_t	numberOfNodes = 0
G4VTDataVector	secDerivative

Static Private Attributes
static G4ThreadLocal G4VelocityTable *	theInstance = nullptr

Friends
class	G4ThreadLocalSingleton< G4VelocityTable >

Detailed Description

Definition at line 46 of file G4VelocityTable.hh.

Member Typedef Documentation

G4VTDataVector

using G4VelocityTable::G4VTDataVector = std::vector<G4double>

private

Definition at line 50 of file G4VelocityTable.hh.

Constructor & Destructor Documentation

G4VelocityTable()

G4VelocityTable::G4VelocityTable ( )

private

Definition at line 43 of file G4VelocityTable.cc.

{
  PrepareVelocityTable();
}

References PrepareVelocityTable().

~G4VelocityTable()

G4VelocityTable::~G4VelocityTable ( )

private

Definition at line 49 of file G4VelocityTable.cc.

{
  dataVector.clear();
  binVector.clear();
}

References binVector, and dataVector.

Member Function Documentation

FindBinLocation()

std::size_t G4VelocityTable::FindBinLocation ( G4double  theEnergy ) const

private

Definition at line 93 of file G4VelocityTable.cc.

{
  // For G4PhysicsLogVector, FindBinLocation is implemented using
  // a simple arithmetic calculation.
  //
  // Because this is a virtual function, it is accessed through a
  // pointer to the G4PhysicsVector object for most usages. In this
  // case, 'inline' will not be invoked. However, there is a possibility
  // that the user access to the G4PhysicsLogVector object directly and
  // not through pointers or references. In this case, the 'inline' will
  // be invoked. (See R.B.Murray, "C++ Strategies and Tactics", Chap.6.6)
 
  // const G4double g4log10 = G4Log(10.);
  return std::size_t(G4Log(theEnergy) / dBin - baseBin);
}

References baseBin, dBin, and G4Log().

GetMaxTOfVelocityTable()

G4double G4VelocityTable::GetMaxTOfVelocityTable ( )

static

Definition at line 193 of file G4VelocityTable.cc.

{
  return GetVelocityTable()->maxT;
}

References GetVelocityTable(), and maxT.

GetMinTOfVelocityTable()

G4double G4VelocityTable::GetMinTOfVelocityTable ( )

static

Definition at line 199 of file G4VelocityTable.cc.

{
  return GetVelocityTable()->minT;
}

References GetVelocityTable(), and minT.

GetNbinOfVelocityTable()

G4int G4VelocityTable::GetNbinOfVelocityTable ( )

static

Definition at line 205 of file G4VelocityTable.cc.

{
  return GetVelocityTable()->NbinT;
}

References GetVelocityTable(), and NbinT.

GetVelocityTable()

G4VelocityTable * G4VelocityTable::GetVelocityTable ( )

static

Definition at line 151 of file G4VelocityTable.cc.

{
  if(theInstance == nullptr)
  {
    static G4ThreadLocalSingleton<G4VelocityTable> inst;
    theInstance = inst.Instance();
  }
  return theInstance;
}

References G4ThreadLocalSingleton< T >::Instance(), and theInstance.

Referenced by GetMaxTOfVelocityTable(), GetMinTOfVelocityTable(), GetNbinOfVelocityTable(), and SetVelocityTableProperties().

Interpolation()

G4double G4VelocityTable::Interpolation ( ) const

inlineprivate

Definition at line 108 of file G4VelocityTable.hh.

{
  // 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]);  // Interpol. factor
 
  return dataVector[lastBin] +
         (dataVector[lastBin + 1] - dataVector[lastBin]) * intplFactor;
}

Referenced by Value().

PrepareVelocityTable()

void G4VelocityTable::PrepareVelocityTable ( )

private

Definition at line 56 of file G4VelocityTable.cc.

{
  // const G4double g4log10 = std::log(10.);
 
  dataVector.clear();
  binVector.clear();
  dBin    = G4Log(maxT / minT) / NbinT;
  baseBin = G4Log(minT) / dBin;
 
  numberOfNodes = NbinT + 1;
  dataVector.reserve(numberOfNodes);
  binVector.reserve(numberOfNodes);
 
  binVector.push_back(minT);
  dataVector.push_back(0.0);
 
  for(std::size_t i = 1; i < numberOfNodes - 1; ++i)
  {
    binVector.push_back(G4Exp((baseBin + i) * dBin));
    dataVector.push_back(0.0);
  }
  binVector.push_back(maxT);
  dataVector.push_back(0.0);
 
  edgeMin = binVector[0];
  edgeMax = binVector[numberOfNodes - 1];
 
  for(G4int i = 0; i <= NbinT; ++i)
  {
    G4double T    = binVector[i];
    dataVector[i] = c_light * std::sqrt(T * (T + 2.)) / (T + 1.0);
  }
 
  return;
}

References baseBin, binVector, source.hepunit::c_light, dataVector, dBin, edgeMax, edgeMin, G4Exp(), G4Log(), maxT, minT, NbinT, and numberOfNodes.

Referenced by G4VelocityTable(), and SetVelocityTableProperties().

SetVelocityTableProperties()

void G4VelocityTable::SetVelocityTableProperties ( G4double  t_max, G4double  t_min, G4int  nbin  )

static

Definition at line 162 of file G4VelocityTable.cc.

{
  if(theInstance == nullptr)
  {
    GetVelocityTable();
  }
 
  G4StateManager* stateManager    = G4StateManager::GetStateManager();
  G4ApplicationState currentState = stateManager->GetCurrentState();
 
  // check if state is outside event loop
  if(!(currentState == G4State_Idle || currentState == G4State_PreInit))
  {
    G4Exception("G4VelocityTable::SetVelocityTableProperties()", "Track101",
                JustWarning,
                "Can modify only in PreInit or Idle state : Method ignored.");
    return;
  }
 
  if(nbin > 100)
    theInstance->NbinT = nbin;
  if((t_min < t_max) && (t_min > 0.))
  {
    theInstance->minT = t_min;
    theInstance->maxT = t_max;
  }
  theInstance->PrepareVelocityTable();
}

References G4Exception(), G4State_Idle, G4State_PreInit, G4StateManager::GetCurrentState(), G4StateManager::GetStateManager(), GetVelocityTable(), JustWarning, maxT, minT, NbinT, PrepareVelocityTable(), and theInstance.

Value()

G4double G4VelocityTable::Value

(

G4double

theEnergy

)

Definition at line 110 of file G4VelocityTable.cc.

{
  // 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 < lastEnergy && theEnergy >= binVector[lastBin])
  {
    lastEnergy = theEnergy;
    lastValue  = Interpolation();
  }
  else if(theEnergy <= edgeMin)
  {
    lastBin    = 0;
    lastEnergy = edgeMin;
    lastValue  = dataVector[0];
  }
  else if(theEnergy >= edgeMax)
  {
    lastBin    = numberOfNodes - 1;
    lastEnergy = edgeMax;
    lastValue  = dataVector[lastBin];
  }
  else
  {
    lastBin = (std::size_t)(G4Log(theEnergy) / dBin - baseBin);
    if(lastBin == numberOfNodes)
    {
      --lastBin;
    }  // VI: fix possible precision lost
    lastEnergy = theEnergy;
    lastValue  = Interpolation();
  }
  return lastValue;
}

References baseBin, binVector, dataVector, dBin, edgeMax, edgeMin, G4Log(), Interpolation(), lastBin, lastEnergy, lastValue, and numberOfNodes.

Friends And Related Function Documentation

G4ThreadLocalSingleton< G4VelocityTable >

friend class G4ThreadLocalSingleton< G4VelocityTable >

friend

Definition at line 108 of file G4VelocityTable.hh.

Field Documentation

baseBin

G4double G4VelocityTable::baseBin = 0.0

private

Definition at line 91 of file G4VelocityTable.hh.

Referenced by FindBinLocation(), PrepareVelocityTable(), and Value().

binVector

G4VTDataVector G4VelocityTable::binVector

private

Definition at line 87 of file G4VelocityTable.hh.

Referenced by PrepareVelocityTable(), Value(), and ~G4VelocityTable().

dataVector

G4VTDataVector G4VelocityTable::dataVector

private

Definition at line 86 of file G4VelocityTable.hh.

Referenced by PrepareVelocityTable(), Value(), and ~G4VelocityTable().

dBin

G4double G4VelocityTable::dBin = 0.0

private

Definition at line 90 of file G4VelocityTable.hh.

Referenced by FindBinLocation(), PrepareVelocityTable(), and Value().

edgeMax

G4double G4VelocityTable::edgeMax = 0.0

private

Definition at line 82 of file G4VelocityTable.hh.

Referenced by PrepareVelocityTable(), and Value().

edgeMin

G4double G4VelocityTable::edgeMin = 0.0

private

Definition at line 81 of file G4VelocityTable.hh.

Referenced by PrepareVelocityTable(), and Value().

lastBin

std::size_t G4VelocityTable::lastBin = 0

private

Definition at line 95 of file G4VelocityTable.hh.

Referenced by Value().

lastEnergy

G4double G4VelocityTable::lastEnergy = -DBL_MAX

private

Definition at line 93 of file G4VelocityTable.hh.

Referenced by Value().

lastValue

G4double G4VelocityTable::lastValue = 0.0

private

Definition at line 94 of file G4VelocityTable.hh.

Referenced by Value().

maxT

G4double G4VelocityTable::maxT = 1000.0

private

Definition at line 99 of file G4VelocityTable.hh.

Referenced by GetMaxTOfVelocityTable(), PrepareVelocityTable(), and SetVelocityTableProperties().

minT

G4double G4VelocityTable::minT = 0.0001

private

Definition at line 100 of file G4VelocityTable.hh.

Referenced by GetMinTOfVelocityTable(), PrepareVelocityTable(), and SetVelocityTableProperties().

NbinT

G4int G4VelocityTable::NbinT = 500

private

Definition at line 101 of file G4VelocityTable.hh.

Referenced by GetNbinOfVelocityTable(), PrepareVelocityTable(), and SetVelocityTableProperties().

numberOfNodes

std::size_t G4VelocityTable::numberOfNodes = 0

private

Definition at line 84 of file G4VelocityTable.hh.

Referenced by PrepareVelocityTable(), and Value().

secDerivative

G4VTDataVector G4VelocityTable::secDerivative

private

Definition at line 88 of file G4VelocityTable.hh.

theInstance

G4ThreadLocal G4VelocityTable * G4VelocityTable::theInstance = nullptr

staticprivate

Definition at line 97 of file G4VelocityTable.hh.

Referenced by GetVelocityTable(), and SetVelocityTableProperties().

---

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

• source/track/include/G4VelocityTable.hh
• source/track/src/G4VelocityTable.cc