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)
68 lines
2.9 KiB
Groff
68 lines
2.9 KiB
Groff
.TH "src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/geometry/deformation/backend/mfem/geometry_inspection\&.hpp'\fP
|
|
.br
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include 'mfem/fem/gridfunc\&.hpp'\fP
|
|
.br
|
|
\fR#include 'mfem/fem/pfespace\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/discretization/backend/mfem/tensor_basis\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/mapping/domain_mapper\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/checks/finite\&.hpp'\fP
|
|
.br
|
|
\fR#include 'serif/utils/checks/invertible\&.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 "std::expected< \fBDeformationGeometryReport\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::inspect_deformation_geometry\fP (const ::mfem::FiniteElementSpace &displacement_space, const ::mfem::Vector &displacement)"
|
|
.br
|
|
.RI "Inspect a serial displacement in the finite-element space's native true-DOF ordering\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBDeformationGeometryReport\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::inspect_deformation_geometry\fP (const ::mfem::FiniteElementSpace &displacement_space, const ::mfem::Vector &displacement, \fBdiscretization::backend::mfem::TensorBasisCache\fP &basis_cache, const \fBmapping::DomainMapper\fP *reference_geometry=nullptr)"
|
|
.br
|
|
.RI "Reuse existing tensor plans between inspections while reading current reference mesh Jacobians\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBDeformationGeometryReport\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::inspect_deformation_geometry\fP (const ::mfem::FiniteElementSpace &displacement_space, std::span< const double > displacement, ::mfem::Ordering::Type coefficient_ordering)"
|
|
.br
|
|
.RI "Inspect true coefficients with an explicit ordering, including deformation's component-block byNODES vectors\&. "
|
|
.ti -1c
|
|
.RI "std::expected< \fBDeformationGeometryReport\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::inspect_deformation_geometry\fP (const ::mfem::FiniteElementSpace &displacement_space, std::span< const double > displacement, ::mfem::Ordering::Type coefficient_ordering, \fBdiscretization::backend::mfem::TensorBasisCache\fP &basis_cache, const \fBmapping::DomainMapper\fP *reference_geometry=nullptr)"
|
|
.br
|
|
.RI "Inspect explicitly ordered true coefficients using the same caller-owned canonical basis cache\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|