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)
64 lines
2.5 KiB
Groff
64 lines
2.5 KiB
Groff
.TH "serif::model::EquilibriumEquations< Interior, Shape, Surface >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::EquilibriumEquations< Interior, Shape, Surface > \- State the chosen equations explicitly, without selecting physics from the EOS\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <equilibrium_equations\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBInteriorEquations\fP = std::remove_cvref_t<Interior>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBShapeForce\fP = std::remove_cvref_t<Shape>"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBSurfaceCondition\fP = std::remove_cvref_t<Surface>"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "Interior \fBinterior_equations\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "Shape \fBshape_force\fP {}"
|
|
.br
|
|
.ti -1c
|
|
.RI "Surface \fBsurface_condition\fP {}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition>
|
|
.br
|
|
struct serif::model::EquilibriumEquations< Interior, Shape, Surface >"State the chosen equations explicitly, without selecting physics from the EOS\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> using \fBserif::model::EquilibriumEquations\fP< Interior, Shape, Surface >::InteriorEquations = std::remove_cvref_t<Interior>"
|
|
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> using \fBserif::model::EquilibriumEquations\fP< Interior, Shape, Surface >::ShapeForce = std::remove_cvref_t<Shape>"
|
|
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> using \fBserif::model::EquilibriumEquations\fP< Interior, Shape, Surface >::SurfaceCondition = std::remove_cvref_t<Surface>"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> Interior \fBserif::model::EquilibriumEquations\fP< Interior, Shape, Surface >::interior_equations"
|
|
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> Shape \fBserif::model::EquilibriumEquations\fP< Interior, Shape, Surface >::shape_force {}"
|
|
|
|
.SS "template<typename Interior, typename Shape = NoShapeForce, typename Surface = NoSurfaceCondition> Surface \fBserif::model::EquilibriumEquations\fP< Interior, Shape, Surface >::surface_condition {}"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|