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

A nuclear matrix element that represents a transition caused by a neutrino-nucleus reaction. More...

#include <MatrixElement.hh>

Public Types

enum  TransitionType { FERMI = 0, GAMOW_TELLER = 1 }
 Enumerated type that represents the possible kinds of nuclear transitions recognized by MARLEY.
 

Public Member Functions

 MatrixElement (double level_energy, double strength, TransitionType type, marley::Level *final_level=nullptr)
 
const marley::Levellevel () const
 Get a pointer to the final-state nuclear Level accessed by the matrix element, or nullptr if it is a transition to the unbound continuum.
 
marley::Levellevel ()
 Get a pointer to the final-state nuclear Level accessed by the matrix element, or nullptr if it is a transition to the unbound continuum.
 
double level_energy () const
 Get the excitation energy (MeV) of the final-state nuclear level accessed by the matrix element.
 
void set_level (marley::Level *lev)
 Set the pointer to the final nuclear Level object accessed by the matrix element.
 
void set_level_energy (double energy)
 Set the excitation energy (MeV) of the final-state nuclear level accessed by the matrix element.
 
void set_strength (double strength)
 Set the numerical value (dimensionless) of the matrix element.
 
void set_type (TransitionType type)
 Set the kind of nuclear transition (e.g., Fermi, Gamow-Teller) represented by the matrix element.
 
double strength () const
 Get the numerical value (dimensionless) of the matrix element.
 
TransitionType type () const
 Get the kind of nuclear transition (e.g., Fermi, Gamow-Teller) represented by the matrix element.
 

Protected Attributes

marley::Levelfinal_level_
 Pointer to the final Level object for a transition to a discrete nuclear level, or nullptr for an unbound state.
 
double level_energy_
 Energy (MeV) of the final-state nuclear level accessed by this matrix element.
 
double strength_
 Numerical value of the matrix element (dimensionless)
 
TransitionType type_
 The kind of transition represented by this matrix element (Fermi, Gamow-Teller, etc.)
 

Detailed Description

A nuclear matrix element that represents a transition caused by a neutrino-nucleus reaction.

Constructor & Destructor Documentation

marley::MatrixElement::MatrixElement ( double  level_energy,
double  strength,
TransitionType  type,
marley::Level final_level = nullptr 
)
inline
Parameters
level_energyExcitation energy (MeV) of the final-state nuclear level accessed by the matrix element
strengthNumerical value (dimensionless) of the matrix element
typeType of nuclear transition (e.g., Fermi, Gamow-Teller) represented by the matrix element
final_levelPointer to the Level object that represents the final nuclear level

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