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

89 lines
3.5 KiB
Groff
Raw Normal View History

.TH "src/include/serif/backend/mfem/discretization/boundary_trace.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/discretization/boundary_trace.hpp \- File containing the definition of the restricted dof space for a scalar boundary trace\&. Note in FEM a trace is a restriction on a function to the boundary of a domain\&. Therefore, This file contains the definitions for getting the DOFs at the boundary of a scalar field\&.
.SH SYNOPSIS
.br
.PP
\fR#include <memory>\fP
.br
\fR#include <utility>\fP
.br
\fR#include 'mfem/linalg/sparsemat\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/discretization/dof_selection\&.hpp'\fP
.br
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBserif::discretization::backend::mfem::ScalarBoundaryTrace\fP"
.br
.RI "An immutable scalar interpolation operator from supported coefficients to selected residual nodes\&. "
.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
.ti -1c
.RI "namespace \fBserif::discretization::backend::mfem::detail\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBserif::discretization::backend::mfem::BoundaryTraceTerm\fP"
.br
.RI "Concept Limiting the input term to either a global scalar term or a spatial term of rank 0 in the H1 family\&. Outside of H1, the trace is a vector (e\&.g\&. the normal trace for a H(div) field or the tangential trace for a H(curl) field)\&. Further, for higher rank H1 fields the trace is a tensor\&. "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "\fBScalarBoundaryTrace\fP \fBserif::discretization::backend::mfem::detail::build_boundary_trace\fP (std::shared_ptr< const \fBDofSelection\fP > rows, const \fBDofMap\fP &input, const ::mfem::FiniteElementSpace *input_space)"
.br
.RI "Construct one interpolation operator in the selected residual-node ordering\&. "
.ti -1c
.RI "template<BoundaryTraceTerm TermT, domain::schema::IsSchema SchemaT> \fBScalarBoundaryTrace\fP \fBserif::discretization::backend::mfem::make_boundary_trace\fP (std::shared_ptr< const \fBDofSelection\fP > rows, const \fBTermBinding\fP< TermT, SchemaT > &input)"
.br
.RI "Sample a continuous scalar field at the selected nodal H1 residual points\&. "
.ti -1c
.RI "template<BoundaryTraceTerm TermT, domain::schema::IsSchema SchemaT> \fBScalarBoundaryTrace\fP \fBserif::discretization::backend::mfem::make_boundary_trace\fP (std::shared_ptr< const \fBDofSelection\fP >, \fBTermBinding\fP< TermT, SchemaT > &&)=delete"
.br
.RI "A trace borrows its input binding, so temporaries cannot supply its coefficient ordering\&. "
.ti -1c
.RI "template<BoundaryTraceTerm TermT, domain::schema::IsSchema SchemaT> \fBScalarBoundaryTrace\fP \fBserif::discretization::backend::mfem::make_boundary_trace\fP (std::shared_ptr< const \fBDofSelection\fP >, const \fBTermBinding\fP< TermT, SchemaT > &&)=delete"
.br
.RI "Const temporary bindings have the same lifetime restriction\&. "
.in -1c
.SH "Detailed Description"
.PP
File containing the definition of the restricted dof space for a scalar boundary trace\&. Note in FEM a trace is a restriction on a function to the boundary of a domain\&. Therefore, This file contains the definitions for getting the DOFs at the boundary of a scalar field\&.
.PP
\fBAuthor\fP
.RS 4
Emily M\&. Boudreaux
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.