Mass.hpp

Go to the documentation of this file.

// Copyright © 2020-2024 Alexandre Coderre-Chabot
//
// This file is part of Physical Quantities (PhQ), a C++ library of physical quantities, physical
// models, and units of measure for scientific computing.
//
// Physical Quantities is hosted at:
//     https://github.com/acodcha/phq
//
// Physical Quantities is licensed under the MIT License:
//     https://mit-license.org
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
// associated documentation files (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge, publish, distribute,
// sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//   - The above copyright notice and this permission notice shall be included in all copies or
//     substantial portions of the Software.
//   - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
//     BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
//     DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM
//     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
#ifndef PHQ_UNIT_MASS_HPP
#define PHQ_UNIT_MASS_HPP
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <map>
#include <ostream>
#include <string_view>
#include <unordered_map>
 
#include "../Base.hpp"
#include "../Dimension/ElectricCurrent.hpp"
#include "../Dimension/Length.hpp"
#include "../Dimension/LuminousIntensity.hpp"
#include "../Dimension/Mass.hpp"
#include "../Dimension/SubstanceAmount.hpp"
#include "../Dimension/Temperature.hpp"
#include "../Dimension/Time.hpp"
#include "../Dimensions.hpp"
#include "../Unit.hpp"
#include "../UnitSystem.hpp"
 
namespace PhQ {
 
namespace Unit {
 
/// \brief Mass units.
enum class Mass : int8_t {
  /// \brief Kilogram (kg) mass unit.
  Kilogram,
 
  /// \brief Gram (g) mass unit.
  Gram,
 
  /// \brief Slug (slug) mass unit.
  Slug,
 
  /// \brief Slinch (slinch) mass unit.
  Slinch,
 
  /// \brief Pound (lbm) mass unit.
  Pound,
};
 
}  // namespace Unit
 
/// \brief Standard mass unit: kilogram (kg).
template <>
inline constexpr const Unit::Mass Standard<Unit::Mass>{Unit::Mass::Kilogram};
 
/// \brief Physical dimension set of mass units.
template <>
inline constexpr const Dimensions RelatedDimensions<Unit::Mass>{
  Dimensions{Dimension::Time{0}, Dimension::Length{0}, Dimension::Mass{1},
             Dimension::ElectricCurrent{0}, Dimension::Temperature{0},
             Dimension::SubstanceAmount{0}, Dimension::LuminousIntensity{0}}
};
 
inline std::ostream& operator<<(std::ostream& stream, const Unit::Mass unit) {
  stream << Abbreviation(unit);
  return stream;
}
 
namespace Internal {
 
template <>
inline const std::map<UnitSystem, Unit::Mass> ConsistentUnits<Unit::Mass>{
  {UnitSystem::MetreKilogramSecondKelvin,  Unit::Mass::Kilogram},
  {UnitSystem::MillimetreGramSecondKelvin, Unit::Mass::Gram    },
  {UnitSystem::FootPoundSecondRankine,     Unit::Mass::Slug    },
  {UnitSystem::InchPoundSecondRankine,     Unit::Mass::Slinch  },
};
 
template <>
inline const std::map<Unit::Mass, UnitSystem> RelatedUnitSystems<Unit::Mass>{
  {Unit::Mass::Kilogram, UnitSystem::MetreKilogramSecondKelvin },
  {Unit::Mass::Gram,     UnitSystem::MillimetreGramSecondKelvin},
  {Unit::Mass::Slug,     UnitSystem::FootPoundSecondRankine    },
  {Unit::Mass::Slinch,   UnitSystem::InchPoundSecondRankine    },
};
 
template <>
inline const std::map<Unit::Mass, std::string_view> Abbreviations<Unit::Mass>{
  {Unit::Mass::Kilogram, "kg"    },
  {Unit::Mass::Gram,     "g"     },
  {Unit::Mass::Slug,     "slug"  },
  {Unit::Mass::Slinch,   "slinch"},
  {Unit::Mass::Pound,    "lbm"   },
};
 
template <>
inline const std::unordered_map<std::string_view, Unit::Mass> Spellings<Unit::Mass>{
  {"kg",     Unit::Mass::Kilogram},
  {"g",      Unit::Mass::Gram    },
  {"slug",   Unit::Mass::Slug    },
  {"slinch", Unit::Mass::Slinch  },
  {"lbm",    Unit::Mass::Pound   },
  {"lb",     Unit::Mass::Pound   },
};
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Kilogram>::FromStandard(
    NumericType& /*value*/) noexcept {}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Kilogram>::ToStandard(
    NumericType& /*value*/) noexcept {}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Gram>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(1000.0L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Gram>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.001L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Slug>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.3048L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Slug>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / static_cast<NumericType>(0.3048L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Slinch>::FromStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.0254L)
           / (static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L));
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Slinch>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L) * static_cast<NumericType>(9.80665L)
           / static_cast<NumericType>(0.0254L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Pound>::FromStandard(
    NumericType& value) noexcept {
  value /= static_cast<NumericType>(0.45359237L);
}
 
template <>
template <typename NumericType>
inline constexpr void Conversion<Unit::Mass, Unit::Mass::Pound>::ToStandard(
    NumericType& value) noexcept {
  value *= static_cast<NumericType>(0.45359237L);
}
 
template <typename NumericType>
inline const std::map<Unit::Mass, std::function<void(NumericType* values, const std::size_t size)>>
    MapOfConversionsFromStandard<Unit::Mass, NumericType>{
      {Unit::Mass::Kilogram,
       Conversions<Unit::Mass,                       Unit::Mass::Kilogram>::FromStandard<NumericType>},
      {Unit::Mass::Gram,     Conversions<Unit::Mass, Unit::Mass::Gram>::FromStandard<NumericType>    },
      {Unit::Mass::Slug,     Conversions<Unit::Mass, Unit::Mass::Slug>::FromStandard<NumericType>    },
      {Unit::Mass::Slinch,   Conversions<Unit::Mass, Unit::Mass::Slinch>::FromStandard<NumericType>  },
      {Unit::Mass::Pound,    Conversions<Unit::Mass, Unit::Mass::Pound>::FromStandard<NumericType>   },
};
 
template <typename NumericType>
inline const std::
    map<Unit::Mass, std::function<void(NumericType* const values, const std::size_t size)>>
        MapOfConversionsToStandard<Unit::Mass, NumericType>{
          {Unit::Mass::Kilogram,
           Conversions<Unit::Mass,                       Unit::Mass::Kilogram>::ToStandard<NumericType>},
          {Unit::Mass::Gram,     Conversions<Unit::Mass, Unit::Mass::Gram>::ToStandard<NumericType>    },
          {Unit::Mass::Slug,     Conversions<Unit::Mass, Unit::Mass::Slug>::ToStandard<NumericType>    },
          {Unit::Mass::Slinch,
           Conversions<Unit::Mass,                       Unit::Mass::Slinch>::ToStandard<NumericType>  },
          {Unit::Mass::Pound,    Conversions<Unit::Mass, Unit::Mass::Pound>::ToStandard<NumericType>   },
};
 
}  // namespace Internal
 
}  // namespace PhQ
 
#endif  // PHQ_UNIT_MASS_HPP