G4PhysicsTableHelper Class Reference

#include <G4PhysicsTableHelper.hh>

Public Member Functions
	G4PhysicsTableHelper (const G4PhysicsTableHelper &)=delete
G4PhysicsTableHelper &	operator= (const G4PhysicsTableHelper &)=delete

Static Public Member Functions
static G4PhysicsTable *	PreparePhysicsTable (G4PhysicsTable *physTable)
static G4bool	RetrievePhysicsTable (G4PhysicsTable *physTable, const G4String &fileName, G4bool ascii)
static void	SetPhysicsVector (G4PhysicsTable *physTable, std::size_t idx, G4PhysicsVector *vec)
static void	SetVerboseLevel (G4int value)
static G4int	GetVerboseLevel ()

Protected Member Functions
	G4PhysicsTableHelper ()
	~G4PhysicsTableHelper ()

Static Protected Attributes
static G4ThreadLocal G4int	verboseLevel = 1

Detailed Description

Definition at line 46 of file G4PhysicsTableHelper.hh.

Constructor & Destructor Documentation

G4PhysicsTableHelper() [1/2]

G4PhysicsTableHelper::G4PhysicsTableHelper ( const G4PhysicsTableHelper &  )

delete

G4PhysicsTableHelper() [2/2]

G4PhysicsTableHelper::G4PhysicsTableHelper ( )

protected

Definition at line 37 of file G4PhysicsTableHelper.cc.

{
}

~G4PhysicsTableHelper()

G4PhysicsTableHelper::~G4PhysicsTableHelper ( )

protected

Definition at line 42 of file G4PhysicsTableHelper.cc.

{
}

Member Function Documentation

GetVerboseLevel()

G4int G4PhysicsTableHelper::GetVerboseLevel ( )

static

Definition at line 245 of file G4PhysicsTableHelper.cc.

{
  return verboseLevel;
}

operator=()

G4PhysicsTableHelper & G4PhysicsTableHelper::operator= ( const G4PhysicsTableHelper &  )

delete

PreparePhysicsTable()

G4PhysicsTable * G4PhysicsTableHelper::PreparePhysicsTable ( G4PhysicsTable *  physTable )

static

Definition at line 48 of file G4PhysicsTableHelper.cc.

{
  G4ProductionCutsTable* cutTable
    = G4ProductionCutsTable::GetProductionCutsTable();
  std::size_t numberOfMCC = cutTable->GetTableSize(); 
 
  if ( physTable != nullptr)
  {
    // compare size of physics table and number of material-cuts-couple
    if ( physTable->size() < numberOfMCC)
    {
      // enlarge physics table
      physTable->resize(numberOfMCC, nullptr);
#ifdef G4VERBOSE  
      if (verboseLevel>2)
      {
        G4cerr << "G4PhysicsTableHelper::PreparePhysicsTable  ";
        G4cerr << "Physics Table "<< physTable ;
        G4cerr << " is resized to " << numberOfMCC << G4endl;
      }
#endif 
    }
    else if ( physTable->size() > numberOfMCC)
    {
      // ERROR: this situation should not occur  
      // size of physics table is shorter than number of material-cuts-couple
      physTable->resize(numberOfMCC);
#ifdef G4VERBOSE  
      if (verboseLevel>0)
      {
        G4cerr << "G4PhysicsTableHelper::PreparePhysicsTable  ";
        G4cerr << "Physics Table "<< physTable ;
        G4cerr << " is longer than number of material-cuts-couple " << G4endl;
      }
#endif 
      G4Exception( "G4PhysicsTableHelper::PreparePhysicsTable()",
                   "ProcCuts001", FatalException, 
                   "Physics Table is inconsistent with  material-cuts-couple");
    } 
  }
  else
  {
    // create PhysicsTable is given poitner is null
    physTable = new G4PhysicsTable(numberOfMCC);
    if (physTable != nullptr)
    {
      physTable->resize(numberOfMCC, nullptr);
    }
    else
    {
      G4Exception( "G4PhysicsTableHelper::PreparePhysicsTable()",
                   "ProcCuts002", FatalException, 
                   "Can't create Physics Table");
    }
  }
 
#ifdef G4VERBOSE  
  if (verboseLevel>2)
  {
    if ( physTable != nullptr)
    { 
      G4cerr << "Physics Table size "<< physTable->size();
    }
    else
    {
      G4cerr << "Physics Table does not exist   ";
    }
    G4cerr << ": number of material-cuts-couple " << numberOfMCC << G4endl;
  }
#endif 
 
  // Reset recal-needed flag for all physics vectors
  physTable->ResetFlagArray();
 
  for (std::size_t idx = 0; idx <numberOfMCC; ++idx)
  {
    const G4MaterialCutsCouple* mcc = cutTable->GetMaterialCutsCouple(idx);
 
    // check if re-calculation of the physics vector is needed 
    // MCC is not used
    if ( !mcc->IsUsed() ) physTable->ClearFlag(idx);
 
    // RecalcNeeded flag of MCC is not asserted 
    if ( !mcc->IsRecalcNeeded() ) physTable->ClearFlag(idx);
  }
  
  return physTable;
}

Referenced by G4LossTableBuilder::BuildTableForModel(), G4WentzelVIModel::Initialise(), G4EmDataHandler::MakeTable(), and G4VEnergyLossProcess::PreparePhysicsTable().

RetrievePhysicsTable()

G4bool G4PhysicsTableHelper::RetrievePhysicsTable ( G4PhysicsTable *  physTable, const G4String &  fileName, G4bool  ascii  )

static

Definition at line 138 of file G4PhysicsTableHelper.cc.

{
  if (physTable == nullptr ) return false;
  
  // retrieve physics table from the given file
  G4PhysicsTable* tempTable = new G4PhysicsTable();
  if (! tempTable->RetrievePhysicsTable(fileName,ascii) )
  {
#ifdef G4VERBOSE  
    if (verboseLevel>1)
    {
      G4cerr << "G4PhysicsTableHelper::RetrievePhysicsTable  ";
      G4cerr << "Fail to retrieve from "<< fileName << G4endl;
    }
#endif 
    G4Exception( "G4ProductionCutsTable::RetrievePhysicsTable()",
                 "ProcCuts105",
                 JustWarning, "Can not retrieve physics tables from file");
    delete tempTable;
    return false;
  } 
 
  G4ProductionCutsTable* cutTable
    = G4ProductionCutsTable::GetProductionCutsTable();  
  const G4MCCIndexConversionTable* converter
    = cutTable->GetMCCIndexConversionTable();
 
  // check physics table size
  if ( tempTable->size() != converter->size())
  {
#ifdef G4VERBOSE  
    if (verboseLevel>0)
    {
      G4cerr << "G4PhysicsTableHelper::RetrievePhysicsTable  ";
      G4cerr << "Size of the physics table in "<< fileName;
      G4cerr << "( size =" << tempTable->size() << ")";
      G4cerr << " is inconsistent with material-cut info";
      G4cerr << "( size =" << converter->size() << ")";
      G4cerr << G4endl;
    }
#endif
    G4Exception("G4ProductionCutsTable::RetrievePhysicsTable()",
                "ProcCuts106", JustWarning,
                "Retrieved file is inconsistent with current physics tables!");
    delete tempTable;
    return false;
  }
  
  // fill the given physics table with retrieved physics vectors 
  for (std::size_t idx=0; idx<converter->size(); ++idx)
  {
    if (converter->IsUsed(idx))
    {
      if (converter->GetIndex(idx)<0) continue;
      std::size_t i = converter->GetIndex(idx);
      G4PhysicsVector* vec = (*physTable)[i];
      if (vec != nullptr ) delete vec;
      (*physTable)[i] = (*tempTable)[idx];
      physTable->ClearFlag(i);
    }
  }
  tempTable->clear();
  delete tempTable;
 
  return true;
}

Referenced by G4VEmProcess::RetrievePhysicsTable(), and G4EmDataHandler::RetrievePhysicsTable().

SetPhysicsVector()

void G4PhysicsTableHelper::SetPhysicsVector ( G4PhysicsTable *  physTable, std::size_t  idx, G4PhysicsVector *  vec  )

static

Definition at line 208 of file G4PhysicsTableHelper.cc.

{
  if ( physTable == nullptr) {  return;  }
 
  if ( physTable->size() <= idx)
  {
#ifdef G4VERBOSE  
    if (verboseLevel>0)
    {
      G4cerr << "G4PhysicsTableHelper::SetPhysicsVector   ";
      G4cerr << "Given index (" << idx << ")  exceeds ";
      G4cerr << "size of the physics table ";
      G4cerr << "( size =" << physTable->size()<< ")";
      G4cerr << G4endl;
    }
#endif
    G4Exception("G4ProductionCutsTable::SetPhysicsVector()",
                "ProcCuts107",
                JustWarning, "Illegal index!");
    return;
  } 
 
  // set physics vector 
  (*physTable)[idx] = vec;
  // clear flag
  physTable->ClearFlag(idx);
}

Referenced by G4VEnergyLossProcess::BuildDEDXTable(), G4LossTableBuilder::BuildDEDXTable(), G4LossTableBuilder::BuildInverseRangeTable(), G4VEnergyLossProcess::BuildLambdaTable(), G4LossTableBuilder::BuildRangeTable(), G4LossTableBuilder::BuildTableForModel(), and G4GammaGeneralProcess::InitialiseProcess().

SetVerboseLevel()

void G4PhysicsTableHelper::SetVerboseLevel ( G4int  value )

static

Definition at line 239 of file G4PhysicsTableHelper.cc.

{
  verboseLevel = value;
}

Member Data Documentation

verboseLevel

G4ThreadLocal G4int G4PhysicsTableHelper::verboseLevel = 1

staticprotected

Definition at line 81 of file G4PhysicsTableHelper.hh.

Referenced by GetVerboseLevel(), PreparePhysicsTable(), RetrievePhysicsTable(), SetPhysicsVector(), and SetVerboseLevel().

---

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

• G4PhysicsTableHelper.hh
• G4PhysicsTableHelper.cc