nuclear_transition.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-07-08
 * Last modified: 2014-07-08
 *
 * 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:
 *
 *   Utilities related to gamma transitions.
 *
 * History:
 *
 */

#ifndef GENBB_HELP_NUCLEAR_TRANSITION_H
#define GENBB_HELP_NUCLEAR_TRANSITION_H 1

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

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/i_tree_dump.h>
#include <datatools/bit_mask.h>
// - Bayeux/mygsl:
#include <mygsl/rng.h>

// This project:
#include <genbb_help/base_decay_driver.h>
#include <genbb_help/genbb_macros.h>

namespace genbb {

  // Forward declaration:
  class nuclear_level;

  class nuclear_transition  : public base_decay_driver
  {

  public:

    enum approx_flag_type {
      APPROX_NULL         = 0,                          
      APPROX_GAMMA_ONLY   = datatools::bit_mask::bit00, 
      APPROX_GKLMP_SIMPLE = datatools::bit_mask::bit01, 
      APPROX_DEFAULT      = APPROX_GKLMP_SIMPLE         
    };

    enum mode_type {
      MODE_INVALID = -1, 
      MODE_GAMMA = 0, 
      MODE_IC_K  = 1, 
      MODE_IC_L  = 2, 
      MODE_IC_M  = 3, 
      MODE_PC    = 4  
    };

    nuclear_transition();

    virtual ~nuclear_transition();

    bool has_A() const;

    void set_A(int);

    int get_A() const;

    bool has_Z() const;

    void set_Z(int);

    int get_Z() const;

    bool has_energy() const;

    void set_energy(double);

    double get_energy() const;

    void set_ic_k_shell_binding_energy(double b_);

    void set_ic_l_shell_binding_energy(double b_);

    void set_ic_m_shell_binding_energy(double b_);

    double get_ic_k_shell_binding_energy() const;

    double get_ic_l_shell_binding_energy() const;

    double get_ic_m_shell_binding_energy() const;

    void set_ic_k_shell_coefficient(double b_);

    void set_ic_l_shell_coefficient(double b_);

    void set_ic_m_shell_coefficient(double b_);

    double get_ic_k_shell_coefficient() const;

    double get_ic_l_shell_coefficient() const;

    double get_ic_m_shell_coefficient() const;

    void set_pc_coefficient(double c_);

    double get_pc_coefficient() const;

    bool is_gamma_generated() const;

    void set_gamma_generated(bool);

    bool is_conversion_electron_generated() const;

    void set_conversion_electron_generated(bool);

    bool is_conversion_pair_generated() const;

    void set_conversion_pair_generated(bool);

    void set_levels(const nuclear_level & lstart_, const nuclear_level & lstop_);

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

    int fire_event_kinematics(mygsl::rng & prng_,
                              mode_type & mode_,
                              double & eg_,
                              double & thetag_,
                              double & phig_,
                              double & e1_,
                              double & theta1_,
                              double & phi1_,
                              double & e2_,
                              double & theta2_,
                              double & phi2_) const;

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

    virtual void reset();

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

  protected:

    void _set_default();

    void _init();

  private:

    int    _A_;           
    int    _Z_;           
    double _energy_;      
    unsigned int _approx_flags_; 
    double _ic_k_shell_binding_energy_; 
    double _ic_l_shell_binding_energy_; 
    double _ic_m_shell_binding_energy_; 
    double _ic_k_shell_coefficient_; 
    double _ic_l_shell_coefficient_; 
    double _ic_m_shell_coefficient_; 
    double _pc_coefficient_; 

    bool   _gamma_generated_; 
    bool   _conversion_electron_generated_; 
    bool   _conversion_pair_generated_; 

    // Working data:
    double _cumul_g_;   
    double _cumul_pK_;  
    double _cumul_pL_;  
    double _cumul_pM_;  
    double _cumul_pp_;  


    GENBB_BDD_REGISTRATION_INTERFACE(nuclear_transition)

  };

} // end of namespace genbb

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

#endif // GENBB_HELP_NUCLEAR_TRANSITION_H

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