Creates hadron tensor objects for cross section calculations using precomputed data tables. More...

#include <TabulatedHadronTensorModelI.h>

Inheritance diagram for genie::TabulatedHadronTensorModelI:

Collaboration diagram for genie::TabulatedHadronTensorModelI:

Classes
struct	HadronTensorID
	Struct used to provide a unique ID for each tensor object. More...

Public Member Functions
virtual	~TabulatedHadronTensorModelI ()

virtual void	Configure (const Registry &config)

virtual void	Configure (std::string config)

virtual const HadronTensorI *	GetTensor (int tensor_pdg, HadronTensorType_t type) const

Public Member Functions inherited from genie::HadronTensorModelI
virtual	~HadronTensorModelI ()

Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()

virtual void	Configure (string config)

virtual void	FindConfig (void)

virtual const Registry &	GetConfig (void) const

Registry *	GetOwnedConfig (void)

virtual const AlgId &	Id (void) const
	Get algorithm ID. More...

virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status. More...

virtual bool	AllowReconfig (void) const

virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm. More...

virtual void	SetId (const AlgId &id)
	Set algorithm ID. More...

virtual void	SetId (string name, string config)

const Algorithm *	SubAlg (const RgKey &registry_key) const

void	AdoptConfig (void)

void	AdoptSubstructure (void)

virtual void	Print (ostream &stream) const
	Print algorithm info. More...

Protected Member Functions
	TabulatedHadronTensorModelI ()

	TabulatedHadronTensorModelI (std::string name)

	TabulatedHadronTensorModelI (std::string name, std::string config)

void	LoadConfig ()
	Saves some basic XML config parameters to data members. More...

std::string	FindTensorTableFile (const std::string &basename, bool &ok) const

const HadronTensorI *	BuildTensor (const HadronTensorID &ht_id) const
	Create a HadronTensorI object given a particular HadronTensorID. More...

std::string	GetTensorFileBasename (const HadronTensorID &ht_id) const

virtual HadronTensorI *	ParseTensorFile (const std::string &full_file_name) const =0

Protected Member Functions inherited from genie::HadronTensorModelI
	HadronTensorModelI ()

	HadronTensorModelI (std::string name)

	HadronTensorModelI (std::string name, std::string config)

Protected Member Functions inherited from genie::Algorithm
	Algorithm ()

	Algorithm (string name)

	Algorithm (string name, string config)

void	Initialize (void)

void	DeleteConfig (void)

void	DeleteSubstructure (void)

Registry *	ExtractLocalConfig (const Registry &in) const

Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key. More...

template<class T >
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const

template<class T >
bool	GetParamDef (const RgKey &name, T &p, const T &def) const

template<class T >
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters. More...

int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const

template<class T >
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters. More...

template<class T >
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const

int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const

int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership More...

int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership More...

int	MergeTopRegistry (const Registry &r)

int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships. More...

Protected Attributes
bool	fWarnIfMissing

std::map< HadronTensorID, HadronTensorI * >	fTensors

std::vector< std::string >	fDataPaths
	Paths to check when searching for hadron tensor data files. More...

Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig

bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...) More...

AlgId	fID
	algorithm name and configuration set More...

vector< Registry * >	fConfVect

vector< bool >	fOwnerships
	ownership for every registry in fConfVect More...

AlgStatus_t	fStatus
	algorithm execution status More...

AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool) More...

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)

static string	BuildParamVectSizeKey (const std::string &comm_name)

static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)

static string	BuildParamMatRowSizeKey (const std::string &comm_name)

static string	BuildParamMatColSizeKey (const std::string &comm_name)

Detailed Description

Creates hadron tensor objects for cross section calculations using precomputed data tables.

Author: Steven Gardiner <gardiner fnal.gov> Liang Liu <liangliu fnal.gov> Fermi National Accelerator Laboratory

Created:: April 26, 2019

License:: Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org or see $GENIE/LICENSE

Definition at line 37 of file TabulatedHadronTensorModelI.h.

Constructor & Destructor Documentation

genie::TabulatedHadronTensorModelI::~TabulatedHadronTensorModelI ( )

virtual

Definition at line 255 of file TabulatedHadronTensorModelI.cxx.

 {
   std::map< HadronTensorID, HadronTensorI* >::iterator it;
   for (it = fTensors.begin(); it != fTensors.end(); ++it) {
     HadronTensorI* t = it->second;
     if ( t ) delete t;
   }
   fTensors.clear();
 }

genie::TabulatedHadronTensorModelI::TabulatedHadronTensorModelI ( )

protected

Definition at line 197 of file TabulatedHadronTensorModelI.cxx.

   : genie::HadronTensorModelI()
 {
 
 }

genie::TabulatedHadronTensorModelI::TabulatedHadronTensorModelI ( std::string name )

protected

Definition at line 204 of file TabulatedHadronTensorModelI.cxx.

   : genie::HadronTensorModelI( name )
 {
 
 }

genie::TabulatedHadronTensorModelI::TabulatedHadronTensorModelI	(	std::string	name,
		std::string	config
	)

protected

Definition at line 211 of file TabulatedHadronTensorModelI.cxx.

                     : genie::HadronTensorModelI(name, config)
 {
 
 }

Member Function Documentation

const genie::HadronTensorI * genie::TabulatedHadronTensorModelI::BuildTensor ( const HadronTensorID & ht_id ) const

protected

Create a HadronTensorI object given a particular HadronTensorID.

Todo:: Switch to using std::unique_ptr here for easy cleanup once C++11 features are allowed in GENIE

Definition at line 302 of file TabulatedHadronTensorModelI.cxx.

References LOG, pERROR, pINFO, genie::TabulatedHadronTensorModelI::HadronTensorID::target_pdg, and genie::TabulatedHadronTensorModelI::HadronTensorID::type.

 {
   bool tensor_ok = true;
 
   std::string tensor_file_basename = this->GetTensorFileBasename( tensor_id );
 
   // Tensor values are represented using a 2D grid that is stored in a data
   // file. Get the full path to the file, or an empty string if it could not
   // be found. Also set the tensor_ok flag to false if the file could not be
   // found.
   std::string full_file_name = FindTensorTableFile(tensor_file_basename,
     tensor_ok);
 
   if ( tensor_ok ) {
 
     // Create the new hadron tensor object
     LOG("TabulatedHadronTensorModelI", pINFO) << "Loading the hadron"
       << " tensor data file " << full_file_name;
 
     genie::HadronTensorI* temp_ptr = this->ParseTensorFile( full_file_name );
 
     // Place a pointer to it in the map of loaded tensor objects for easy
     // retrieval.
     /// \todo Switch to using std::unique_ptr here for easy cleanup
     /// once C++11 features are allowed in GENIE
     fTensors[tensor_id] = temp_ptr;
 
     // Return a pointer to the newly-created hadron tensor object
     return temp_ptr;
   }
 
   else {
     // If we couldn't make the hadron tensor, store a nullptr to avoid
     // unsuccessful repeat attempts. These can otherwise slow things down
     // for no good reason.
     fTensors[tensor_id] = NULL;
 
     if ( fWarnIfMissing ) {
       LOG("TabulatedHadronTensorModelI", pERROR) << "The hadron tensor data file \""
         << full_file_name << "\" requested for target pdg = "
         << tensor_id.target_pdg << " and hadron tensor type "
         << tensor_id.type << " could not be found.";
     }
   }
 
   // If there was a problem, return a null pointer
   return NULL;
 }

void genie::TabulatedHadronTensorModelI::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 218 of file TabulatedHadronTensorModelI.cxx.

References genie::Algorithm::Configure().

 {
   HadronTensorModelI::Configure( config );
   this->LoadConfig();
 }

void genie::TabulatedHadronTensorModelI::Configure ( std::string config )

virtual

Definition at line 224 of file TabulatedHadronTensorModelI.cxx.

References genie::Algorithm::Configure().

 {
   HadronTensorModelI::Configure( config );
   this->LoadConfig();
 }

std::string genie::TabulatedHadronTensorModelI::FindTensorTableFile	(	const std::string &	basename,
		bool &	ok
	)		const

protected

Looks up the full path when constructing hadron tensor objects that are based on a data file

Definition at line 287 of file TabulatedHadronTensorModelI.cxx.

 {
   for (size_t p = 0; p < fDataPaths.size(); ++p) {
     const std::string& path = fDataPaths.at( p );
     std::string full_name = path + '/' + basename;
     if ( file_exists(full_name) ) return full_name;
   }
 
   // A matching file could not be found
   ok = false;
   return std::string();
 }

const genie::HadronTensorI * genie::TabulatedHadronTensorModelI::GetTensor	(	int	tensor_pdg,
		HadronTensorType_t	type
	)		const

virtual

Retrieves a pointer to a hadron tensor object appropriate for this model

Parameters

[in]	tensor_pdg	The PDG code for the nuclide described by the tensor
[in]	type	The desired kind of hadron tensor

Returns: A pointer to the requested hadron tensor, or NULL if a match could not be found/created

Implements genie::HadronTensorModelI.

Definition at line 265 of file TabulatedHadronTensorModelI.cxx.

References LOG, pWARN, genie::TabulatedHadronTensorModelI::HadronTensorID::target_pdg, and genie::TabulatedHadronTensorModelI::HadronTensorID::type.

 {
   HadronTensorID temp_id(tensor_pdg, type);
 
   // First check to see if the hadron tensor object already exists in memory.
   // If it does, return the existing object.
   if ( fTensors.count(temp_id) ) return fTensors.find(temp_id)->second;
 
   // If not, try to create it
   const HadronTensorI* ht = this->BuildTensor( temp_id );
 
   if ( !ht && fWarnIfMissing ) {
     LOG("TabulatedHadronTensorModelI", pWARN) << "Unable to create a hadron tensor"
       << " for target pdg = " << temp_id.target_pdg
       << " and hadron tensor type " << temp_id.type;
   }
 
   return ht;
 }

std::string genie::TabulatedHadronTensorModelI::GetTensorFileBasename ( const HadronTensorID & ht_id ) const

protected

Loads the basename for a particular hadron tensor file from the configuration Registry

Definition at line 353 of file TabulatedHadronTensorModelI.cxx.

References genie::TabulatedHadronTensorModelI::HadronTensorID::target_pdg, and genie::TabulatedHadronTensorModelI::HadronTensorID::type.

 {
 
   std::string tgt_string;
   std::stringstream ss;
   ss <<  ht_id.target_pdg;
   tgt_string = ss.str();
 
   RgKey key = tensor_type_to_string( ht_id.type ) + "@Pdg="
     + tgt_string;
 
   std::string basename;
   GetParamDef( key, basename, std::string("TENSOR_FILE_NOT_FOUND") );
 
   return basename;
 }

void genie::TabulatedHadronTensorModelI::LoadConfig ( void )

protected

Saves some basic XML config parameters to data members.

Definition at line 230 of file TabulatedHadronTensorModelI.cxx.

 {
   GetParamDef( "WarnIfMissing", fWarnIfMissing, true );
 
   // Either a data path relative to the root GENIE folder
   // or an absolute path can be used. Find out which
   // option was chosen.
   std::string path_type;
   GetParamDef( "DataPathType", path_type, std::string("relative") );
 
   // Right now, there can only be a single data path
   // specified. We use a vector of paths to allow for
   // easy expansion later.
   std::string data_path;
   GetParam( "DataPath", data_path );
 
   // Convert the relative path to an absolute one if needed
   if ( path_type == "relative" ) {
     data_path = std::string( gSystem->Getenv("GENIE") ) + '/' + data_path;
   }
 
   fDataPaths.push_back( data_path );
 }