Files
MeanField_SERiF/docs/man/man3/reference_geometry.cpp.3

68 lines
2.9 KiB
Groff
Raw Normal View History

.TH "src/lib/serif/backend/mfem/geometry/deformation/reference_geometry.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/lib/serif/backend/mfem/geometry/deformation/reference_geometry.cpp
.SH SYNOPSIS
.br
.PP
\fR#include <algorithm>\fP
.br
\fR#include <cmath>\fP
.br
\fR#include 'mfem/fem/fespace\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/geometry/deformation/reference_geometry\&.hpp'\fP
.br
.SS "Namespaces"
.in +1c
.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
.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< 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< 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< \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\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.