Project-3/man_pages/man3/main.cpp.3
2023-10-08 15:07:52 +02:00

103 lines
1.6 KiB
Groff

.TH "src/main.cpp" 3 "Sun Oct 8 2023" "Penning Trap Simulation" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/main.cpp \- The main program for this project\&.
.SH SYNOPSIS
.br
.PP
\fC#include <fstream>\fP
.br
\fC#include <omp\&.h>\fP
.br
\fC#include <sys/stat\&.h>\fP
.br
\fC#include 'PenningTrap\&.hpp'\fP
.br
.SS "Macros"
.in +1c
.ti -1c
.RI "#define \fBPARTICLES\fP 100"
.br
.ti -1c
.RI "#define \fBN\fP 10000"
.br
.ti -1c
.RI "#define \fBCHARGE\fP 1\&."
.br
.ti -1c
.RI "#define \fBMASS\fP 40\&."
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBsimulate_100_particles\fP ()"
.br
.ti -1c
.RI "int \fBmain\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP
The main program for this project\&.
.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 \fBmain\&.cpp\fP\&.
.SH "Macro Definition Documentation"
.PP
.SS "#define CHARGE 1\&."
.PP
Definition at line \fB21\fP of file \fBmain\&.cpp\fP\&.
.SS "#define MASS 40\&."
.PP
Definition at line \fB22\fP of file \fBmain\&.cpp\fP\&.
.SS "#define N 10000"
.PP
Definition at line \fB20\fP of file \fBmain\&.cpp\fP\&.
.SS "#define PARTICLES 100"
.PP
Definition at line \fB19\fP of file \fBmain\&.cpp\fP\&.
.SH "Function Documentation"
.PP
.SS "int main ()"
.PP
Definition at line \fB77\fP of file \fBmain\&.cpp\fP\&.
.SS "void simulate_100_particles ()"
.PP
Definition at line \fB24\fP of file \fBmain\&.cpp\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Penning Trap Simulation from the source code\&.