Files

60 lines
1.3 KiB
Groff
Raw Permalink Normal View History

.TH "src/include/serif/equations/centering.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/equations/centering.hpp \- File containing the CenteringConstraint equation, which fixes the material point at the computational origin\&.
.SH SYNOPSIS
.br
.PP
\fR#include <array>\fP
.br
\fR#include <string_view>\fP
.br
\fR#include 'serif/equations/contributions\&.hpp'\fP
.br
\fR#include 'serif/equations/point\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::equations::CenteringConstraint\fP"
.br
.RI "\fBEquation\fP that fixes the material point at the computational origin\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::equations\fP"
.br
.RI "The equations namespace, intended to be, to the best of my design ability, where the vast majority of the actual physics lives\&. "
.in -1c
.SH "Detailed Description"
.PP
File containing the CenteringConstraint equation, which fixes the material point at the computational origin\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.PP
\fBNote\fP
.RS 4
This is probably the simplest equation we have right now and therefore may serve as a useful example to learn from\&.
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.