beta_decay.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-11-06
 * Last modified: 2014-11-06
 *
 * License:
 * Copyright 2014 F. Mauger
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   Beta decay driver.
 *
 * History:
 *
 */

#ifndef GENBB_HELP_BETA_DECAY_H
#define GENBB_HELP_BETA_DECAY_H 1

// Standard library:
#include <string>
#include <fstream>
#include <vector>

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/i_tree_dump.h>
// - Bayeux/mygsl:
#include <mygsl/rng.h>
// - Bayeux/genbb_help:
#include <genbb_help/primary_event.h>
#include <genbb_help/primary_particle.h>
#include <genbb_help/base_decay_driver.h>
#include <genbb_help/genbb_macros.h>

namespace genbb {

  // Forward declaration:
  class fermi_function;

  class beta_decay  : public base_decay_driver
  {

  public:

    enum decay_type {
      BETA_DECAY_INVALID = 0, 
      BETA_DECAY_MINUS   = 1, 
      BETA_DECAY_PLUS    = 2  
    };

    static std::string label_from_decay_type(decay_type);

    static decay_type decay_type_from_label(const std::string &);

    enum coupling_type {
      COUPLING_INVALID      = 0, 
      COUPLING_AXIAL_VECTOR = 1, 
      COUPLING_TENSOR       = 2, 
      COUPLING_SCALAR       = 3, 
      COUPLING_VECTOR       = 4, 
      COUPLING_USER         = 5, 
      COUPLING_UNKNOWN      = 6  
    };

    enum electron_shakeoff_mode_type {
      ESO_NO_SHAKEOFF   = 0, 
      ESO_FIXED_CHARGE  = 1, 
      ESO_RANDOM_CHARGE = 2  
    };

    static const int ESO_INVALID_FIXED_CHARGE = 0xFFFFFFFF;

    struct electron_shakeoff_entry {
      int    charge;            
      double probability;       
      double cumul_probability; 
    };

    typedef std::vector<electron_shakeoff_entry> electron_shakeoff_data_type;

    static std::string label_from_coupling(coupling_type);

    static coupling_type coupling_from_label(const std::string &);

    // Return the a value associated to a coupling
    static double a_value(coupling_type);

    beta_decay();

    virtual ~beta_decay();

    void set_type(decay_type);

    decay_type get_type() const;

    bool is_beta_minus() const;

    bool is_beta_plus() const;

    bool has_q_beta() const;

    void set_q_beta(double);

    double get_q_beta() const;

    void set_A(int);

    int get_A() const;

    void set_Z_parent(int);

    int get_Z_parent() const;

    void set_Z_daughter(int);

    int get_Z_daughter() const;

    void set_mass_parent(double);

    double get_mass_parent() const;

    void set_mass_daughter(double);

    double get_mass_daughter() const;

    void set_energy_parent(double);

    double get_energy_parent() const;

    void set_energy_daughter(double);

    double get_energy_daughter() const;

    void set_coupling(coupling_type coupling_);

    coupling_type get_coupling() const;

    bool coupling_is_known() const;

    void set_a(double);

    double get_a() const;

    void set_ke_cut(double);

    double get_ke_cut() const;

    bool is_electron_shakeoff() const;

    void set_electron_shakeoff(electron_shakeoff_mode_type eso_mode_);

    bool has_electron_shakeoff_fixed_charge() const;

    int get_electron_shakeoff_fixed_charge() const;

    void set_electron_shakeoff_fixed_charge(int charge_);

    void add_electron_shakeoff_random(int charge_, double probability_);

    const electron_shakeoff_data_type & get_electron_shakeoff_data_random() const;

    void set_log_filename(const std::string &);

    const std::string & get_log_filename() const;

    bool is_beta_generated() const;

    void set_beta_generated(bool);

    bool is_neutrino_generated() const;

    void set_neutrino_generated(bool);

    bool is_daughter_generated() const;

    void set_daughter_generated(bool);

    double get_pr_max() const;

    double get_probability_max() const;

    double pdf_ke_pr(double ke_ , double pr_) const;

    static void compute_ke_limits(//double mass_parent_,
                                  double q_beta_,
                                  double pr_,
                                  double & ke_min_,
                                  double & ke_max_);

    virtual void tree_dump(std::ostream & out_ = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_ = false) const;

    void display_pdf(const std::string & title_ = "") const;

    int fire_event_kinematics(mygsl::rng & prng_,
                              double & ke_,
                              double & pr_,
                              double & pnu_,
                              double & cer_,
                              double & cenu_) const;

    virtual void set_levels(const nuclear_level & level_start_,
                            const nuclear_level & level_stop_);

    virtual void initialize(const datatools::properties & config_);

    virtual void reset();

    virtual int fill(mygsl::rng & prng_, genbb::primary_event & event_);

  protected:

    void _compute_pr_max();

    void _compute_limits();

    void _init();

    void _init_electron_shakeoff();

    void _set_default();

  private:

    decay_type _type_;        
    double _q_beta_;          
    double _ke_cut_;          
    int _A_;                  
    int _Z_parent_;           
    int _Z_daughter_;         
    double _mass_parent_;     
    double _energy_parent_;   
    double _mass_daughter_;   
    double _energy_daughter_; 
    coupling_type _coupling_; 
    double _a_;               
    electron_shakeoff_mode_type _electron_shakeoff_mode_; 
    int                         _electron_shakeoff_fixed_charge_; 
    electron_shakeoff_data_type _electron_shakeoff_data_random_; 
    std::string _log_filename_; 
    boost::scoped_ptr<std::ofstream> _log_file_; 
    boost::scoped_ptr<fermi_function> _F_; 
    bool _massive_neutrino_;   
    double _neutrino_mass_;    
    bool _beta_generated_;     
    bool _neutrino_generated_; 
    bool _daughter_generated_; 

    // Working data:
    double _M_;               
    double _m1_;              
    double _m2_;              
    double _m3_;              
    double _pr_max_;          
    double _kr_max_;          
    double _probability_max_; 

    GENBB_BDD_REGISTRATION_INTERFACE(beta_decay)

  };

} // end of namespace genbb

/***************
 * OCD support *
 ***************/
#include <datatools/ocd_macros.h>
DOCD_CLASS_DECLARATION(genbb::beta_decay)

#endif // GENBB_HELP_BETA_DECAY_H

// Local Variables: --
// mode: c++ --
// End: --