MARLEY (Model of Argon Reaction Low Energy Yields)  v1.0.0
A Monte Carlo event generator for tens-of-MeV neutrino-nucleus interactions in liquid argon
 All Classes Functions Variables Enumerations Pages
Public Member Functions | List of all members
marley::FunctionNeutrinoSource Class Reference

Neutrino source with an arbitrary energy spectrum described by a std::function<double(double)> object. More...

#include <NeutrinoSource.hh>

Inheritance diagram for marley::FunctionNeutrinoSource:
marley::NeutrinoSource

Public Member Functions

 FunctionNeutrinoSource (int particle_id=marley_utils::ELECTRON_NEUTRINO, double Emin=0., double Emax=50., std::function< double(double)> prob_dens_func=[](double) -> double{return 1.;})
 
virtual double get_Emax () const override
 Get the maximum neutrino energy (MeV) that can be sampled by this source.
 
virtual double get_Emin () const override
 Get the minimum neutrino energy (MeV) that can be sampled by this source.
 
virtual double pdf (double E) override
 Probability density function describing the incident neutrino energy distribution. More...
 
- Public Member Functions inherited from marley::NeutrinoSource
 NeutrinoSource (int particle_id)
 
virtual int get_pid () const
 Get the PDG particle ID for the neutrino type produced by this source.
 
virtual double sample_incident_neutrino (int &pdg, marley::Generator &gen)
 Samples an incident neutrino energy and loads pdg with the PDG code of the appropriate neutrino type. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from marley::NeutrinoSource
static bool pdg_is_allowed (const int pdg)
 
- Protected Attributes inherited from marley::NeutrinoSource
int pid_
 PDG particle ID for the neutrinos produced by this source.
 

Detailed Description

Neutrino source with an arbitrary energy spectrum described by a std::function<double(double)> object.

Constructor & Destructor Documentation

marley::FunctionNeutrinoSource::FunctionNeutrinoSource ( int  particle_id = marley_utils::ELECTRON_NEUTRINO,
double  Emin = 0.,
double  Emax = 50.,
std::function< double(double)>  prob_dens_func = [](double) -> double { return 1.; } 
)
Parameters
particle_idPDG particle ID for the neutrinos produced by this source
Eminminimum allowed neutrino energy (MeV)
Emaxmaximum allowed neutrino energy (MeV)
prob_dens_funca std::function<double(double)> object to be used as a probability density function
Todo:
Remove hard-coded number of integration subintervals in this function

Member Function Documentation

double marley::FunctionNeutrinoSource::pdf ( double  E)
inlineoverridevirtual

Probability density function describing the incident neutrino energy distribution.

The neutrino spectrum produced by this source will be folded with the relevant cross sections by a Generator object during event creation

Parameters
Eneutrino energy (MeV)
Returns
Probability density (MeV -1)

Implements marley::NeutrinoSource.


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