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)
84 lines
3.7 KiB
Groff
84 lines
3.7 KiB
Groff
.TH "src/include/serif/backend/mfem/geometry/deformation/reference_geometry.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/geometry/deformation/reference_geometry.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/failure\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/reference_surface\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/surface_embedding\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBmfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation::backend::mfem::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::backend::mfem::validate_scalar_reference_space\fP (const ::mfem::FiniteElementSpace &scalar_space)"
|
|
.br
|
|
.RI "Reject spaces whose coefficients cannot be interpreted as serial nodal positions\&. "
|
|
.ti -1c
|
|
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::backend::mfem::validate_companion_numbering\fP (const ::mfem::FiniteElementSpace &reference_space, const ::mfem::FiniteElementSpace &companion_space)"
|
|
.br
|
|
.RI "Require identical scalar coefficient meanings in two companion spaces\&. \fBVector\fP component ordering may differ; element bases and their scalar-node indices must agree\&. "
|
|
.ti -1c
|
|
.RI "std::expected< std::vector< std::array< double, 3 > >, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::sample_reference_positions\fP (const ::mfem::FiniteElementSpace &scalar_space, ::mfem::Mesh &reference_mesh)"
|
|
.br
|
|
.RI "Sample a paired mesh at the scalar companion nodes, checking shared-node agreement\&. "
|
|
.ti -1c
|
|
.RI "std::expected< std::vector< int >, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::select_surface_scalar_dofs\fP (const ::mfem::FiniteElementSpace &scalar_space, int surface_attribute)"
|
|
.br
|
|
.RI "Select canonical surface nodes without retaining a mesh or finite-element-space pointer\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBReferenceSurface\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::sample_reference_surface\fP (const ::mfem::FiniteElementSpace &scalar_space, int surface_attribute)"
|
|
.br
|
|
.RI "Sample physical reference positions in ascending scalar-DOF order\&. "
|
|
.ti -1c
|
|
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::backend::mfem::validate_surface_trace\fP (const ::mfem::FiniteElementSpace &scalar_space, int surface_attribute, const \fBReferenceSurface\fP &reference_surface, const \fBSurfaceEmbedding\fP &embedding)"
|
|
.br
|
|
.RI "Require the same ordered reference nodes and physical positions as a compiled surface embedding\&. "
|
|
.ti -1c
|
|
.RI "std::expected< std::vector< std::array< double, 3 > >, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::detail::sample_reference_positions\fP (const ::mfem::FiniteElementSpace &scalar_space, ::mfem::Mesh &reference_mesh)"
|
|
.br
|
|
.RI "Sample paired coordinates after the scalar node-selection stage has validated the space\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBReferenceSurface\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::detail::sample_reference_surface\fP (const ::mfem::FiniteElementSpace &scalar_space, const std::vector< int > &selected)"
|
|
.br
|
|
.RI "Reuse the graph's canonical surface nodes when only physical coordinates changed\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|