Files
MeanField_SERiF/docs/man/man3/serif_equations_PointMassCompanion.3

119 lines
3.8 KiB
Groff
Raw Normal View History

.TH "serif::equations::PointMassCompanion" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::equations::PointMassCompanion \- The potential -G M_c/|x - x_c| of a point-mass companion outside the star\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <companion\&.hpp>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBVector\fP = \fBRigidRotation::Vector\fP"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBPointMassCompanion\fP (const double \fBgravitational_mass\fP, const \fBVector\fP &\fBposition\fP, const bool \fBtidal_only\fP=false)"
.br
.RI "gravitational_mass is G M_c in the model's units; position is the companion's fixed location\&. "
.ti -1c
.RI "double \fBpotential\fP (const \fBVector\fP &x) const"
.br
.RI "Evaluate -G M_c/|x - x_c|, plus G M_c x\&.x_c/|x_c|^3 when only the tide acts\&. "
.ti -1c
.RI "\fBVector\fP \fBpotential_gradient\fP (const \fBVector\fP &x) const"
.br
.RI "Evaluate G M_c (x - x_c)/|x - x_c|^3, plus G M_c x_c/|x_c|^3 when only the tide acts\&. "
.ti -1c
.RI "double \fBgravitational_mass\fP () const noexcept"
.br
.RI "Inspect G M_c\&. "
.ti -1c
.RI "const \fBVector\fP & \fBposition\fP () const noexcept"
.br
.RI "Inspect the companion's location\&. "
.ti -1c
.RI "bool \fBtidal_only\fP () const noexcept"
.br
.RI "Whether the companion's uniform pull is removed, leaving only its tide\&. "
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "double \fBuniform_scale\fP () const"
.br
.RI "G M_c/|x_c|^3, the coefficient of the uniform pull at the origin\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "double \fBm_gravitational_mass\fP"
.br
.ti -1c
.RI "\fBVector\fP \fBm_position\fP"
.br
.ti -1c
.RI "bool \fBm_tidal_only\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
The potential -G M_c/|x - x_c| of a point-mass companion outside the star\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::equations::PointMassCompanion::Vector\fP = \fBRigidRotation::Vector\fP"
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::equations::PointMassCompanion::PointMassCompanion (const double gravitational_mass, const \fBVector\fP & position, const bool tidal_only = \fRfalse\fP)\fR [inline]\fP"
.PP
gravitational_mass is G M_c in the model's units; position is the companion's fixed location\&.
.SH "Member Function Documentation"
.PP
.SS "double serif::equations::PointMassCompanion::gravitational_mass () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect G M_c\&.
.SS "const \fBVector\fP & serif::equations::PointMassCompanion::position () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect the companion's location\&.
.SS "double serif::equations::PointMassCompanion::potential (const \fBVector\fP & x) const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Evaluate -G M_c/|x - x_c|, plus G M_c x\&.x_c/|x_c|^3 when only the tide acts\&.
.SS "\fBVector\fP serif::equations::PointMassCompanion::potential_gradient (const \fBVector\fP & x) const\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Evaluate G M_c (x - x_c)/|x - x_c|^3, plus G M_c x_c/|x_c|^3 when only the tide acts\&.
.SS "bool serif::equations::PointMassCompanion::tidal_only () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Whether the companion's uniform pull is removed, leaving only its tide\&.
.SS "double serif::equations::PointMassCompanion::uniform_scale () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [private]\fP"
.PP
G M_c/|x_c|^3, the coefficient of the uniform pull at the origin\&.
.SH "Member Data Documentation"
.PP
.SS "double serif::equations::PointMassCompanion::m_gravitational_mass\fR [private]\fP"
.SS "\fBVector\fP serif::equations::PointMassCompanion::m_position\fR [private]\fP"
.SS "bool serif::equations::PointMassCompanion::m_tidal_only\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.