Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
65 lines
2.3 KiB
Groff
65 lines
2.3 KiB
Groff
.TH "serif::discretization::blocks::gravity" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::gravity \- The gravity field contains the scalar potential\&. The primal formulation solves the potential and obtains its gradient by differentiation\&.
|
|
|
|
.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 \fBpotential\fP"
|
|
.br
|
|
.RI "The gravitational potential term is a fourth order H1 scalar field that is used to represent the gravitational potential of the system\&. Its continuous trace supports the surface potential condition, and its spatial gradient supplies gravity in the primal formulation\&. "
|
|
.in -1c
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBpotential\fP>"
|
|
.br
|
|
.RI "Type list of terms for compile time reflection and iteration over the terms of the field\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = \fBmeta::type_name\fP<\fBgravity\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the field\&. "
|
|
.ti -1c
|
|
.RI "static constexpr \fBpotential\fP \fBpotential_term\fP {}"
|
|
.br
|
|
.RI "Static constexpr instance of the potential term\&. This is used to access the term in the discretization\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The gravity field contains the scalar potential\&. The primal formulation solves the potential and obtains its gradient by differentiation\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::discretization::blocks::gravity::Terms\fP = \fButils::types::TypeList\fP<\fBpotential\fP>"
|
|
|
|
.PP
|
|
Type list of terms for compile time reflection and iteration over the terms of the field\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::discretization::blocks::gravity::name = \fBmeta::type_name\fP<\fBgravity\fP>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time reflected name of the field\&.
|
|
.SS "\fBpotential\fP serif::discretization::blocks::gravity::potential_term {}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Static constexpr instance of the potential term\&. This is used to access the term in the discretization\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|