genie::RunOpt Class Reference

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

#include "/cvmfs/nova.opensciencegrid.org/externals/genie/v3_00_06_p01a/Linux64bit+3.10-2.17-e19-debug/GENIE-Generator/src/Framework/Utils/RunOpt.h"

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)

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 <costas.andreopoulos stfc.ac.uk> University of Liverpool & STFC Rutherford Appleton Lab

January 29, 2013

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

Definition at line 36 of file RunOpt.h.

Constructor & Destructor Documentation

genie::RunOpt::RunOpt ( )

private

Definition at line 48 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 55 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 52 of file RunOpt.h.

References fEnableBareXSecPreCalc.

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

{ return fEnableBareXSecPreCalc;  }

void genie::RunOpt::BuildTune

(

)

build tune and inform XSecSplineList

Definition at line 100 of file RunOpt.cxx.

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

Referenced by Initialize(), main(), and XMLPath().

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

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

inline

Definition at line 47 of file RunOpt.h.

References fCacheFile.

{ return fCacheFile;              }

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

inline

Definition at line 61 of file RunOpt.h.

References fEnableBareXSecPreCalc, Init(), operator<<, MECModelEnuComparisons::opt, Print(), and runNovaSAM::stream.

Referenced by GetCommandLineArgs().

{ fEnableBareXSecPreCalc = flag; }

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

inline

Definition at line 46 of file RunOpt.h.

References fEventGeneratorList.

{ return fEventGeneratorList;     }

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

inline

Definition at line 50 of file RunOpt.h.

References fEventRecordPrintLevel.

{ return fEventRecordPrintLevel;  }

void genie::RunOpt::Init ( void  )

private

Definition at line 72 of file RunOpt.cxx.

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

Referenced by EnableBareXSecPreCalc(), and 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 62 of file RunOpt.cxx.

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

Referenced by genie::EventGeneratorListAssembler::AssembleGeneratorList(), GenerateEventsAtFixedInitState(), GetCommandLineArgs(), GetEventGenDriver(), Initialize(), genie::DISXSec::Integrate(), genie::DMDISXSec::Integrate(), genie::ReinSehgalRESXSec::Integrate(), genie::ReinSehgalRESXSecFast::Integrate(), genie::QPMDISPXSec::LoadConfig(), genie::QPMDMDISPXSec::LoadConfig(), and main().

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

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

inline

Definition at line 51 of file RunOpt.h.

References fMCJobStatusRefreshRate.

{ return fMCJobStatusRefreshRate; }

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

inline

Definition at line 48 of file RunOpt.h.

References fMesgThresholds.

{ return fMesgThresholds;         }

void genie::RunOpt::Print

(

ostream &

stream

)

const

Definition at line 165 of file RunOpt.cxx.

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

Referenced by EnableBareXSecPreCalc(), and 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 107 of file RunOpt.cxx.

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

Referenced by GetCommandLineArgs().

{
  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
  }

}

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

inline

Definition at line 60 of file RunOpt.h.

References fEventGeneratorList.

Referenced by ReadFromCommandLine().

{ fEventGeneratorList = evgenlist; }

void genie::RunOpt::SetTuneName

(

string

tuneName = "Default"

)

Definition at line 89 of file RunOpt.cxx.

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

Referenced by ReadFromCommandLine(), and XMLPath().

{
  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 45 of file RunOpt.h.

References fTune.

Referenced by BuildTune().

{ return fTune;                   }

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

inline

Definition at line 49 of file RunOpt.h.

References fUnphysEventMask.

{ return fUnphysEventMask;        }

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

inline

Definition at line 53 of file RunOpt.h.

References BuildTune(), fXMLPath, and SetTuneName().

{ return fXMLPath;  }

Friends And Related Function Documentation

friend struct Cleaner

friend

Definition at line 101 of file RunOpt.h.

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

friend

Definition at line 40 of file RunOpt.cxx.

Referenced by EnableBareXSecPreCalc().

{
  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 74 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 79 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 73 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 77 of file RunOpt.h.

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

RunOpt * genie::RunOpt::fInstance = 0

staticprivate

Definition at line 84 of file RunOpt.h.

Referenced by Instance(), genie::operator<<(), RunOpt(), genie::RunOpt::Cleaner::~Cleaner(), and ~RunOpt().

int genie::RunOpt::fMCJobStatusRefreshRate

private

MC job status file refresh rate.

Definition at line 78 of file RunOpt.h.

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

string genie::RunOpt::fMesgThresholds

private

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

Definition at line 75 of file RunOpt.h.

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

TuneId* genie::RunOpt::fTune

private

GENIE comprehensive neutrino interaction model tune.

Definition at line 72 of file RunOpt.h.

Referenced by Init(), Print(), SetTuneName(), Tune(), and ~RunOpt().

TBits* genie::RunOpt::fUnphysEventMask

private

Unphysical event mask.

Definition at line 76 of file RunOpt.h.

Referenced by Init(), Print(), ReadFromCommandLine(), UnphysEventMask(), and ~RunOpt().

string genie::RunOpt::fXMLPath

private

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

Definition at line 81 of file RunOpt.h.

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

---

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

• Framework/Utils/RunOpt.h
• Framework/Utils/RunOpt.cxx