Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
unit_table.hpp
Go to the documentation of this file.
1// -------------------------------------------------------//
2//
3// SHAMROCK code for hydrodynamics
4// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
5// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
6// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
7//
8// -------------------------------------------------------//
9
10#pragma once
11
21
22#include "shamunits/Unit.hpp"
24#include <string_view>
25#include <array>
26
27namespace shamunits::units {
28
29 // SI base units
30 inline constexpr Unit<> second = base_unit({.second = 1});
31 inline constexpr Unit<> metre = base_unit({.metre = 1});
32 inline constexpr Unit<> kilogram = base_unit({.kilogram = 1});
33 inline constexpr Unit<> ampere = base_unit({.ampere = 1});
34 inline constexpr Unit<> kelvin = base_unit({.kelvin = 1});
35 inline constexpr Unit<> mole = base_unit({.mole = 1});
36 inline constexpr Unit<> candela = base_unit({.candela = 1});
37
38 // SI derived units
39 inline constexpr Unit<> hertz = 1. / second;
40 inline constexpr Unit<> newton = kilogram * metre / upow(second, 2);
41 inline constexpr Unit<> pascal = newton / upow(metre, 2);
42 inline constexpr Unit<> joule = newton * metre;
43 inline constexpr Unit<> watt = joule / second;
44 inline constexpr Unit<> coulomb = second * ampere;
45 inline constexpr Unit<> volt = watt / ampere;
46 inline constexpr Unit<> farad = coulomb / volt;
47 inline constexpr Unit<> ohm = volt / ampere;
48 inline constexpr Unit<> siemens = 1. / ohm;
49 inline constexpr Unit<> weber = volt * second;
50 inline constexpr Unit<> tesla = weber / upow(metre, 2);
51 inline constexpr Unit<> henry = weber / ampere;
52 inline constexpr Unit<> lumen = candela;
53 inline constexpr Unit<> lux = lumen / upow(metre, 2);
54 inline constexpr Unit<> becquerel = 1. / second;
55 inline constexpr Unit<> gray = joule / kilogram;
56 inline constexpr Unit<> sievert = joule / kilogram;
57 inline constexpr Unit<> katal = mole / second;
58
59 // Other units
60 inline constexpr Unit<> minute = 60. * second;
61 inline constexpr Unit<> hour = 3600. * second;
62 inline constexpr Unit<> day = 86400. * second;
63 inline constexpr Unit<> year = 31557600. * second;
64 inline constexpr Unit<> astronomical_unit = 149597870700. * metre;
65 inline constexpr Unit<> light_year = 9460730472580800. * metre;
66 inline constexpr Unit<> parsec = 3.0857e16 * metre;
67 inline constexpr Unit<> solar_radius = 6.957e8 * metre;
68 inline constexpr Unit<> earth_radius = 6.378137e6 * metre;
69 inline constexpr Unit<> solar_mass = 1.98847e30 * kilogram;
70 inline constexpr Unit<> electron_volt = 1.602176634e-19 * joule;
71 inline constexpr Unit<> erg = 1e-7 * joule;
72 inline constexpr Unit<> british_pint = 5.68e-4 * upow(metre, 3);
73
76 inline constexpr auto registry = std::to_array<NamedUnit>({
77 {"second", "s", second},
78 {"metre", "m", metre},
79 {"kilogram", "kg", kilogram},
80 {"Ampere", "A", ampere},
81 {"Kelvin", "K", kelvin},
82 {"mole", "mol", mole},
83 {"candela", "cd", candela},
84 {"Hertz", "Hz", hertz},
85 {"Newton", "N", newton},
86 {"Pascal", "Pa", pascal},
87 {"Joule", "J", joule},
88 {"Watt", "W", watt},
89 {"Coulomb", "C", coulomb},
90 {"Volt", "V", volt},
91 {"Farad", "F", farad},
92 {"Ohm", "ohm", ohm},
93 {"Siemens", "S", siemens},
94 {"Weber", "Wb", weber},
95 {"Tesla", "T", tesla},
96 {"Henry", "H", henry},
97 {"lumens", "lm", lumen},
98 {"lux", "lx", lux},
99 {"Becquerel", "Bq", becquerel},
100 {"Gray", "Gy", gray},
101 {"Sievert", "Sv", sievert},
102 {"katal", "kat", katal},
103 {"minutes", "mn", minute},
104 {"hours", "hr", hour},
105 {"days", "dy", day},
106 {"years", "yr", year},
107 {"astronomical_unit", "au", astronomical_unit},
108 {"light_year", "ly", light_year},
109 {"parsec", "pc", parsec},
110 {"solar_radius", "rsol", solar_radius},
111 {"earth_radius", "rearth", earth_radius},
112 {"solar_mass", "sol_mass", solar_mass},
113 {"electron_volt", "eV", electron_volt},
114 {"ergs", "erg", erg},
115 {"british_pint", "pint", british_pint},
116 });
117
118 static_assert(details::names_are_valid(registry), "empty or duplicate unit name");
119
120 // Dimension cross-checks: catch a wrong composition at compile time
121 static_assert(pascal.dim == Dimension{.second = -2, .metre = -1, .kilogram = 1});
122 static_assert(joule.dim == Dimension{.second = -2, .metre = 2, .kilogram = 1});
123 static_assert(watt.dim == Dimension{.second = -3, .metre = 2, .kilogram = 1});
124 static_assert(volt.dim == Dimension{.second = -3, .metre = 2, .kilogram = 1, .ampere = -1});
125 static_assert(farad.dim == Dimension{.second = 4, .metre = -2, .kilogram = -1, .ampere = 2});
126 static_assert(ohm.dim == Dimension{.second = -3, .metre = 2, .kilogram = 1, .ampere = -2});
127 static_assert(siemens.dim == Dimension{.second = 3, .metre = -2, .kilogram = -1, .ampere = 2});
128 static_assert(weber.dim == Dimension{.second = -2, .metre = 2, .kilogram = 1, .ampere = -1});
129 static_assert(tesla.dim == Dimension{.second = -2, .kilogram = 1, .ampere = -1});
130 static_assert(henry.dim == Dimension{.second = -2, .metre = 2, .kilogram = 1, .ampere = -2});
131 static_assert(lux.dim == Dimension{.metre = -2, .candela = 1});
132 static_assert(gray.dim == Dimension{.second = -2, .metre = 2});
133 static_assert(katal.dim == Dimension{.second = -1, .mole = 1});
134 static_assert(electron_volt.dim == joule.dim && erg.dim == joule.dim);
135 static_assert(british_pint.dim == Dimension{.metre = 3});
136
138 inline Unit<> from_name(std::string_view name) {
139 return details::unit_from_name(registry, name, "unit");
140 }
141
142} // namespace shamunits::units
A physical unit as a value: its SI dimension and its magnitude in SI base units.
constexpr Unit< T > base_unit(Dimension d) noexcept
A base unit of the given dimension with factor 1, e.g. base_unit({.metre = 1}).
Definition Unit.hpp:165
constexpr Unit< T > upow(Unit< T > u, int n) noexcept
Integer power of a unit.
Definition Unit.hpp:147
Name tables mapping long and short names to units, with constexpr lookup.
Unit unit_from_name(std::span< const NamedUnit > registry, std::string_view name, std::string_view kind="unit")
Unit named name in registry; throws std::invalid_argument when unknown.
Definition registry.hpp:58
constexpr bool names_are_valid(std::span< const NamedUnit > registry) noexcept
True when no name is empty and no name appears twice, long and short names together.
Definition registry.hpp:70
Exponents of the seven SI base dimensions.
Definition Unit.hpp:35
A unit: its dimension and its magnitude expressed in SI base units, in precision Tscal.
Definition Unit.hpp:89
Dimension dim
SI dimension.
Definition Unit.hpp:90
constexpr Unit farad
F = C.V-1.
constexpr Unit light_year
ly
constexpr Unit hertz
Hz = s-1.
constexpr Unit solar_radius
rsol
constexpr Unit kilogram
kg
constexpr Unit lux
lx = lm.m-2
constexpr Unit pascal
Pa = N.m-2.
constexpr Unit becquerel
Bq = s-1.
constexpr Unit mole
mol
constexpr Unit kelvin
K.
constexpr Unit candela
cd
Unit from_name(std::string_view name)
Unit from its long or short name; throws std::invalid_argument if unknown.
constexpr Unit siemens
S = ohm-1.
constexpr Unit earth_radius
rearth (equatorial)
constexpr Unit electron_volt
eV
constexpr auto registry
constexpr Unit newton
N = kg.m.s-2.
constexpr Unit hour
hr
constexpr Unit solar_mass
sol_mass
constexpr Unit lumen
lm = cd.sr
constexpr Unit joule
J = N.m.
constexpr Unit watt
W = J.s-1.
constexpr Unit second
s
constexpr Unit ampere
A.
constexpr Unit tesla
T = Wb.m-2.
constexpr Unit minute
mn
constexpr Unit british_pint
pint (0.568 L)
constexpr Unit metre
m
constexpr Unit erg
erg
constexpr Unit parsec
pc
constexpr Unit year
yr (Julian)
constexpr Unit sievert
Sv = J.kg-1.
constexpr Unit coulomb
C = s.A.
constexpr Unit ohm
ohm = V.A-1
constexpr Unit gray
Gy = J.kg-1.
constexpr Unit volt
V = W.A-1.
constexpr Unit weber
Wb = V.s.
constexpr Unit katal
kat = mol.s-1
constexpr Unit henry
H = Wb.A-1.
constexpr Unit astronomical_unit
au
constexpr Unit day
dy