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

65 lines
2.6 KiB
Groff
Raw Normal View History

.TH "serif::discretization::blocks::density" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::density \- The density field used to represent the distribution of mass in the system\&. This is a scalar field that is associated with the mass density of the system\&. The density field is used to enforce the mass conservation condition in the weak form\&.
.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 \fBmass\fP"
.br
.RI "The mass density term for the system\&. Note that the naming here could be a bit confusing as FEM also uses the term "mass" to represent the canonical mass matrix\&. This is a more standard physics reading of what is going on here\&. We define that this space is a third order scalar H1 space\&. This gives density a continuous surface trace and a weak spatial gradient\&. "
.in -1c
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBmass\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<\fBdensity\fP>()"
.br
.RI "Compile time reflected name of the field\&. "
.ti -1c
.RI "static constexpr \fBmass\fP \fBmass_density_term\fP {}"
.br
.RI "Static constexpr instance of the mass term\&. This is used to access the term in the discretization\&. "
.in -1c
.SH "Detailed Description"
.PP
The density field used to represent the distribution of mass in the system\&. This is a scalar field that is associated with the mass density of the system\&. The density field is used to enforce the mass conservation condition in the weak form\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::discretization::blocks::density::Terms\fP = \fButils::types::TypeList\fP<\fBmass\fP>"
.PP
Type list of terms for compile time reflection and iteration over the terms of the field\&.
.SH "Member Data Documentation"
.PP
.SS "\fBmass\fP serif::discretization::blocks::density::mass_density_term {}\fR [static]\fP, \fR [constexpr]\fP"
.PP
Static constexpr instance of the mass term\&. This is used to access the term in the discretization\&.
.SS "std::string_view serif::discretization::blocks::density::name = \fBmeta::type_name\fP<\fBdensity\fP>()\fR [static]\fP, \fR [constexpr]\fP"
.PP
Compile time reflected name of the field\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.