Files
MeanField_SERiF/docs/man/man3/rigid_rotation.hpp.3

52 lines
978 B
Groff
Raw Normal View History

.TH "src/include/serif/equations/rigid_rotation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/equations/rigid_rotation.hpp \- An equation implementing rigid rotation\&.
.SH SYNOPSIS
.br
.PP
\fR#include <cmath>\fP
.br
\fR#include <stdexcept>\fP
.br
\fR#include 'serif/discretization/forms/value\&.hpp'\fP
.br
\fR#include 'serif/utils/error/errors\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::equations::RigidRotation\fP"
.br
.RI "A class that implements rigid rotation, providing methods to compute the centrifugal potential, its gradient, and its Hessian\&. "
.in -1c
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::equations\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
An equation implementing rigid rotation\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.