Inheritance diagram for evgen::NeutronOsc:

Public Types
using	ModuleType = EDProducer

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Member Functions
	NeutronOsc (fhicl::ParameterSet const &p)

	NeutronOsc (NeutronOsc const &)=delete

	NeutronOsc (NeutronOsc &&)=delete

NeutronOsc &	operator= (NeutronOsc const &)=delete

NeutronOsc &	operator= (NeutronOsc &&)=delete

void	produce (art::Event &e) override

void	beginRun (art::Run &run) override

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
int	SelectAnnihilationMode (int pdg_code)

Private Attributes
const genie::EventRecordVisitorI *	mcgen

genie::NNBarOscMode_t	gOptDecayMode = genie::kNONull

CLHEP::RandFlat	flatDist

Detailed Description

Definition at line 72 of file NeutronOsc_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

evgen::NeutronOsc::NeutronOsc ( fhicl::ParameterSet const & p )

explicit

Definition at line 100 of file NeutronOsc_module.cc.

References art::detail::EngineCreator::createEngine(), flatDist, gOptDecayMode, mcgen, seed, and evgb::SetEventGeneratorListAndTune().

   : art::EDProducer{p}
   // create a default random engine; obtain the random seed from NuRandomService,
   // unless overridden in configuration with key "Seed"
   , flatDist{art::ServiceHandle<rndm::NuRandomService>{}
              -> registerAndSeedEngine(createEngine(0), p, "Seed")}
 {
   string sname = "genie::EventGenerator";
   // GENIE v2 // string sconfig = "NeutronOsc";
   string sconfig = "NNBarOsc";
   // GENIE v3 needs a tune (even if irrelevant)
   evgb::SetEventGeneratorListAndTune("Default", "Default");
 
   genie::PDGLibrary::Instance(); //Ensure Messenger is started first in GENIE.
 
   genie::AlgFactory* algf = genie::AlgFactory::Instance();
   mcgen = dynamic_cast<const genie::EventRecordVisitorI*>(algf->GetAlgorithm(sname, sconfig));
   if (!mcgen) {
     throw cet::exception("NeutronOsc")
       << "Couldn't instantiate the neutron-antineutron oscillation generator";
   }
   int fDecayMode = p.get<int>("DecayMode");
   gOptDecayMode = (genie::NNBarOscMode_t)fDecayMode;
 
   produces<std::vector<simb::MCTruth>>();
   produces<sumdata::RunData, art::InRun>();
 
   unsigned int seed = art::ServiceHandle<rndm::NuRandomService>()->getSeed();
   genie::utils::app_init::RandGen(seed);
 }

evgen::NeutronOsc::NeutronOsc ( NeutronOsc const & )

delete

evgen::NeutronOsc::NeutronOsc ( NeutronOsc && )

delete

Member Function Documentation

void evgen::NeutronOsc::beginRun ( art::Run & run )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 209 of file NeutronOsc_module.cc.

References geo::GeometryCore::DetectorName(), art::fullRun(), and art::Run::put().

 {
   art::ServiceHandle<geo::Geometry const> geo;
   run.put(std::make_unique<sumdata::RunData>(geo->DetectorName()), art::fullRun());
 }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Producer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Producer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

NeutronOsc& evgen::NeutronOsc::operator= ( NeutronOsc const & )

delete

NeutronOsc& evgen::NeutronOsc::operator= ( NeutronOsc && )

delete

void evgen::NeutronOsc::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 131 of file NeutronOsc_module.cc.

References simb::MCTruth::Add(), flatDist, lcvn::interaction, geo::GeometryCore::Iterate(), simb::kUnknown, mcgen, MF_LOG_DEBUG, part, art::Event::put(), SelectAnnihilationMode(), simb::MCTruth::SetOrigin(), and target.

 {
   // Implementation of required member function here.
   genie::EventRecord* event = new genie::EventRecord;
   int target = 1000180400; //Only use argon target
   int decay = SelectAnnihilationMode(target);
   genie::Interaction* interaction = genie::Interaction::NOsc(target, decay);
   event->AttachSummary(interaction);
 
   // Simulate decay
   mcgen->ProcessEventRecord(event);
 
   //  genie::Interaction *inter = event->Summary();
   //  const genie::InitialState &initState = inter->InitState();
   //  std::cout<<"initState = "<<initState.AsString()<<std::endl;
   //  const genie::ProcessInfo &procInfo = inter->ProcInfo();
   //  std::cout<<"procInfo = "<<procInfo.AsString()<<std::endl;
   MF_LOG_DEBUG("NeutronOsc") << "Generated event: " << *event;
 
   std::unique_ptr<std::vector<simb::MCTruth>> truthcol(new std::vector<simb::MCTruth>);
   simb::MCTruth truth;
 
   art::ServiceHandle<geo::Geometry const> geo;
 
   // Find boundary of active volume
   double minx = 1e9;
   double maxx = -1e9;
   double miny = 1e9;
   double maxy = -1e9;
   double minz = 1e9;
   double maxz = -1e9;
   for (auto const& tpc : geo->Iterate<geo::TPCGeo>(geo::CryostatID{0})) {
     if (minx > tpc.MinX()) minx = tpc.MinX();
     if (maxx < tpc.MaxX()) maxx = tpc.MaxX();
     if (miny > tpc.MinY()) miny = tpc.MinY();
     if (maxy < tpc.MaxY()) maxy = tpc.MaxY();
     if (minz > tpc.MinZ()) minz = tpc.MinZ();
     if (maxz < tpc.MaxZ()) maxz = tpc.MaxZ();
   }
 
   // Assign vertice position
   double X0 = flatDist.fire(minx, maxx);
   double Y0 = flatDist.fire(miny, maxy);
   double Z0 = flatDist.fire(minz, maxz);
 
   TIter partitr(event);
   genie::GHepParticle* part = 0;
   // GHepParticles return units of GeV/c for p.  the V_i are all in fermis
   // and are relative to the center of the struck nucleus.
   // add the vertex X/Y/Z to the V_i for status codes 0 and 1
   int trackid = 0;
   std::string primary("primary");
 
   while ((part = dynamic_cast<genie::GHepParticle*>(partitr.Next()))) {
 
     simb::MCParticle tpart(
       trackid, part->Pdg(), primary, part->FirstMother(), part->Mass(), part->Status());
 
     TLorentzVector pos(X0, Y0, Z0, 0);
     TLorentzVector mom(part->Px(), part->Py(), part->Pz(), part->E());
     tpart.AddTrajectoryPoint(pos, mom);
     if (part->PolzIsSet()) {
       TVector3 polz;
       part->GetPolarization(polz);
       tpart.SetPolarization(polz);
     }
     truth.Add(tpart);
 
     ++trackid;
   } // end loop to convert GHepParticles to MCParticles
   truth.SetOrigin(simb::kUnknown);
   truthcol->push_back(truth);
   //FillHistograms(truth);
   e.put(std::move(truthcol));
 
   delete event;
 }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

int evgen::NeutronOsc::SelectAnnihilationMode ( int pdg_code )

private

Definition at line 215 of file NeutronOsc_module.cc.

References DEFINE_ART_MODULE, flatDist, gOptDecayMode, and util::to_string().

Referenced by produce().

 {
   // if the mode is set to 'random' (the default), pick one at random!
   if ((int)gOptDecayMode == 0) {
     int mode;
 
     std::string pdg_string = std::to_string(static_cast<long long>(pdg_code));
     if (pdg_string.size() != 10) {
       std::cout << "Expecting PDG code to be a 10-digit integer; instead, it's the following: "
                 << pdg_string << std::endl;
       exit(1);
     }
 
     // count number of protons & neutrons
     int n_nucleons = std::stoi(pdg_string.substr(6, 3)) - 1;
     int n_protons = std::stoi(pdg_string.substr(3, 3));
 
     // factor proton / neutron ratio into branching ratios
     double proton_frac = ((double)n_protons) / ((double)n_nucleons);
     double neutron_frac = 1 - proton_frac;
 
     // set branching ratios, taken from bubble chamber data
     const int n_modes = 16;
     double br[n_modes] = {0.010,
                           0.080,
                           0.100,
                           0.220,
                           0.360,
                           0.160,
                           0.070,
                           0.020,
                           0.015,
                           0.065,
                           0.110,
                           0.280,
                           0.070,
                           0.240,
                           0.100,
                           0.100};
 
     for (int i = 0; i < n_modes; i++) {
       if (i < 7)
         br[i] *= proton_frac;
       else
         br[i] *= neutron_frac;
     }
 
     // randomly generate a number between 1 and 0
     double p = flatDist.fire();
 
     // loop through all modes, figure out which one our random number corresponds to
     double threshold = 0;
     for (int i = 0; i < n_modes; i++) {
       threshold += br[i];
       if (p < threshold) {
         // once we've found our mode, return it!
         mode = i + 1;
         return mode;
       }
     }
 
     // error message, in case the random number selection fails
     std::cout << "Random selection of final state failed!" << std::endl;
     exit(1);
   }
 
   // if specific annihilation mode specified, just use that
   else {
     int mode = (int)gOptDecayMode;
     return mode;
   }
 }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

CLHEP::RandFlat evgen::NeutronOsc::flatDist

private

Definition at line 97 of file NeutronOsc_module.cc.

Referenced by NeutronOsc(), produce(), and SelectAnnihilationMode().

genie::NNBarOscMode_t evgen::NeutronOsc::gOptDecayMode = genie::kNONull

private

Definition at line 96 of file NeutronOsc_module.cc.

Referenced by NeutronOsc(), and SelectAnnihilationMode().

const genie::EventRecordVisitorI* evgen::NeutronOsc::mcgen

private

Definition at line 95 of file NeutronOsc_module.cc.

Referenced by NeutronOsc(), and produce().

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

larsim/v09_43_00/source/larsim/EventGenerator/GENIE/NeutronOsc_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation