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

50 lines
1.6 KiB
Groff
Raw Normal View History

.TH "serif::discretization::blocks::frame_acceleration" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::frame_acceleration \- Uniform translation reaction, one global scalar per Cartesian axis, to be paired with BarycenterConstraint (for example when an external companion potential acts on the star)\&. It must vanish in a physical equilibrium\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fields\&.hpp>\fP
.PP
Inherits \fBserif::discretization::blocks::field\fP\&.
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBcomponent\fP"
.br
.in -1c
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBcomponent\fP<0>, \fBcomponent\fP<1>, \fBcomponent\fP<2>>"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "static constexpr std::string_view \fBname\fP = 'frame acceleration'"
.br
.in -1c
.SH "Detailed Description"
.PP
Uniform translation reaction, one global scalar per Cartesian axis, to be paired with BarycenterConstraint (for example when an external companion potential acts on the star)\&. It must vanish in a physical equilibrium\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::discretization::blocks::frame_acceleration::Terms\fP = \fButils::types::TypeList\fP<\fBcomponent\fP<0>, \fBcomponent\fP<1>, \fBcomponent\fP<2>>"
.SH "Member Data Documentation"
.PP
.SS "std::string_view serif::discretization::blocks::frame_acceleration::name = 'frame acceleration'\fR [static]\fP, \fR [constexpr]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.