nuclear_level.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-06-08
 * Last modified: 2014-06-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:
 *
 *   Description of a nuclear level.
 *
 * History:
 *
 */

#ifndef GENBB_HELP_NUCLEAR_LEVEL_H
#define GENBB_HELP_NUCLEAR_LEVEL_H 1

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

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/handle.h>
#include <datatools/i_tree_dump.h>

namespace genbb {

  // Forward declaration
  class nuclear_decay;

  class nuclear_level  : public datatools::i_tree_dumpable
  {
  public:

    typedef datatools::handle<nuclear_level> handle_type;
    typedef datatools::handle<nuclear_decay> decay_handle_type;

    enum parity_type {
      PARITY_INVALID = 0, 
      PARITY_MINUS   = 1, 
      PARITY_PLUS    = 2, 
      PARITY_UNKNOWN = 3  
    };

    class decay_channel {
    public:

      decay_channel();

      virtual ~decay_channel();

      void initialize(const nuclear_decay &, double, double);

      void reset();

      bool is_valid() const;

      void set_decay(const nuclear_decay &);

      void set_branching_ratio(double);

      void set_cumul_prob(double);

      const nuclear_decay & get_decay() const;

      double get_branching_ratio() const;

      double get_cumul_prob() const;

    private:

      const nuclear_decay * _decay_; 
      double _branching_ratio_;      
      double _cumul_prob_;           

    };

    typedef std::vector<decay_channel> decay_channels_col_type;

    static std::string label_from_parity(parity_type);

    static parity_type parity_from_label(const std::string &);

    static std::string label_from_spin(double);

    static double spin_from_label(const std::string &);

    nuclear_level();

    virtual ~nuclear_level();

    bool is_valid() const;

    void set_A(int);

    void set_Z(int);

    void set_spin(double);

    void set_parity(parity_type);

    void set_half_life(double);

    void set_width(double);

    void set_stable();

    void set_energy(double);

    void set_fundamental();

    int get_A() const;

    int get_Z() const;

    const std::string & get_element_symbol() const;

    int get_N() const;

    bool spin_is_known() const;

    bool parity_is_known() const;

    double get_spin() const;

    parity_type get_parity() const;

    double get_half_life() const;

    double get_mean_life_time() const;

    double get_width() const;

    bool is_stable() const;

    double get_energy() const;

    bool is_fundamental() const;

    bool has_decay_table() const;

    void add_decay_channel(const nuclear_decay & decay_, double branching_ratio_);

    size_t get_number_of_decay_channels() const;

    const decay_channel & get_decay_channel(int i_) const;

    const datatools::properties & get_auxiliaries() const;

    datatools::properties & grab_auxiliaries();

    const datatools::properties & get_decay_table_config() const;

    datatools::properties & grab_decay_table_config();

    std::string to_string(unsigned int = 0) const;

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

    bool is_initialized() const;

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

    void initialize_simple();

    void reset();

    void install_decay_table(const datatools::properties & config_,
                             const std::map<std::string, datatools::handle<nuclear_decay> > & decays_);

    void reset_decay_table();

    const decay_channels_col_type & get_decay_channels() const;

  protected:

    void _set_defaults();

    void _compute_decay_weights();

  private:

    bool _initialized_;   
    int _A_;              
    int _Z_;              
    double _spin_;        
    parity_type _parity_; 
    double _half_life_;   
    double _energy_;      
    datatools::properties   _auxiliaries_;        
    datatools::properties   _decay_table_config_; 
    decay_channels_col_type _decay_channels_;     

  };

} // end of namespace genbb

#endif // GENBB_HELP_NUCLEAR_LEVEL_H

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