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)
21 lines
1.7 KiB
Groff
21 lines
1.7 KiB
Groff
.TH "serif::discretization::blocks::term_base" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::term_base \- The \fBterm_base\fP struct is a tag type that is used to identify a term in the discretization\&. It is used to group together terms that belong to the same field\&. Each term should have a unique name and a list of blocks that belong to it\&. Generally you should always use term rather than \fBterm_base\fP as term associates to a particular field at compile time\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <fields\&.hpp>\fP
|
|
.PP
|
|
Inherited by \fBserif::discretization::blocks::term< blocks::density >\fP, \fBserif::discretization::blocks::term< barotropic_constant >\fP, \fBserif::discretization::blocks::term< density >\fP, \fBserif::discretization::blocks::term< displacement >\fP, \fBserif::discretization::blocks::term< frame_acceleration >\fP, \fBserif::discretization::blocks::term< gravity >\fP, \fBserif::discretization::blocks::term< rotation >\fP, \fBserif::discretization::blocks::term< surface_deformation >\fP, \fBserif::discretization::blocks::term< discretization::blocks::density >\fP, \fBserif::discretization::blocks::term< ExtraField >\fP, and \fBserif::discretization::blocks::term< FieldT >\fP\&.
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The \fBterm_base\fP struct is a tag type that is used to identify a term in the discretization\&. It is used to group together terms that belong to the same field\&. Each term should have a unique name and a list of blocks that belong to it\&. Generally you should always use term rather than \fBterm_base\fP as term associates to a particular field at compile time\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|