Files
MeanField_SERiF/docs/man/man3/radial_locator.hpp.3

81 lines
2.4 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/geometry/deformation/detail/radial_locator.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/geometry/deformation/detail/radial_locator.hpp \- File containing some utility functions for locating points on a radial shell\&.
.SH SYNOPSIS
.br
.PP
\fR#include 'mfem/fem/intrules\&.hpp'\fP
.br
\fR#include 'mfem/linalg/vector\&.hpp'\fP
.br
\fR#include 'serif/geometry/deformation/failure\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBserif::geometry::deformation::backend::mfem::detail::LocatedBoundaryPoint\fP"
.br
.RI "A structure representing a located boundary point, including the boundary element index and the integration point on that element\&. "
.in -1c
.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 "double \fBserif::geometry::deformation::backend::mfem::detail::logical_radius\fP (const ::mfem::Vector &position)"
.br
.RI "compute the cubical local radius of a given position vector\&. Alternative put: compute the $L\infty$ norm of the position vector (i\&.e\&. the maximum absolute value of its components) "
.ti -1c
.RI "std::expected< double, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::detail::boundary_logical_radius\fP (::mfem::Mesh &mesh, int attribute)"
.br
.RI "Compute the logical radius of a boundary shell in a mesh, given the mesh and the boundary attribute\&. "
.ti -1c
.RI "std::expected< \fBLocatedBoundaryPoint\fP, \fBDeformationFailure\fP > \fBserif::geometry::deformation::backend::mfem::detail::locate_boundary_point\fP (::mfem::Mesh &mesh, int attribute, const ::mfem::Vector &target)"
.br
.RI "Locate a projected logical ray on a quadrilateral shell\&. "
.in -1c
.SH "Detailed Description"
.PP
File containing some utility functions for locating points on a radial shell\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.