Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
unit_table.hpp File Reference

The table of units: one constexpr Unit per unit, plus its name registry. More...

#include "shamunits/Unit.hpp"
#include "shamunits/details/registry.hpp"
#include <string_view>
#include <array>
Include dependency graph for unit_table.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  shamunits
 namespace containing the units library

Functions

Unit shamunits::units::from_name (std::string_view name)
 Unit from its long or short name; throws std::invalid_argument if unknown.

Variables

constexpr Unit shamunits::units::second = base_unit({.second = 1})
 s
constexpr Unit shamunits::units::metre = base_unit({.metre = 1})
 m
constexpr Unit shamunits::units::kilogram = base_unit({.kilogram = 1})
 kg
constexpr Unit shamunits::units::ampere = base_unit({.ampere = 1})
 A.
constexpr Unit shamunits::units::kelvin = base_unit({.kelvin = 1})
 K.
constexpr Unit shamunits::units::mole = base_unit({.mole = 1})
 mol
constexpr Unit shamunits::units::candela = base_unit({.candela = 1})
 cd
constexpr Unit shamunits::units::hertz = 1. / second
 Hz = s-1.
constexpr Unit shamunits::units::newton = kilogram * metre / upow(second, 2)
 N = kg.m.s-2.
constexpr Unit shamunits::units::pascal = newton / upow(metre, 2)
 Pa = N.m-2.
constexpr Unit shamunits::units::joule = newton * metre
 J = N.m.
constexpr Unit shamunits::units::watt = joule / second
 W = J.s-1.
constexpr Unit shamunits::units::coulomb = second * ampere
 C = s.A.
constexpr Unit shamunits::units::volt = watt / ampere
 V = W.A-1.
constexpr Unit shamunits::units::farad = coulomb / volt
 F = C.V-1.
constexpr Unit shamunits::units::ohm = volt / ampere
 ohm = V.A-1
constexpr Unit shamunits::units::siemens = 1. / ohm
 S = ohm-1.
constexpr Unit shamunits::units::weber = volt * second
 Wb = V.s.
constexpr Unit shamunits::units::tesla = weber / upow(metre, 2)
 T = Wb.m-2.
constexpr Unit shamunits::units::henry = weber / ampere
 H = Wb.A-1.
constexpr Unit shamunits::units::lumen = candela
 lm = cd.sr
constexpr Unit shamunits::units::lux = lumen / upow(metre, 2)
 lx = lm.m-2
constexpr Unit shamunits::units::becquerel = 1. / second
 Bq = s-1.
constexpr Unit shamunits::units::gray = joule / kilogram
 Gy = J.kg-1.
constexpr Unit shamunits::units::sievert = joule / kilogram
 Sv = J.kg-1.
constexpr Unit shamunits::units::katal = mole / second
 kat = mol.s-1
constexpr Unit shamunits::units::minute = 60. * second
 mn
constexpr Unit shamunits::units::hour = 3600. * second
 hr
constexpr Unit shamunits::units::day = 86400. * second
 dy
constexpr Unit shamunits::units::year = 31557600. * second
 yr (Julian)
constexpr Unit shamunits::units::astronomical_unit = 149597870700. * metre
 au
constexpr Unit shamunits::units::light_year = 9460730472580800. * metre
 ly
constexpr Unit shamunits::units::parsec = 3.0857e16 * metre
 pc
constexpr Unit shamunits::units::solar_radius = 6.957e8 * metre
 rsol
constexpr Unit shamunits::units::earth_radius = 6.378137e6 * metre
 rearth (equatorial)
constexpr Unit shamunits::units::solar_mass = 1.98847e30 * kilogram
 sol_mass
constexpr Unit shamunits::units::electron_volt = 1.602176634e-19 * joule
 eV
constexpr Unit shamunits::units::erg = 1e-7 * joule
 erg
constexpr Unit shamunits::units::british_pint = 5.68e-4 * upow(metre, 3)
 pint (0.568 L)
constexpr auto shamunits::units::registry

Detailed Description

The table of units: one constexpr Unit per unit, plus its name registry.

Author
Timothée David–Cléris (tim.s.nosp@m.hamr.nosp@m.ock@p.nosp@m.roto.nosp@m.n.me)

To add a unit: declare it below from existing units, then add one row to the registry. Both are checked at compile time (dimensions, unique names). Factors are Unit<> (double); combine them with double literals only (60. * second, not 60 * second).

Definition in file unit_table.hpp.

Function Documentation

◆ from_name()

Unit shamunits::units::from_name ( std::string_view name)
inline

Unit from its long or short name; throws std::invalid_argument if unknown.

Definition at line 138 of file unit_table.hpp.

Variable Documentation

◆ ampere

Unit shamunits::units::ampere = base_unit({.ampere = 1})
inlineconstexpr

A.

Definition at line 33 of file unit_table.hpp.

◆ astronomical_unit

Unit shamunits::units::astronomical_unit = 149597870700. * metre
inlineconstexpr

au

Definition at line 64 of file unit_table.hpp.

◆ becquerel

Unit shamunits::units::becquerel = 1. / second
inlineconstexpr

Bq = s-1.

Definition at line 54 of file unit_table.hpp.

◆ british_pint

Unit shamunits::units::british_pint = 5.68e-4 * upow(metre, 3)
inlineconstexpr

pint (0.568 L)

Definition at line 72 of file unit_table.hpp.

◆ candela

Unit shamunits::units::candela = base_unit({.candela = 1})
inlineconstexpr

cd

Definition at line 36 of file unit_table.hpp.

◆ coulomb

Unit shamunits::units::coulomb = second * ampere
inlineconstexpr

C = s.A.

Definition at line 44 of file unit_table.hpp.

◆ day

Unit shamunits::units::day = 86400. * second
inlineconstexpr

dy

Definition at line 62 of file unit_table.hpp.

◆ earth_radius

Unit shamunits::units::earth_radius = 6.378137e6 * metre
inlineconstexpr

rearth (equatorial)

Definition at line 68 of file unit_table.hpp.

◆ electron_volt

Unit shamunits::units::electron_volt = 1.602176634e-19 * joule
inlineconstexpr

eV

Definition at line 70 of file unit_table.hpp.

◆ erg

Unit shamunits::units::erg = 1e-7 * joule
inlineconstexpr

erg

Definition at line 71 of file unit_table.hpp.

◆ farad

Unit shamunits::units::farad = coulomb / volt
inlineconstexpr

F = C.V-1.

Definition at line 46 of file unit_table.hpp.

◆ gray

Unit shamunits::units::gray = joule / kilogram
inlineconstexpr

Gy = J.kg-1.

Definition at line 55 of file unit_table.hpp.

◆ henry

Unit shamunits::units::henry = weber / ampere
inlineconstexpr

H = Wb.A-1.

Definition at line 51 of file unit_table.hpp.

◆ hertz

Unit shamunits::units::hertz = 1. / second
inlineconstexpr

Hz = s-1.

Definition at line 39 of file unit_table.hpp.

◆ hour

Unit shamunits::units::hour = 3600. * second
inlineconstexpr

hr

Definition at line 61 of file unit_table.hpp.

◆ joule

Unit shamunits::units::joule = newton * metre
inlineconstexpr

J = N.m.

Definition at line 42 of file unit_table.hpp.

◆ katal

Unit shamunits::units::katal = mole / second
inlineconstexpr

kat = mol.s-1

Definition at line 57 of file unit_table.hpp.

◆ kelvin

Unit shamunits::units::kelvin = base_unit({.kelvin = 1})
inlineconstexpr

K.

Definition at line 34 of file unit_table.hpp.

◆ kilogram

Unit shamunits::units::kilogram = base_unit({.kilogram = 1})
inlineconstexpr

kg

Definition at line 32 of file unit_table.hpp.

◆ light_year

Unit shamunits::units::light_year = 9460730472580800. * metre
inlineconstexpr

ly

Definition at line 65 of file unit_table.hpp.

◆ lumen

Unit shamunits::units::lumen = candela
inlineconstexpr

lm = cd.sr

Definition at line 52 of file unit_table.hpp.

◆ lux

Unit shamunits::units::lux = lumen / upow(metre, 2)
inlineconstexpr

lx = lm.m-2

Definition at line 53 of file unit_table.hpp.

◆ metre

Unit shamunits::units::metre = base_unit({.metre = 1})
inlineconstexpr

m

Definition at line 31 of file unit_table.hpp.

◆ minute

Unit shamunits::units::minute = 60. * second
inlineconstexpr

mn

Definition at line 60 of file unit_table.hpp.

◆ mole

Unit shamunits::units::mole = base_unit({.mole = 1})
inlineconstexpr

mol

Definition at line 35 of file unit_table.hpp.

◆ newton

Unit shamunits::units::newton = kilogram * metre / upow(second, 2)
inlineconstexpr

N = kg.m.s-2.

Definition at line 40 of file unit_table.hpp.

◆ ohm

Unit shamunits::units::ohm = volt / ampere
inlineconstexpr

ohm = V.A-1

Definition at line 47 of file unit_table.hpp.

◆ parsec

Unit shamunits::units::parsec = 3.0857e16 * metre
inlineconstexpr

pc

Definition at line 66 of file unit_table.hpp.

◆ pascal

Unit shamunits::units::pascal = newton / upow(metre, 2)
inlineconstexpr

Pa = N.m-2.

Definition at line 41 of file unit_table.hpp.

◆ registry

auto shamunits::units::registry
inlineconstexpr

Name registry: long and short names. Python and saved scripts resolve these strings, so they must stay

Definition at line 76 of file unit_table.hpp.

◆ second

Unit shamunits::units::second = base_unit({.second = 1})
inlineconstexpr

s

Definition at line 30 of file unit_table.hpp.

◆ siemens

Unit shamunits::units::siemens = 1. / ohm
inlineconstexpr

S = ohm-1.

Definition at line 48 of file unit_table.hpp.

◆ sievert

Unit shamunits::units::sievert = joule / kilogram
inlineconstexpr

Sv = J.kg-1.

Definition at line 56 of file unit_table.hpp.

◆ solar_mass

Unit shamunits::units::solar_mass = 1.98847e30 * kilogram
inlineconstexpr

sol_mass

Definition at line 69 of file unit_table.hpp.

◆ solar_radius

Unit shamunits::units::solar_radius = 6.957e8 * metre
inlineconstexpr

rsol

Definition at line 67 of file unit_table.hpp.

◆ tesla

Unit shamunits::units::tesla = weber / upow(metre, 2)
inlineconstexpr

T = Wb.m-2.

Definition at line 50 of file unit_table.hpp.

◆ volt

Unit shamunits::units::volt = watt / ampere
inlineconstexpr

V = W.A-1.

Definition at line 45 of file unit_table.hpp.

◆ watt

Unit shamunits::units::watt = joule / second
inlineconstexpr

W = J.s-1.

Definition at line 43 of file unit_table.hpp.

◆ weber

Unit shamunits::units::weber = volt * second
inlineconstexpr

Wb = V.s.

Definition at line 49 of file unit_table.hpp.

◆ year

Unit shamunits::units::year = 31557600. * second
inlineconstexpr

yr (Julian)

Definition at line 63 of file unit_table.hpp.