genie::RunOpt Class Reference

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
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.
string	fEventGeneratorList
	Name of event generator list to be loaded by the event generation drivers.
string	fCacheFile
	Name of cache file, is cache is to be re-used.
string	fMesgThresholds
	List of files (delimited with : if more than one) with custom mesg stream thresholds.
TBits *	fUnphysEventMask
	Unphysical event mask.
int	fEventRecordPrintLevel
	GHEP event r ecord print level.
int	fMCJobStatusRefreshRate
	MC job status file refresh rate.
bool	fEnableBareXSecPreCalc
string	fXMLPath
	An path to look for XML in. Higher priority than GXMLPATH.

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 \at cern.ch> University of Liverpool

Created:\n January 29, 2013

License:\n Copyright (c) 2003-2025, 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

RunOpt() [1/2]

genie::RunOpt::RunOpt ( )

private

Definition at line 40 of file RunOpt.cxx.

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

References fInstance, fTune, and Init().

Referenced by Instance(), operator<<, and RunOpt().

RunOpt() [2/2]

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

private

References RunOpt().

~RunOpt()

genie::RunOpt::~RunOpt ( )

privatevirtual

Definition at line 47 of file RunOpt.cxx.

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

References fInstance, fTune, and fUnphysEventMask.

Member Function Documentation

BareXSecPreCalc()

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

inline

Definition at line 53 of file RunOpt.h.

{ return fEnableBareXSecPreCalc;  }

References fEnableBareXSecPreCalc.

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

BuildTune()

void genie::RunOpt::BuildTune

(

)

build tune and inform XSecSplineList

Definition at line 92 of file RunOpt.cxx.

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

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

Referenced by Initialize(), and main().

CacheFile()

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

inline

Definition at line 48 of file RunOpt.h.

{ return fCacheFile;              }

References fCacheFile.

EnableBareXSecPreCalc()

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

inline

Definition at line 62 of file RunOpt.h.

{ fEnableBareXSecPreCalc = flag; }

References fEnableBareXSecPreCalc.

Referenced by GetCommandLineArgs().

EventGeneratorList()

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

inline

Definition at line 47 of file RunOpt.h.

{ return fEventGeneratorList;     }

References fEventGeneratorList.

Referenced by main().

EventRecordPrintLevel()

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

inline

Definition at line 51 of file RunOpt.h.

{ return fEventRecordPrintLevel;  }

References fEventRecordPrintLevel.

Referenced by main().

Init()

void genie::RunOpt::Init ( void )

private

Definition at line 64 of file RunOpt.cxx.

{
  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 = "";
}

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

Referenced by RunOpt().

Instance()

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

static

Definition at line 54 of file RunOpt.cxx.

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

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

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

MCJobStatusRefreshRate()

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

inline

Definition at line 52 of file RunOpt.h.

{ return fMCJobStatusRefreshRate; }

References fMCJobStatusRefreshRate.

MesgThresholdFiles()

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

inline

Definition at line 49 of file RunOpt.h.

{ return fMesgThresholds;         }

References fMesgThresholds.

Print()

void genie::RunOpt::Print

(

ostream &

stream

)

const

Definition at line 185 of file RunOpt.cxx.

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

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

Referenced by operator<<.

ReadFromCommandLine()

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

Definition at line 99 of file RunOpt.cxx.

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

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().

RunOptSyntaxString()

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

static

Definition at line 157 of file RunOpt.cxx.

{
  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();
}

References genie::gDefaultTune.

Referenced by PrintSyntax().

SetEventGeneratorList()

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

inline

Definition at line 61 of file RunOpt.h.

{ fEventGeneratorList = evgenlist; }

References fEventGeneratorList.

Referenced by ReadFromCommandLine().

SetTuneName()

void genie::RunOpt::SetTuneName

(

string

tuneName = "Default"

)

Definition at line 81 of file RunOpt.cxx.

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

References fTune, genie::gDefaultTune, LOG, and pNOTICE.

Referenced by ReadFromCommandLine().

Tune()

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

inline

Definition at line 46 of file RunOpt.h.

{ return fTune;                   }

References fTune.

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

UnphysEventMask()

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

inline

Definition at line 50 of file RunOpt.h.

{ return fUnphysEventMask;        }

References fUnphysEventMask.

XMLPath()

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

inline

Definition at line 54 of file RunOpt.h.

{ return fXMLPath;  }

References fXMLPath.

Friends And Related Symbol Documentation

Cleaner

friend struct Cleaner

friend

Definition at line 102 of file RunOpt.h.

operator<<

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

friend

Definition at line 32 of file RunOpt.cxx.

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

References Print(), and RunOpt().

Member Data Documentation

fCacheFile

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().

fEnableBareXSecPreCalc

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().

fEventGeneratorList

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().

fEventRecordPrintLevel

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().

fInstance

RunOpt * genie::RunOpt::fInstance = 0

staticprivate

Definition at line 85 of file RunOpt.h.

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

fMCJobStatusRefreshRate

int genie::RunOpt::fMCJobStatusRefreshRate

private

MC job status file refresh rate.

Definition at line 79 of file RunOpt.h.

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

fMesgThresholds

string genie::RunOpt::fMesgThresholds

private

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

Definition at line 76 of file RunOpt.h.

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

fTune

TuneId* genie::RunOpt::fTune

private

GENIE comprehensive neutrino interaction model tune.

Definition at line 73 of file RunOpt.h.

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

fUnphysEventMask

TBits* genie::RunOpt::fUnphysEventMask

private

Unphysical event mask.

Definition at line 77 of file RunOpt.h.

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

fXMLPath

string genie::RunOpt::fXMLPath

private

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

Definition at line 82 of file RunOpt.h.

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

---

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

• RunOpt.h
• RunOpt.cxx