GGEMSMaterialsDatabaseManager.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_MATERIALS_GGEMSMATERIALSDATABASEMANAGER_HH
#define GUARD_GGEMS_MATERIALS_GGEMSMATERIALSDATABASEMANAGER_HH
 
// ************************************************************************
// * This file is part of GGEMS.                                          *
// *                                                                      *
// * GGEMS 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.                                  *
// *                                                                      *
// * GGEMS 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 GGEMS.  If not, see <https://www.gnu.org/licenses/>.      *
// *                                                                      *
// ************************************************************************
 
#ifdef _MSC_VER
#pragma warning(disable: 4251) // Deleting warning exporting STL members!!!
#endif
 
#include <vector>
#include <unordered_map>
 
#include "GGEMS/global/GGEMSConstants.hh"
 
__constant GGchar SOLID = 0; 
__constant GGchar GAS = 1; 
struct GGEMS_EXPORT GGEMSChemicalElement
{
  GGint index_density_correction_; 
  GGfloat molar_mass_M_; 
  GGfloat mean_excitation_energy_I_; 
  GGchar state_; 
  GGuchar atomic_number_Z_; 
};
 
struct GGEMS_EXPORT GGEMSSingleMaterial
{
  std::vector<std::string> chemical_element_name_; 
  std::vector<GGfloat> mixture_f_; 
  GGfloat density_; 
  GGsize nb_elements_; 
};
 
typedef std::unordered_map<std::string, GGEMSChemicalElement> ChemicalElementUMap; 
typedef std::unordered_map<std::string, GGEMSSingleMaterial> MaterialUMap; 
class GGEMS_EXPORT GGEMSMaterialsDatabaseManager
{
  private:
    GGEMSMaterialsDatabaseManager(void);
 
    ~GGEMSMaterialsDatabaseManager(void);
 
  public:
    static GGEMSMaterialsDatabaseManager& GetInstance(void)
    {
      static GGEMSMaterialsDatabaseManager instance;
      return instance;
    }
 
    GGEMSMaterialsDatabaseManager(GGEMSMaterialsDatabaseManager const& material_manager) = delete;
 
    GGEMSMaterialsDatabaseManager& operator=(GGEMSMaterialsDatabaseManager const& material_manager) = delete;
 
    GGEMSMaterialsDatabaseManager(GGEMSMaterialsDatabaseManager const&& material_manager) = delete;
 
    GGEMSMaterialsDatabaseManager& operator=(GGEMSMaterialsDatabaseManager const&& material_manager) = delete;
 
    void SetMaterialsDatabase(std::string const& filename);
 
    void PrintAvailableChemicalElements(void) const;
 
    void PrintAvailableMaterials(void) const;
 
    inline bool IsReady(void) const
    {
      if (materials_.empty()) return false;
      else return true;
    }
 
    inline GGEMSSingleMaterial GetMaterial(std::string const& material_name) const
    {
      MaterialUMap::const_iterator iter = materials_.find(material_name);
 
      // Checking if the material exists
      if (iter == materials_.end()) {
        std::ostringstream oss(std::ostringstream::out);
        oss << "Material '" << material_name << "' not found in the database!!!" << std::endl;
        GGEMSMisc::ThrowException("GGEMSMaterialsDatabaseManager", "GetMaterial", oss.str());
      }
 
      return iter->second;
    };
 
    inline GGEMSChemicalElement GetChemicalElement(std::string const& chemical_element_name) const
    {
      ChemicalElementUMap::const_iterator iter = chemical_elements_.find(chemical_element_name);
 
      // Checking if the material exists
      if (iter == chemical_elements_.end()) {
        std::ostringstream oss(std::ostringstream::out);
        oss << "Chemical element '" << chemical_element_name << "' not found in the database!!!" << std::endl;
        GGEMSMisc::ThrowException("GGEMSMaterialsDatabaseManager", "GetChemicalElement", oss.str());
      }
 
      return iter->second;
    };
 
    GGfloat GetRadiationLength(std::string const& material) const;
 
    inline GGfloat GetAtomicNumberDensity(std::string const& material, GGsize const& index) const
    {
      // Getting the material
      GGEMSSingleMaterial const& single_material = GetMaterial(material);
 
      // Getting the specific chemical element
      GGEMSChemicalElement const& chemical_element = GetChemicalElement(single_material.chemical_element_name_[index]);
 
      // return the atomic number density, the number could be higher than float!!! Double is used
      GGdouble tmp_value_double = static_cast<GGdouble>(AVOGADRO) / chemical_element.molar_mass_M_ * single_material.density_ * single_material.mixture_f_[index];
      return static_cast<GGfloat>(tmp_value_double);
    }
 
    void Clean(void);
 
  private:
    void LoadMaterialsDatabase(std::string const& filename);
 
    void LoadChemicalElements(void);
 
    void AddChemicalElements(std::string const& element_name, GGuchar const& element_Z, GGfloat const& element_M, GGfloat const& element_I, GGchar const& state, GGint const& index_density_correction);
 
  private:
    MaterialUMap materials_; 
    ChemicalElementUMap chemical_elements_; 
};
 
extern "C" GGEMS_EXPORT GGEMSMaterialsDatabaseManager* get_instance_materials_manager(void);
 
extern "C" GGEMS_EXPORT void set_materials_ggems_materials_manager(GGEMSMaterialsDatabaseManager* ggems_materials_manager, char const* filename);
 
extern "C" GGEMS_EXPORT void print_available_chemical_elements_ggems_materials_manager(GGEMSMaterialsDatabaseManager* ggems_materials_manager);
 
extern "C" GGEMS_EXPORT void print_available_materials_ggems_materials_manager(GGEMSMaterialsDatabaseManager* ggems_materials_manager);
 
#endif // End of GUARD_GGEMS_PHYSICS_GGEMSMATERIALSDATABASEMANAGER_HH