Some common run-time GENIE options. More...

#include <RunOpt.h>

Collaboration diagram for genie::RunOpt:

Classes
struct	Cleaner

Public Member Functions
void	ReadFromCommandLine (int argc, char **argv)

TuneId *	Tune (void) const

string	EventGeneratorList (void) const

string	CacheFile (void) const

string	MesgThresholdFiles (void) const

TBits *	UnphysEventMask (void) const

int	EventRecordPrintLevel (void) const

int	MCJobStatusRefreshRate (void) const

bool	BareXSecPreCalc (void) const

string	XMLPath (void) const

void	SetTuneName (string tuneName="Default")

void	BuildTune ()
	build tune and inform XSecSplineList More...

void	SetEventGeneratorList (string evgenlist)

void	EnableBareXSecPreCalc (bool flag)

void	Print (ostream &stream) const

Static Public Member Functions
static RunOpt *	Instance (void)

static std::string	RunOptSyntaxString (bool include_generator_specific)

Private Member Functions
void	Init (void)

	RunOpt ()

	RunOpt (const RunOpt &opt)

virtual	~RunOpt ()

Private Attributes
TuneId *	fTune
	GENIE comprehensive neutrino interaction model tune. More...

string	fEventGeneratorList
	Name of event generator list to be loaded by the event generation drivers. More...

string	fCacheFile
	Name of cache file, is cache is to be re-used. More...

string	fMesgThresholds
	List of files (delimited with : if more than one) with custom mesg stream thresholds. More...

TBits *	fUnphysEventMask
	Unphysical event mask. More...

int	fEventRecordPrintLevel
	GHEP event r ecord print level. More...

int	fMCJobStatusRefreshRate
	MC job status file refresh rate. More...

bool	fEnableBareXSecPreCalc

string	fXMLPath
	An path to look for XML in. Higher priority than GXMLPATH. More...

Static Private Attributes
static RunOpt *	fInstance = 0

Friends
struct	Cleaner

ostream &	operator<< (ostream &stream, const RunOpt &opt)

Detailed Description

Some common run-time GENIE options.

Author: Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool

Created:: January 29, 2013

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

Definition at line 35 of file RunOpt.h.

Constructor & Destructor Documentation

genie::RunOpt::RunOpt ( )

private

Definition at line 40 of file RunOpt.cxx.

References fInstance, and Init().

Referenced by Instance().

                : fTune(0)
 {
   fInstance = 0;
 
   this->Init();
 }

genie::RunOpt::RunOpt ( const RunOpt & opt )

private

genie::RunOpt::~RunOpt ( )

privatevirtual

Definition at line 47 of file RunOpt.cxx.

References fInstance, fTune, and fUnphysEventMask.

 {
   if ( fTune )                    delete fTune ;
   if ( fUnphysEventMask )         delete fUnphysEventMask ;
   fInstance = 0;
 }

Member Function Documentation

bool genie::RunOpt::BareXSecPreCalc ( void ) const

inline

Definition at line 53 of file RunOpt.h.

References fEnableBareXSecPreCalc.

Referenced by genie::DISXSec::Integrate(), genie::DMDISXSec::Integrate(), genie::SPPXSec::Integrate(), genie::ReinSehgalRESXSec::Integrate(), genie::ReinSehgalRESXSecFast::Integrate(), genie::KNOTunedQPMDISPXSec::LoadConfig(), and genie::QPMDMDISPXSec::LoadConfig().

53 { return fEnableBareXSecPreCalc; }

genie::RunOpt::fEnableBareXSecPreCalc

bool fEnableBareXSecPreCalc

Definition: RunOpt.h:80

void genie::RunOpt::BuildTune ( )

build tune and inform XSecSplineList

Definition at line 92 of file RunOpt.cxx.

References genie::TuneId::Build(), genie::XSecSplineList::Instance(), LOG, genie::TuneId::Name(), pINFO, genie::XSecSplineList::SetCurrentTune(), and Tune().

Referenced by Initialize(), and main().

 {
   LOG("RunOpt",pINFO) << "Building tune "<<Tune()->Name();
   Tune()->Build() ;
   XSecSplineList::Instance()->SetCurrentTune( Tune()->Name() ) ;
 }

string genie::RunOpt::CacheFile ( void ) const

inline

Definition at line 48 of file RunOpt.h.

References fCacheFile.

48 { return fCacheFile; }

genie::RunOpt::fCacheFile

string fCacheFile

Name of cache file, is cache is to be re-used.

Definition: RunOpt.h:75

void genie::RunOpt::EnableBareXSecPreCalc ( bool flag )

inline

Definition at line 62 of file RunOpt.h.

References fEnableBareXSecPreCalc.

62 { fEnableBareXSecPreCalc = flag; }

genie::RunOpt::fEnableBareXSecPreCalc

bool fEnableBareXSecPreCalc

Definition: RunOpt.h:80

string genie::RunOpt::EventGeneratorList ( void ) const

inline

Definition at line 47 of file RunOpt.h.

References fEventGeneratorList.

Referenced by main().

47 { return fEventGeneratorList; }

genie::RunOpt::fEventGeneratorList

string fEventGeneratorList

Name of event generator list to be loaded by the event generation drivers.

Definition: RunOpt.h:74

int genie::RunOpt::EventRecordPrintLevel ( void ) const

inline

Definition at line 51 of file RunOpt.h.

References fEventRecordPrintLevel.

Referenced by main().

51 { return fEventRecordPrintLevel; }

genie::RunOpt::fEventRecordPrintLevel

int fEventRecordPrintLevel

GHEP event r ecord print level.

Definition: RunOpt.h:78

void genie::RunOpt::Init ( void )

private

Definition at line 64 of file RunOpt.cxx.

References fCacheFile, fEnableBareXSecPreCalc, fEventGeneratorList, fEventRecordPrintLevel, fMCJobStatusRefreshRate, fMesgThresholds, fTune, fUnphysEventMask, fXMLPath, and genie::GHepFlags::NFlags().

Referenced by RunOpt().

 {
   fTune = 0 ;
   fEnableBareXSecPreCalc = true;
   fCacheFile = "";
   fMesgThresholds = "";
   fUnphysEventMask = new TBits(GHepFlags::NFlags());
 //fUnphysEventMask->ResetAllBits(true);
   for(unsigned int i = 0; i < GHepFlags::NFlags(); i++) {
    fUnphysEventMask->SetBitNumber(i, true);
   }
   fMCJobStatusRefreshRate = 50;
   fEventRecordPrintLevel  = 3;
   fEventGeneratorList     = "Default";
   fXMLPath = "";
 }

RunOpt * genie::RunOpt::Instance ( void )

static

Definition at line 54 of file RunOpt.cxx.

References genie::RunOpt::Cleaner::DummyMethodAndSilentCompiler(), fInstance, and RunOpt().

Referenced by genie::EventGeneratorListAssembler::AssembleGeneratorList(), DecodeCommandLine(), GenerateEventsAtFixedInitState(), GetCommandLineArgs(), GetEventGenDriver(), genie::HEDISStrucFunc::HEDISStrucFunc(), genie::NtpWriter::Initialize(), Initialize(), genie::DISXSec::Integrate(), genie::DMDISXSec::Integrate(), genie::SPPXSec::Integrate(), genie::ReinSehgalRESXSec::Integrate(), genie::ReinSehgalRESXSecFast::Integrate(), genie::KNOTunedQPMDISPXSec::LoadConfig(), genie::QPMDMDISPXSec::LoadConfig(), main(), and TestDecay().

 {
   if(fInstance == 0) {
     static RunOpt::Cleaner cleaner;
     cleaner.DummyMethodAndSilentCompiler();
     fInstance = new RunOpt;
   }
   return fInstance;
 }

int genie::RunOpt::MCJobStatusRefreshRate ( void ) const

inline

Definition at line 52 of file RunOpt.h.

References fMCJobStatusRefreshRate.

52 { return fMCJobStatusRefreshRate; }

genie::RunOpt::fMCJobStatusRefreshRate

int fMCJobStatusRefreshRate

MC job status file refresh rate.

Definition: RunOpt.h:79

string genie::RunOpt::MesgThresholdFiles ( void ) const

inline

Definition at line 49 of file RunOpt.h.

References fMesgThresholds.

49 { return fMesgThresholds; }

genie::RunOpt::fMesgThresholds

string fMesgThresholds

List of files (delimited with : if more than one) with custom mesg stream thresholds.

Definition: RunOpt.h:76

void genie::RunOpt::Print ( ostream & stream ) const

Definition at line 185 of file RunOpt.cxx.

References fCacheFile, fEnableBareXSecPreCalc, fEventGeneratorList, fEventRecordPrintLevel, fMCJobStatusRefreshRate, fMesgThresholds, fTune, fUnphysEventMask, fXMLPath, and genie::GHepFlags::NFlags().

Referenced by genie::operator<<().

 {
   stream << "Global running options:";
   if ( fTune ) stream << "\n GENIE tune: " << *fTune;
   stream << "\n Event generator list: " << fEventGeneratorList;
   stream << "\n User-specified message thresholds : " << fMesgThresholds;
   stream << "\n Cache file : " << fCacheFile;
   stream << "\n Unphysical event mask (bits: "
          << GHepFlags::NFlags()-1 << " -> 0) : " << *fUnphysEventMask;
   stream << "\n Event record print level : " << fEventRecordPrintLevel;
   stream << "\n MC job status file refresh rate: " << fMCJobStatusRefreshRate;
   stream << "\n Pre-calculate all free-nucleon cross-sections? : "
          << ((fEnableBareXSecPreCalc) ? "Yes" : "No");
 
   if (fXMLPath.size()) {
     stream << "\n XMLPath over-ride : "<<fXMLPath;
   }
 
   stream << "\n";
 }

void genie::RunOpt::ReadFromCommandLine	(	int	argc,
		char **	argv
	)

Definition at line 99 of file RunOpt.cxx.

References genie::CmdLnArgParser::ArgAsInt(), genie::CmdLnArgParser::ArgAsString(), fCacheFile, fEnableBareXSecPreCalc, fEventRecordPrintLevel, fMCJobStatusRefreshRate, fMesgThresholds, fUnphysEventMask, fXMLPath, LOG, genie::GHepFlags::NFlags(), genie::CmdLnArgParser::OptionExists(), pDEBUG, SetEventGeneratorList(), and SetTuneName().

Referenced by DecodeCommandLine(), GetCommandLineArgs(), and main().

 {
   LOG("RunOpt",pDEBUG) << "Reading "<<argc-1<<" command line arguments.";
   CmdLnArgParser parser(argc,argv);
 
   if( parser.OptionExists("enable-bare-xsec-pre-calc") ) {
     fEnableBareXSecPreCalc = true;
   } else
   if( parser.OptionExists("disable-bare-xsec-pre-calc") ) {
     fEnableBareXSecPreCalc = false;
   }
 
   if( parser.OptionExists("cache-file") ) {
     fCacheFile = parser.ArgAsString("cache-file");
   }
 
   if( parser.OptionExists("message-thresholds") ) {
     fMesgThresholds = parser.ArgAsString("message-thresholds");
   }
 
   if( parser.OptionExists("event-record-print-level") ) {
     fEventRecordPrintLevel = parser.ArgAsInt("event-record-print-level");
   }
 
   if( parser.OptionExists("mc-job-status-refresh-rate") ) {
     fMCJobStatusRefreshRate = TMath::Max(
         1, parser.ArgAsInt("mc-job-status-refresh-rate"));
   }
 
   if( parser.OptionExists("event-generator-list") ) {
     SetEventGeneratorList(parser.ArgAsString("event-generator-list"));
   }
 
   if (parser.OptionExists("xml-path")) {
     fXMLPath = parser.ArgAsString("xml-path");
   }
 
   if( parser.OptionExists("tune") ) {
     SetTuneName( parser.ArgAsString("tune") ) ;
   }
   else {
     SetTuneName( "Default" );
   }// else ( parser.OptionExists("tune") )
 
   if( parser.OptionExists("unphysical-event-mask") ) {
     const char * bitfield =
        parser.ArgAsString("unphysical-event-mask").c_str();
     unsigned int n = GHepFlags::NFlags();
     unsigned int i = 0;
     while (i < n) {
         bool flag = (bitfield[i]=='1');
         fUnphysEventMask->SetBitNumber(n-1-i,flag);
         i++;
      } //i
   }
 
 }

std::string genie::RunOpt::RunOptSyntaxString ( bool include_generator_specific )

static

Definition at line 157 of file RunOpt.cxx.

References genie::gDefaultTune, and genie::units::s.

 {
   std::ostringstream s;
   s << "\n"
     << "\n // command line args handled by RunOpt:"
     // for v3, all tunes should have a Default event-generator-list
     << "\n         [--event-generator-list list_name] // default \"Default\" "
     // G18_02a_00_000 is currently the default tune
     << "\n         [--tune tune_name]  // default \"" << gDefaultTune << "\" "
     << "\n         [--xml-path path]"
     << "\n         [--message-thresholds xml_file]";
 
   if (include_generator_specific) {
     // these options are only for generator applications
     //    << "\n // not all options used by all applications "
     s << "\n"
       << "\n         [--event-record-print-level level]"
       << "\n         [--mc-job-status-refresh-rate rate]"
       << "\n         [--cache-file root_file]"
       << "\n         [--enable-bare-xsec-pre-calc]"
       << "\n         [--disable-bare-xsec-pre-calc]"
       << "\n         [--unphysical-event-mask mask]"
       << "\n";
   }
 
   return s.str();
 }

void genie::RunOpt::SetEventGeneratorList ( string evgenlist )

inline

Definition at line 61 of file RunOpt.h.

References fEventGeneratorList.

Referenced by ReadFromCommandLine().

61 { fEventGeneratorList = evgenlist; }

genie::RunOpt::fEventGeneratorList

string fEventGeneratorList

Name of event generator list to be loaded by the event generation drivers.

Definition: RunOpt.h:74

void genie::RunOpt::SetTuneName ( string tuneName = "Default" )

Definition at line 81 of file RunOpt.cxx.

References fTune, genie::gDefaultTune, LOG, genie::TuneId::Name(), and pNOTICE.

Referenced by ReadFromCommandLine().

 {
   if ( tuneName == "Default" || tuneName == "" ) tuneName = gDefaultTune;
   if ( fTune ) {
     LOG("RunOpt",pNOTICE) << "RunOpt::SetTune() already had " << fTune->Name()
               << ", now being re-set to " << tuneName;
     delete fTune;
   }
   fTune = new TuneId( tuneName ) ;
 }

TuneId* genie::RunOpt::Tune ( void ) const

inline

Definition at line 46 of file RunOpt.h.

References fTune.

Referenced by BuildTune(), genie::HEDISStrucFunc::HEDISStrucFunc(), and genie::NtpWriter::Initialize().

46 { return fTune; }

genie::RunOpt::fTune

TuneId * fTune

GENIE comprehensive neutrino interaction model tune.

Definition: RunOpt.h:73

TBits* genie::RunOpt::UnphysEventMask ( void ) const

inline

Definition at line 50 of file RunOpt.h.

References fUnphysEventMask.

50 { return fUnphysEventMask; }

genie::RunOpt::fUnphysEventMask

TBits * fUnphysEventMask

Unphysical event mask.

Definition: RunOpt.h:77

string genie::RunOpt::XMLPath ( void ) const

inline

Definition at line 54 of file RunOpt.h.

References fXMLPath.

54 { return fXMLPath; }

genie::RunOpt::fXMLPath

string fXMLPath

An path to look for XML in. Higher priority than GXMLPATH.

Definition: RunOpt.h:82

Friends And Related Function Documentation

friend struct Cleaner

friend

Definition at line 102 of file RunOpt.h.

ostream& operator<<	(	ostream &	stream,
		const RunOpt &	opt
	)

friend

Definition at line 32 of file RunOpt.cxx.

 {
   opt.Print(stream);
   return stream;
 }

Member Data Documentation

string genie::RunOpt::fCacheFile

private

Name of cache file, is cache is to be re-used.

Definition at line 75 of file RunOpt.h.

Referenced by CacheFile(), Init(), Print(), and ReadFromCommandLine().

bool genie::RunOpt::fEnableBareXSecPreCalc

private

Cache calcs relevant to free-nucleon xsecs before any nuclear xsec computation? The option switches on/off cacheing calculations which interfere with event reweighting.

Definition at line 80 of file RunOpt.h.

Referenced by BareXSecPreCalc(), EnableBareXSecPreCalc(), Init(), Print(), and ReadFromCommandLine().

string genie::RunOpt::fEventGeneratorList

private

Name of event generator list to be loaded by the event generation drivers.

Definition at line 74 of file RunOpt.h.

Referenced by EventGeneratorList(), Init(), Print(), and SetEventGeneratorList().

int genie::RunOpt::fEventRecordPrintLevel

private

GHEP event r ecord print level.

Definition at line 78 of file RunOpt.h.

Referenced by EventRecordPrintLevel(), Init(), Print(), and ReadFromCommandLine().