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

61 lines
1.9 KiB
Groff
Raw Normal View History

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