Move docs
This commit is contained in:
75
man_pages/man3/constants.hpp.3
Normal file
75
man_pages/man3/constants.hpp.3
Normal file
@@ -0,0 +1,75 @@
|
||||
.TH "include/constants.hpp" 3 "Thu Sep 28 2023" "Penning Trap Simulation" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
include/constants.hpp \- Library of constants\&.
|
||||
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
.PP
|
||||
.SS "Macros"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "#define \fBK_E\fP 138935\&.333"
|
||||
.br
|
||||
.RI "Coulomb constant\&. unit: $\frac{u(\mu m)^3}{(\mu s)^2 e^2}$\&. "
|
||||
.ti -1c
|
||||
.RI "#define \fBT\fP 96\&.4852558"
|
||||
.br
|
||||
.RI "1 Tesla\&. unit: $ \frac{u}{(\mu s) e} $ "
|
||||
.ti -1c
|
||||
.RI "#define \fBV\fP 96485255\&.8"
|
||||
.br
|
||||
.RI "1 Volt\&. unit: $ \frac{u (\mu m)^2}{(\mu s)^2 e} $ "
|
||||
.in -1c
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
Library of constants\&.
|
||||
|
||||
|
||||
.PP
|
||||
\fBAuthor\fP
|
||||
.RS 4
|
||||
Cory Alexander Balaton (coryab)
|
||||
.PP
|
||||
Janita Ovidie Sandtrøen Willumsen (janitaws)
|
||||
.RE
|
||||
.PP
|
||||
\fBVersion\fP
|
||||
.RS 4
|
||||
0\&.1
|
||||
.RE
|
||||
.PP
|
||||
.PP
|
||||
\fBBug\fP
|
||||
.RS 4
|
||||
No known bugs
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition in file \fBconstants\&.hpp\fP\&.
|
||||
.SH "Macro Definition Documentation"
|
||||
.PP
|
||||
.SS "#define K_E 138935\&.333"
|
||||
|
||||
.PP
|
||||
Coulomb constant\&. unit: $\frac{u(\mu m)^3}{(\mu s)^2 e^2}$\&.
|
||||
.PP
|
||||
Definition at line \fB15\fP of file \fBconstants\&.hpp\fP\&.
|
||||
.SS "#define T 96\&.4852558"
|
||||
|
||||
.PP
|
||||
1 Tesla\&. unit: $ \frac{u}{(\mu s) e} $
|
||||
.PP
|
||||
Definition at line \fB17\fP of file \fBconstants\&.hpp\fP\&.
|
||||
.SS "#define V 96485255\&.8"
|
||||
|
||||
.PP
|
||||
1 Volt\&. unit: $ \frac{u (\mu m)^2}{(\mu s)^2 e} $
|
||||
.PP
|
||||
Definition at line \fB19\fP of file \fBconstants\&.hpp\fP\&.
|
||||
.SH "Author"
|
||||
.PP
|
||||
Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.
|
||||
Reference in New Issue
Block a user