Files
MeanField_SERiF/docs/man/man3/companion.hpp.3

37 lines
707 B
Groff
Raw Normal View History

.TH "src/include/serif/equations/companion.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/equations/companion.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <cmath>\fP
.br
\fR#include 'serif/equations/rigid_rotation\&.hpp'\fP
.br
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::equations::PointMassCompanion\fP"
.br
.RI "The potential -G M_c/|x - x_c| of a point-mass companion outside the star\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::equations\fP"
.br
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.