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
3.0 KiB
Groff
65 lines
3.0 KiB
Groff
.TH "serif::discretization::blocks::enthalpy" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::enthalpy \- The enthalpy field is a scalar field is a C0 continuous scalar field\&. Note that this field likely will not survive the transition to the more general non-barotropic case\&. In the barotropic case the gradient of enthalpy is parallel to the gradient of the pressure\&. This make enthalpy a particularly useful quantity as we can represent the 0 pressure surface condition as the 0 enthalpy condition and we can break down mass constraint into a game of optimizing the Bernoulli constant\&.
|
|
|
|
.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 \fBspecific\fP"
|
|
.br
|
|
.RI "the specific enthalpy is the term we specifically work with rather than the total enthalpy of dof\&. In fact heuristically I would say that generally we should always work in specific quantities rather than total quantities as there is not a well defined amount of material at some dof\&. "
|
|
.in -1c
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBspecific\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<\fBenthalpy\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the field\&. "
|
|
.ti -1c
|
|
.RI "static constexpr \fBspecific\fP \fBspecific_term\fP {}"
|
|
.br
|
|
.RI "Static constexpr instance of the specific term\&. This is used to access the term in the discretization\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The enthalpy field is a scalar field is a C0 continuous scalar field\&. Note that this field likely will not survive the transition to the more general non-barotropic case\&. In the barotropic case the gradient of enthalpy is parallel to the gradient of the pressure\&. This make enthalpy a particularly useful quantity as we can represent the 0 pressure surface condition as the 0 enthalpy condition and we can break down mass constraint into a game of optimizing the Bernoulli constant\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::discretization::blocks::enthalpy::Terms\fP = \fButils::types::TypeList\fP<\fBspecific\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::enthalpy::name = \fBmeta::type_name\fP<\fBenthalpy\fP>()\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Compile time reflected name of the field\&.
|
|
.SS "\fBspecific\fP serif::discretization::blocks::enthalpy::specific_term {}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Static constexpr instance of the specific term\&. This is used to access the term in the discretization\&.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|