refractive_index.h

Go to the documentation of this file.

//
// Copyright (c) 2016 by François Mauger <mauger@lpccaen.in2p3.fr>

#ifndef MATERIALS_REFRACTIVE_INDEX_H
#define MATERIALS_REFRACTIVE_INDEX_H

// Standard library:
#include <string>
#include <map>
#include <memory>
#include <limits>

// Bayeux:
#include <datatools/properties.h>
#include <datatools/real_range.h>
#include <mygsl/i_unary_function.h>
#include <mygsl/tabulated_function.h>

namespace materials {

  class refractive_index
    : public mygsl::i_unary_function
  {
  public:

    enum dispersion_formula_type {
      FORMULA_INVALID                   =  0, 
      FORMULA_CONSTANT                  =  1, 
      FORMULA_DISPERSION_TABULATED      =  2, 
      FORMULA_DISPERSION_RII_SELLMEIER  = 11, 
      FORMULA_DISPERSION_RII_SELLMEIER2 = 12, 
      FORMULA_DISPERSION_RII_POLYNOMIAL = 13,
      FORMULA_DISPERSION_RII_RII4       = 14,
      FORMULA_DISPERSION_RII_CAUCHY     = 15,
      FORMULA_DISPERSION_RII_GASES      = 16,
      FORMULA_DISPERSION_RII_HERZBERGER = 17,
      // FORMULA_DISPERSION_RII_RETRO      = 18,
      // FORMULA_DISPERSION_RII_EXOTIC     = 19
    };

    enum eval_mode_type {
      EVAL_N = 0,
      EVAL_K = 1
    };

    typedef std::map<std::size_t, double> coeff_dict_type;

    refractive_index();

    virtual ~refractive_index();

    bool is_eval_n() const;

    bool is_eval_k() const;

    void set_eval_n();

    void set_eval_k();

    bool has_lambda_range() const;

    void set_lambda_range(const double lambda_min_, const double lambda_max_);

    void set_lambda_range(const datatools::real_range & lr_);

    const datatools::real_range & get_lambda_range() const;

    void make_constant(const double n_,
                       const double k_ = std::numeric_limits<double>::quiet_NaN());

    void make_tabulated(const std::string & n_tab_, const std::string & k_tab_ = "");

    void make_dispersion_rii(const dispersion_formula_type formula_,
                             const coeff_dict_type & coeffs_,
                             const std::string & k_tab_ = "");

    bool has_rii_coeff(const std::size_t) const;

    double get_rii_coeff(const std::size_t) const;

    double eval_refractive_index(const double lambda_) const;

    double eval_extinction_coefficient(const double lambda_) const;

    double eval_attenuation_coefficient(const double lambda_) const;

    double eval_penetration_depth(const double lambda_) const;

    double compute_principal_dispersion() const;

    double compute_abbe_number() const;

    double compute_abbe_number_e() const;

    virtual bool has_explicit_domain_of_definition() const;

    virtual bool is_in_domain_of_definition(const double x_) const;

    bool is_initialized() const;

    void initialize(const datatools::properties & config_,
                    const mygsl::unary_function_dict_type & /* functors_ */);

    void reset();

  protected:

    virtual double _eval(double) const;

    double _eval_n(double) const;

    double _eval_k(double) const;

    void _build_n_tabfunc();

    void _build_k_tabfunc();

  private:

    dispersion_formula_type _formula_ = FORMULA_INVALID; 
    eval_mode_type _eval_mode_ = EVAL_N; 

    // Constant and simple formula:
    double _n0_; 
    double _k0_; 

    // Tabulated:
    std::string _n_table_; 
    std::string _k_table_; 

    // Coefficients and validity range for RII formula (https://en.wikipedia.org/wiki/Sellmeier_equation):
    datatools::real_range _lambda_range_; 
    coeff_dict_type _rii_c_;

    // Work data:
    std::shared_ptr<mygsl::tabulated_function> _n_tabfunc_; 
    std::shared_ptr<mygsl::tabulated_function> _k_tabfunc_; 

  };

} // namespace materials

#endif // MATERIALS_REFRACTIVE_INDEX_H

// Local Variables: --
// Mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --