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)
58 lines
2.0 KiB
Groff
58 lines
2.0 KiB
Groff
.TH "src/include/serif/discretization/backend/mfem/point_dofs.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/discretization/backend/mfem/point_dofs.hpp \- This file contains the implementation of function select_point_dofs\&. This function is used to select the components from a single H1 vertex in the fixed computational mesh\&. This is used to implement point constraints in the discretization (e\&.g\&. fixed center of mass)
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <array>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include 'serif/discretization/backend/mfem/dof_selection\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::backend\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::discretization::backend::mfem\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<blocks::SpatialTerm TermT, domain::schema::IsSchema SchemaT>
|
|
.br
|
|
requires (\fBblocks::SpatialTermTraits\fP<TermT>::family == \fBfunctional_space::Family::h1\fP)\fBDofSelection\fP \fBserif::discretization::backend::mfem::select_point_dofs\fP (const \fBTermBinding\fP< TermT, SchemaT > &binding, const std::array< double, 3 > &position={}, const double tolerance=1\&.0e\-12)"
|
|
.br
|
|
.RI "Select the dofs associated with a single point in the reference domain\&. This is used to implement point constraints in the discretization (e\&.g\&. fixed center of mass)\&. Note that this function only works for H1 terms and will throw an error if used on a non-H1 term\&. "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
This file contains the implementation of function select_point_dofs\&. This function is used to select the components from a single H1 vertex in the fixed computational mesh\&. This is used to implement point constraints in the discretization (e\&.g\&. fixed center of mass)
|
|
|
|
|
|
.PP
|
|
\fBAuthor\fP
|
|
.RS 4
|
|
Emily M\&. Boudreaux
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|