Skip to content

Commit 2a70697

Browse files
committed
Add docs for all constants
1 parent da00855 commit 2a70697

File tree

1 file changed

+139
-0
lines changed

1 file changed

+139
-0
lines changed

src/constants.jl

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,31 @@ end
3636
@register_constant k_B 1.380649e-23 * U.J/U.K
3737
@register_constant N_A 6.02214076e+23 / U.mol
3838

39+
@doc(
40+
"Speed of light in a vacuum. Standard.",
41+
c,
42+
)
43+
@doc(
44+
"Planck constant. Standard.",
45+
h,
46+
)
47+
@doc(
48+
"Reduced Planck constant (h/2π). Standard.",
49+
hbar,
50+
)
51+
@doc(
52+
"Elementary charge. Standard.",
53+
e,
54+
)
55+
@doc(
56+
"Boltzmann constant. Standard.",
57+
k_B,
58+
)
59+
@doc(
60+
"Avogadro constant. Standard.",
61+
N_A,
62+
)
63+
3964
# Exact, derived:
4065
@register_constant eV e * U.J/U.C
4166
@register_constant R N_A * k_B
@@ -44,6 +69,23 @@ end
4469

4570
@add_prefixes eV (m, k, M, G, T)
4671

72+
@doc(
73+
"Electron volt. Standard.",
74+
eV,
75+
)
76+
@doc(
77+
"Molar gas constant. Standard.",
78+
R,
79+
)
80+
@doc(
81+
"Faraday constant. Standard.",
82+
F,
83+
)
84+
@doc(
85+
"Stefan-Boltzmann constant. Standard.",
86+
sigma_sb,
87+
)
88+
4789
# Measured
4890
@register_constant alpha DEFAULT_QUANTITY_TYPE(7.2973525693e-3)
4991
@register_constant u 1.66053906660e-27 * U.kg
@@ -57,6 +99,50 @@ end
5799
@register_constant k_e 1/(4π * eps_0)
58100
@register_constant Ryd alpha^2 * m_e * c^2 / (2 * h)
59101

102+
@doc(
103+
"Fine-structure constant. Measured.",
104+
alpha,
105+
)
106+
@doc(
107+
"Atomic mass unit (1/12th the mass of Carbon-12). Measured.",
108+
u,
109+
)
110+
@doc(
111+
"Newtonian constant of gravitation. Measured.",
112+
G,
113+
)
114+
@doc(
115+
"Vacuum magnetic permeability. Measured.",
116+
mu_0,
117+
)
118+
@doc(
119+
"Vacuum electric permittivity. Measured.",
120+
eps_0,
121+
)
122+
@doc(
123+
"Electron mass. Measured.",
124+
m_e,
125+
)
126+
@doc(
127+
"Proton mass. Measured.",
128+
m_p,
129+
)
130+
@doc(
131+
"Neutron mass. Measured.",
132+
m_n,
133+
)
134+
@doc(
135+
"Bohr radius. Measured.",
136+
a_0,
137+
)
138+
@doc(
139+
"Coulomb constant (Note: SI units only!). Measured.",
140+
k_e,
141+
)
142+
@doc(
143+
"Rydberg frequency. Measured.",
144+
Ryd,
145+
)
60146

61147
# Astro constants.
62148
# Source: https://arxiv.org/abs/1510.07674
@@ -77,6 +163,59 @@ end
77163

78164
@add_prefixes pc (k, M, G)
79165

166+
@doc(
167+
"Earth mass. Measured.",
168+
M_earth,
169+
)
170+
@doc(
171+
"Solar mass. Measured.",
172+
M_sun,
173+
)
174+
@doc(
175+
"Jupiter mass. Measured.",
176+
M_jup,
177+
)
178+
@doc(
179+
"Nominal Earth equatorial radius. Standard.",
180+
R_earth,
181+
)
182+
@doc(
183+
"Nominal Jupiter equatorial radius. Standard.",
184+
R_jup,
185+
)
186+
@doc(
187+
"Nominal solar radius. Standard.",
188+
R_sun,
189+
)
190+
@doc(
191+
"Nominal solar luminosity. Standard.",
192+
L_sun,
193+
)
194+
@doc(
195+
"Standard luminosity at absolute bolometric magnitude 0. Standard.",
196+
L_bol0,
197+
)
198+
@doc(
199+
"Thomson scattering cross-section. Measured.",
200+
sigma_T,
201+
)
202+
@doc(
203+
"Astronomical unit. Standard.",
204+
au,
205+
)
206+
@doc(
207+
"Parsec. Standard.",
208+
pc,
209+
)
210+
@doc(
211+
"Light year. Standard.",
212+
ly,
213+
)
214+
@doc(
215+
"Standard atmosphere. Standard.",
216+
atm,
217+
)
218+
80219
"""A tuple of all possible constants."""
81220
const CONSTANT_SYMBOLS = Tuple(_CONSTANT_SYMBOLS)
82221
const CONSTANT_VALUES = Tuple(_CONSTANT_VALUES)

0 commit comments

Comments
 (0)