G4EnvironmentUtils.hh File Reference

#include <cstdlib>
#include <iomanip>
#include <iostream>
#include <map>
#include <mutex>
#include <sstream>
#include <string>
#include "G4Exception.hh"
#include "G4ExceptionSeverity.hh"
#include "G4String.hh"
#include "G4ios.hh"

Go to the source code of this file.

Classes
class	G4EnvSettings

Functions
template<typename _Tp >
_Tp	G4GetEnv (const std::string &env_id, _Tp _default=_Tp())
template<>
G4bool	G4GetEnv (const std::string &env_id, bool _default)
template<typename _Tp >
_Tp	G4GetEnv (const std::string &env_id, _Tp _default, const std::string &msg)
G4String	G4GetDataEnv (const std::string &env_id, const char *originOfException, const char *exceptionCode, G4ExceptionSeverity severity, const char *description)
const char *	G4FindDataDir (const char *)
void	G4PrintEnv (std::ostream &os=G4cout)

Function Documentation

G4FindDataDir()

const char * G4FindDataDir

(

const char *

name

)

Definition at line 94 of file G4FindDataDir.cc.

{
#if defined(G4MULTITHREADED)
  static std::mutex mutex;
  std::lock_guard<std::mutex> lock(mutex);
#endif
 
  /* If environment variable is set for this dataset, use it */
  if (const char *datadir = std::getenv(name))
    return datadir;
 
  /* If we know which directory/version to search for, try to find it */
  if (const char *dataset = G4GetDataDir(name)) {
    /* If GEANT4_DATA_DIR environment variable is set, use it and don't search further */
    if (const char *basedir = std::getenv("GEANT4_DATA_DIR")) {
      if (is_directory(basedir)) return G4FindDataDir(name, basedir, dataset);
 
      G4Exception("G4FindDataDir", "Invalid GEANT4_DATA_DIR", JustWarning, "The GEANT4_DATA_DIR environment variable points to an invalid directory.\n"
                  "Will try fallback locations now. Correct the variable to disable this behaviour.");
    }
 
    /* If GEANT4_DATA_DIR environment variable is not set, search in default system paths */
    for (const auto prefix : system_paths)
      if (const auto datadir = G4FindDataDir(name, prefix, dataset))
        return datadir;
  }
 
  return nullptr;
}

Referenced by G4LENDBertiniGammaElectroNuclearBuilder::Build(), G4NeutronHPCapture::BuildPhysicsTable(), G4ParticleHPElastic::BuildPhysicsTable(), G4ParticleHPFission::BuildPhysicsTable(), G4ParticleHPJENDLHEData::BuildPhysicsTable(), G4ParticleHPThermalScatteringData::BuildPhysicsTable(), G4VLEPTSModel::BuildPhysicsTable(), G4IonStoppingData::BuildPhysicsVector(), G4IonStoppingData::BuildPhysicsVector(), G4INCL::NNbarToAnnihilationChannel::fillFinalState(), G4ecpssrBaseKxsModel::G4ecpssrBaseKxsModel(), G4ecpssrBaseLixsModel::G4ecpssrBaseLixsModel(), G4FindDataDir(), G4FissLib::G4FissLib(), G4LevelReader::G4LevelReader(), G4ParticleHPInelasticData::G4ParticleHPInelasticData(), G4PhotoElectricAngularGeneratorPolarized::G4PhotoElectricAngularGeneratorPolarized(), G4RadioactiveDecay::G4RadioactiveDecay(), G4NuclideTable::GenerateNuclide(), G4BoldyshevTripletModel::Initialise(), G4DNABornExcitationModel2::Initialise(), G4DNABornIonisationModel1::Initialise(), G4DNABornIonisationModel2::Initialise(), G4DNAChampionElasticModel::Initialise(), G4DNACPA100ElasticModel::Initialise(), G4DNACPA100ExcitationModel::Initialise(), G4DNACPA100IonisationModel::Initialise(), G4DNAELSEPAElasticModel::Initialise(), G4DNAEmfietzoglouIonisationModel::Initialise(), G4DNAIonElasticModel::Initialise(), G4DNARelativisticIonisationModel::Initialise(), G4DNASancheExcitationModel::Initialise(), G4JAEAElasticScatteringModel::Initialise(), G4JAEAPolarizedElasticScatteringModel::Initialise(), G4LivermoreBremsstrahlungModel::Initialise(), G4LivermoreNuclearGammaConversionModel::Initialise(), G4LivermorePolarizedComptonModel::Initialise(), G4LivermorePolarizedGammaConversionModel::Initialise(), G4LivermorePolarizedRayleighModel::Initialise(), G4LowEPComptonModel::Initialise(), G4LowEPPolarizedComptonModel::Initialise(), G4MicroElecElasticModel::Initialise(), G4MicroElecElasticModel_new::Initialise(), G4MicroElecInelasticModel::Initialise(), G4MicroElecInelasticModel_new::Initialise(), G4ANuElNucleusCcModel::InitialiseModel(), G4ANuElNucleusNcModel::InitialiseModel(), G4ANuMuNucleusCcModel::InitialiseModel(), G4ANuMuNucleusNcModel::InitialiseModel(), G4ANuTauNucleusCcModel::InitialiseModel(), G4ANuTauNucleusNcModel::InitialiseModel(), G4NuElNucleusCcModel::InitialiseModel(), G4NuElNucleusNcModel::InitialiseModel(), G4NuMuNucleusCcModel::InitialiseModel(), G4NuMuNucleusNcModel::InitialiseModel(), G4NuTauNucleusCcModel::InitialiseModel(), G4NuTauNucleusNcModel::InitialiseModel(), G4INCL::HFB::initialize(), G4DNARelativisticIonisationModel::LoadAtomicStates(), G4AugerData::LoadData(), G4FluoData::LoadData(), G4ShellData::LoadData(), G4VCrossSectionHandler::LoadData(), G4VCrossSectionHandler::LoadNonLogData(), G4FissionProductYieldDist::MakeDirectoryName(), G4INCL::PbarAtrestEntryChannel::makeMesonStar(), G4INCL::INCL::processEvent(), G4OpticalSurface::ReadCompressedFile(), G4AblaDataFile::readData(), G4OpticalSurface::ReadDichroicFile(), G4DNACPA100IonisationModel::ReadDiffCSFile(), and G4MicroElecMaterialStructure::ReadMaterialFile().

G4GetDataEnv()

G4String G4GetDataEnv ( const std::string & env_id, const char * originOfException, const char * exceptionCode, G4ExceptionSeverity severity, const char * description )

inline

Definition at line 198 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var != nullptr)
  {
    std::string str_var = std::string(env_var);
    std::istringstream iss(str_var);
    G4String var = "";
    iss >> var;
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<G4String>(env_id, var);
    return var;
  }
 
  // issue an exception
  G4Exception(originOfException, exceptionCode, severity, description);
 
  // return default initialized
  return "";
}

G4GetEnv() [1/3]

template<typename _Tp >

_Tp G4GetEnv	(	const std::string &	env_id,
		_Tp	_default,
		const std::string &	msg )

Definition at line 167 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var)
  {
    std::string str_var = std::string(env_var);
    std::istringstream iss(str_var);
    _Tp var = _Tp();
    iss >> var;
    G4cout << "Environment variable \"" << env_id << "\" enabled with "
           << "value == " << var << ". " << msg << G4endl;
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<_Tp>(env_id, var);
    return var;
  }
  // record default value
  G4EnvSettings::GetInstance()->insert<_Tp>(env_id, _default);
 
  // return default if not specified in environment
  return _default;
}

G4GetEnv() [2/3]

template<typename _Tp >

_Tp G4GetEnv	(	const std::string &	env_id,
		_Tp	_default = _Tp() )

Definition at line 116 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var)
  {
    std::string str_var = std::string(env_var);
    std::istringstream iss(str_var);
    _Tp var = _Tp();
    iss >> var;
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<_Tp>(env_id, var);
    return var;
  }
  // record default value
  G4EnvSettings::GetInstance()->insert<_Tp>(env_id, _default);
 
  // return default if not specified in environment
  return _default;
}

Referenced by G4TaskRunManager::ComputeNumberOfTasks(), G4RunManagerFactory::CreateRunManager(), G4RunManagerKernel::G4RunManagerKernel(), G4RunManagerKernel::G4RunManagerKernel(), G4TaskRunManager::G4TaskRunManager(), and G4GDMLRead::Read().

G4GetEnv() [3/3]

template<>

G4bool G4GetEnv ( const std::string & env_id, bool _default )

inline

Definition at line 143 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var != nullptr)
  {
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<bool>(env_id, true);
    return true;
  }
  // record default value
  G4EnvSettings::GetInstance()->insert<bool>(env_id, false);
 
  // return default if not specified in environment
  return _default;
}

G4PrintEnv()

void G4PrintEnv ( std::ostream & os = G4cout )

inline

Definition at line 228 of file G4EnvironmentUtils.hh.

{
  os << (*G4EnvSettings::GetInstance());
}