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.1 KiB
Groff
65 lines
3.1 KiB
Groff
.TH "serif::discretization::blocks::rotation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::discretization::blocks::rotation \- The rotational field, represented as the angular velocity term, given that we currently only model rigid rotation this is a global scalar\&. A future extension which models differential rotation will likely need to modify this to some vector field or other more complex representation of the rotation\&.
|
|
|
|
.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 \fBangular_velocity\fP"
|
|
.br
|
|
.RI "The \fBangular_velocity\fP term represents the angular velocity of the system\&. It is a global scalar that is associated with the rotation of the system\&. This is used to enforce the rotation condition in the weak form when we are in the rigid rotation case\&. Note that downstream the way that this currently works is to calculate the expected angular velocity given the current mass, geometry, density, and angular momentum and then prescribe, given those, what the angular velocity should be\&. Therefore, this does not enforce that the angular velocity must be constant over the entire solver run, but rather that the angular velocity is consistent with the current state of the system\&. "
|
|
.in -1c
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTerms\fP = \fButils::types::TypeList\fP<\fBangular_velocity\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<\fBrotation\fP>()"
|
|
.br
|
|
.RI "Compile time reflected name of the field\&. "
|
|
.ti -1c
|
|
.RI "static constexpr \fBangular_velocity\fP \fBangular_velocity_term\fP {}"
|
|
.br
|
|
.RI "Static constexpr instance of the \fBangular_velocity\fP term\&. This is used to access the term in the discretization\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
The rotational field, represented as the angular velocity term, given that we currently only model rigid rotation this is a global scalar\&. A future extension which models differential rotation will likely need to modify this to some vector field or other more complex representation of the rotation\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::discretization::blocks::rotation::Terms\fP = \fButils::types::TypeList\fP<\fBangular_velocity\fP>"
|
|
|
|
.PP
|
|
Type list of terms for compile time reflection and iteration over the terms of the field\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fBangular_velocity\fP serif::discretization::blocks::rotation::angular_velocity_term {}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.PP
|
|
Static constexpr instance of the \fBangular_velocity\fP term\&. This is used to access the term in the discretization\&.
|
|
.SS "std::string_view serif::discretization::blocks::rotation::name = \fBmeta::type_name\fP<\fBrotation\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\&.
|