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)
83 lines
2.5 KiB
Groff
83 lines
2.5 KiB
Groff
.TH "src/include/serif/backend/mfem/solver/admissibility/geometry.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/solver/admissibility/geometry.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include <memory>\fP
|
|
.br
|
|
\fR#include <tuple>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/geometry/deformation/geometry_step\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/mapping/domain_mapper\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/backend/mfem/model/graph\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/model/state\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/blocks/vector_view\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/solver/nonlinear/options\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::solver::admissibility::backend::mfem::GeometrySamplingRules\fP"
|
|
.br
|
|
.RI "The union of reference rules used by geometry inspection and all volume equations\&. "
|
|
.ti -1c
|
|
.RI "class \fBserif::solver::admissibility::backend::mfem::GeometryDirection\fP"
|
|
.br
|
|
.RI "Retain one accepted displacement and direction while backtracking changes the current candidate\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::admissibility\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::admissibility::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::admissibility::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::solver::admissibility::backend::mfem::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Equation, typename Scope = typename Equation::Test> auto \fBserif::solver::admissibility::backend::mfem::detail::equation_rule_keys\fP ()"
|
|
.br
|
|
.RI "Identify each contribution's reference-basis computation without preparing a physical linearization\&. "
|
|
.ti -1c
|
|
.RI "std::shared_ptr< const std::vector< \fBmapping::DMFixedMeshGeometry\fP > > \fBserif::solver::admissibility::backend::mfem::detail::sample_reference_geometry\fP (::mfem::Mesh &mesh, const int element, const ::mfem::IntegrationRule &rule)"
|
|
.br
|
|
.RI "Sample the fixed reference-mesh geometry of one rule once, for reuse by every step limit\&. "
|
|
.ti -1c
|
|
.RI "template<typename Bound> auto \fBserif::solver::admissibility::backend::mfem::make_geometry_computations\fP (const std::shared_ptr< const Bound > &bound)"
|
|
.br
|
|
.RI "Let the dependency graph retain geometry sampling data for unchanged FE bindings\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|