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

33 lines
2.0 KiB
Groff
Raw Normal View History

.TH "serif::discretization::blocks::global_scalar" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::blocks::global_scalar \- A global scalar is a term that has a single value over the entire domain (think angular momentum or total mass)\&. Broadly we need to separate these from the other terms since they require different (often less enriched) information at compile time\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fields\&.hpp>\fP
.PP
Inherited by \fBserif::compile_time_checks::surface_boundary::CentralMultiplier\fP, \fBserif::compile_time_checks::surface_boundary::UniformTemperature\fP, \fBserif::discretization::blocks::barotropic_constant::mass_normalization\fP, \fBserif::discretization::blocks::frame_acceleration::component< Axis >\fP, \fBserif::discretization::blocks::rotation::angular_velocity\fP, \fBserif::solver::preconditioner::checks::ExtraRow\fP, and \fBserif::solver::preconditioner::checks::ExtraValue\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 global scalar\&. It is a single value over the entire domain and is not associated with any particular functional space\&. For something like total mass this would be the residual of the mass of the system (i\&.e\&. the difference between the current mass and the target mass)\&. "
.ti -1c
.RI "struct \fBvalue\fP"
.br
.RI "The value block is a block that contains the value of the global scalar\&. It is a single value over the entire domain and is not associated with any particular functional space\&. For something like total mass this would be the actual value of the mass of the system\&. "
.in -1c
.SH "Detailed Description"
.PP
A global scalar is a term that has a single value over the entire domain (think angular momentum or total mass)\&. Broadly we need to separate these from the other terms since they require different (often less enriched) information at compile time\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.