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

89 lines
3.4 KiB
Groff
Raw Permalink Normal View History

.TH "serif::discretization::blocks::enthalpy::specific" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::enthalpy::specific \- 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\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fields\&.hpp>\fP
.PP
Inherits \fBserif::discretization::blocks::term< enthalpy >\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 specific enthalpy term\&. It is a scalar field that is associated with the specific enthalpy of the system\&. "
.ti -1c
.RI "struct \fBvalue\fP"
.br
.RI "The value block is a block that contains the value of the specific enthalpy term\&. It is a scalar field that is associated with the specific enthalpy of the system\&. "
.in -1c
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBFunctionalSpace\fP = \fBfunctional_space::DiscreteFunctionalSpace\fP<\fBfunctional_space::H1\fP, 3, 0>"
.br
.ti -1c
.RI "using \fBSupport\fP = \fBdomain::StellarDomains\fP"
.br
.RI "There is only material in the stellar domain therefore we only support the enthalpy field in the stellar domain\&. "
.ti -1c
.RI "using \fBQuantity\fP = \fBdimensions::SpecificEnthalpy\fP"
.br
.RI "This has the dimension of specific enthalpy,\&. "
.in -1c
Public Types inherited from \fBserif::discretization::blocks::term< enthalpy >\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<\fBspecific\fP>()"
.br
.RI "Compile time reflected name of the term\&. "
.ti -1c
.RI "static constexpr std::string_view \fBsymbol\fP = 'h'"
.br
.RI "Compile time symbol used for the term\&. "
.in -1c
.SH "Detailed Description"
.PP
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\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::discretization::blocks::enthalpy::specific::FunctionalSpace\fP = \fBfunctional_space::DiscreteFunctionalSpace\fP<\fBfunctional_space::H1\fP, 3, 0>"
.SS "using \fBserif::discretization::blocks::enthalpy::specific::Quantity\fP = \fBdimensions::SpecificEnthalpy\fP"
.PP
This has the dimension of specific enthalpy,\&.
.SS "using \fBserif::discretization::blocks::enthalpy::specific::Support\fP = \fBdomain::StellarDomains\fP"
.PP
There is only material in the stellar domain therefore we only support the enthalpy field in the stellar domain\&.
.SH "Member Data Documentation"
.PP
.SS "std::string_view serif::discretization::blocks::enthalpy::specific::name = \fBmeta::type_name\fP<\fBspecific\fP>()\fR [static]\fP, \fR [constexpr]\fP"
.PP
Compile time reflected name of the term\&.
.SS "std::string_view serif::discretization::blocks::enthalpy::specific::symbol = 'h'\fR [static]\fP, \fR [constexpr]\fP"
.PP
Compile time symbol used for the term\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.