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

89 lines
4.0 KiB
Groff
Raw Permalink Normal View History

.TH "serif::discretization::blocks::density::mass" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::density::mass \- 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\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fields\&.hpp>\fP
.PP
Inherits \fBserif::discretization::blocks::term< density >\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 mass density term\&. It is a scalar field that is associated with the mass density of the system\&. "
.ti -1c
.RI "struct \fBvalue\fP"
.br
.RI "The value block is a block that contains the value of the mass density term\&. It is a scalar field that is associated with the mass density 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
.RI "third order scalar H1 space\&. Read the template parameters as follows: 1) H1 space, 2) third order, 3) scalar field (rank 0) "
.ti -1c
.RI "using \fBSupport\fP = \fBdomain::StellarDomains\fP"
.br
.RI "The support of the mass density term is the stellar domains since we do not allow material to exist in the vacuum domain\&. "
.ti -1c
.RI "using \fBQuantity\fP = \fBdimensions::MassDensity\fP"
.br
.RI "The quantity of the mass density term is the mass density\&. "
.in -1c
Public Types inherited from \fBserif::discretization::blocks::term< density >\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<\fBmass\fP>()"
.br
.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 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\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::discretization::blocks::density::mass::FunctionalSpace\fP = \fBfunctional_space::DiscreteFunctionalSpace\fP<\fBfunctional_space::H1\fP, 3, 0>"
.PP
third order scalar H1 space\&. Read the template parameters as follows: 1) H1 space, 2) third order, 3) scalar field (rank 0)
.SS "using \fBserif::discretization::blocks::density::mass::Quantity\fP = \fBdimensions::MassDensity\fP"
.PP
The quantity of the mass density term is the mass density\&.
.SS "using \fBserif::discretization::blocks::density::mass::Support\fP = \fBdomain::StellarDomains\fP"
.PP
The support of the mass density term is the stellar domains since we do not allow material to exist in the vacuum domain\&.
.SH "Member Data Documentation"
.PP
.SS "std::string_view serif::discretization::blocks::density::mass::name = \fBmeta::type_name\fP<\fBmass\fP>()\fR [static]\fP, \fR [constexpr]\fP"
.SS "std::string_view serif::discretization::blocks::density::mass::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\&.