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)
66 lines
1.5 KiB
Groff
66 lines
1.5 KiB
Groff
.TH "src/include/serif/backend/mfem/shared/boundary_elements.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/backend/mfem/shared/boundary_elements.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <expected>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include <string>\fP
|
|
.br
|
|
\fR#include <vector>\fP
|
|
.br
|
|
\fR#include 'mfem/fem/fespace\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::shared::BoundaryFailure\fP"
|
|
.br
|
|
.RI "Explain why canonical boundary coordinates or their local assembly were rejected\&. "
|
|
.ti -1c
|
|
.RI "struct \fBserif::backend::mfem::shared::BoundaryElement\fP"
|
|
.br
|
|
.RI "Borrow one boundary element and its oriented coordinates during a traversal\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend::mfem\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::backend::mfem::shared\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Typedefs"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBserif::backend::mfem::shared::BoundaryStatus\fP = std::expected<void, \fBBoundaryFailure\fP>"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Visitor> \fBBoundaryStatus\fP \fBserif::backend::mfem::shared::for_each_boundary_element\fP (const ::mfem::FiniteElementSpace &space, int attribute, std::span< const int > selected_dofs, Visitor &&visit)"
|
|
.br
|
|
.RI "Visit a scalar nodal boundary in the caller's selected-node coordinates\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|