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

62 lines
1.9 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/discretization/dof_selection.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/discretization/dof_selection.hpp \- This file contains the \fBDofSelection\fP which allows for the selection of a subset of DOFs from a term binding, with boundary attribute information\&.
.SH SYNOPSIS
.br
.PP
\fR#include 'serif/backend/mfem/discretization/term_binding\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/discretization/dof_map\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::discretization::backend::mfem::DofSelection\fP"
.br
.RI "A selection of supported DOFs from a term binding, with boundary attribute information\&. The purpose here is to allow for the selection of a subset of DOFs from a term binding, such as those associated with a particular boundary, while still retaining the ability to validate the selection against the underlying mesh and term binding\&. "
.in -1c
.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<domain::IsBoundary BoundaryT, blocks::SpatialTerm TermT, domain::schema::IsSchema SchemaT> \fBDofSelection\fP \fBserif::discretization::backend::mfem::select_boundary_dofs\fP (const \fBTermBinding\fP< TermT, SchemaT > &binding)"
.br
.RI "Select DOFs associated with a particular boundary from a term binding\&. "
.in -1c
.SH "Detailed Description"
.PP
This file contains the \fBDofSelection\fP which allows for the selection of a subset of DOFs from a term binding, with boundary attribute information\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.