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)
92 lines
4.3 KiB
Groff
92 lines
4.3 KiB
Groff
.TH "serif::discretization::blocks::gravity::potential" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::gravity::potential \- 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\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <fields\&.hpp>\fP
|
|
.PP
|
|
Inherits \fBserif::discretization::blocks::term< gravity >\fP\&.
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBresidual\fP"
|
|
.br
|
|
.RI "The residual block is a block that contains the residual of the gravitational potential term\&. It is a scalar field that is associated with the gravitational potential of the system\&. "
|
|
.ti -1c
|
|
.RI "struct \fBvalue\fP"
|
|
.br
|
|
.RI "The value block is a block that contains the value of the gravitational potential term\&. It is a scalar field that is associated with the gravitational potential of the system\&. "
|
|
.in -1c
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBFunctionalSpace\fP = \fBfunctional_space::DiscreteFunctionalSpace\fP<\fBfunctional_space::H1\fP, 4, 0>"
|
|
.br
|
|
.RI "fourth order H1 scalar field\&. Read the template parameters as follows: 1) H1 space, 2) fourth order, 3) rank 0 tensor field "
|
|
.ti -1c
|
|
.RI "using \fBSupport\fP = \fBdomain::AllDomains\fP"
|
|
.br
|
|
.RI "We support gravity on all domains, primarily since the only real boundary condition we have in the general case is that the potential goes to zero at infinity, which is in the vacuum domain\&. "
|
|
.ti -1c
|
|
.RI "using \fBQuantity\fP = \fBdimensions::GravitationalPotential\fP"
|
|
.br
|
|
.RI "This is a dimension of gravitational potential, which is a scalar field that is associated with the gravitational potential of the system\&. "
|
|
.in -1c
|
|
|
|
Public Types inherited from \fBserif::discretization::blocks::term< gravity >\fP
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBfield_type\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = \fBmeta::type_name\fP<\fBpotential\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the term\&. "
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBsymbol\fP = 'φ'"
|
|
.br
|
|
.RI "Compile time symbol used for the term\&. Note that this is a UTF-8 character and may not render correctly in all environments\&. (TODO: Should we introduce an ASCII fallback?, something like make this a tuple of form <main, fallback>?) "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
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\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::discretization::blocks::gravity::potential::FunctionalSpace\fP = \fBfunctional_space::DiscreteFunctionalSpace\fP<\fBfunctional_space::H1\fP, 4, 0>"
|
|
|
|
.PP
|
|
fourth order H1 scalar field\&. Read the template parameters as follows: 1) H1 space, 2) fourth order, 3) rank 0 tensor field
|
|
.SS "using \fBserif::discretization::blocks::gravity::potential::Quantity\fP = \fBdimensions::GravitationalPotential\fP"
|
|
|
|
.PP
|
|
This is a dimension of gravitational potential, which is a scalar field that is associated with the gravitational potential of the system\&.
|
|
.SS "using \fBserif::discretization::blocks::gravity::potential::Support\fP = \fBdomain::AllDomains\fP"
|
|
|
|
.PP
|
|
We support gravity on all domains, primarily since the only real boundary condition we have in the general case is that the potential goes to zero at infinity, which is in the vacuum domain\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::discretization::blocks::gravity::potential::name = \fBmeta::type_name\fP<\fBpotential\fP>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time reflected name of the term\&.
|
|
.SS "std::string_view serif::discretization::blocks::gravity::potential::symbol = 'φ'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time symbol used for the term\&. Note that this is a UTF-8 character and may not render correctly in all environments\&. (TODO: Should we introduce an ASCII fallback?, something like make this a tuple of form <main, fallback>?)
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|