Files
MeanField_SERiF/docs/man/man3/serif_discretization_backend_mfem_ScalarBoundaryTrace.3

112 lines
4.1 KiB
Groff
Raw Permalink Normal View History

.TH "serif::discretization::backend::mfem::ScalarBoundaryTrace" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::discretization::backend::mfem::ScalarBoundaryTrace \- An immutable scalar interpolation operator from supported coefficients to selected residual nodes\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <boundary_trace\&.hpp>\fP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "const \fBDofMap\fP & \fBbinding\fP () const noexcept"
.br
.RI "Return the borrowed input coefficient binding\&. "
.ti -1c
.RI "const \fBDofSelection\fP & \fBrows\fP () const noexcept"
.br
.RI "Return the owned selection defining the interpolation row ordering\&. "
.ti -1c
.RI "const ::mfem::SparseMatrix & \fBinterpolation\fP () const"
.br
.RI "Return the interpolation matrix after checking its borrowed discretization\&. "
.ti -1c
.RI "void \fBvalidate\fP () const"
.br
.RI "Reject stale mesh topology, finite-element bindings, or domain and boundary labels\&. "
.in -1c
.SS "Private Member Functions"
.in +1c
.ti -1c
.RI "\fBScalarBoundaryTrace\fP (std::shared_ptr< const \fBDofSelection\fP > \fBrows\fP, const \fBDofMap\fP &input, std::shared_ptr< const ::mfem::SparseMatrix > \fBinterpolation\fP)"
.br
.RI "Publish the completed matrix together with the bindings defining its coordinates\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "std::shared_ptr< const \fBDofSelection\fP > \fBm_rows\fP"
.br
.ti -1c
.RI "const \fBDofMap\fP & \fBm_binding\fP"
.br
.ti -1c
.RI "std::shared_ptr< const ::mfem::SparseMatrix > \fBm_interpolation\fP"
.br
.in -1c
.SS "Friends"
.in +1c
.ti -1c
.RI "\fBScalarBoundaryTrace\fP \fBdetail::build_boundary_trace\fP (std::shared_ptr< const \fBDofSelection\fP >, const \fBDofMap\fP &, const ::mfem::FiniteElementSpace *)"
.br
.in -1c
.SH "Detailed Description"
.PP
An immutable scalar interpolation operator from supported coefficients to selected residual nodes\&.
.PP
\fBNote\fP
.RS 4
Both term bindings must outlive the trace\&. The sparse matrix and selection are shared immutable data; the same matrix supplies the forward evaluation and its exact coordinate transpose without quadrature weights\&.
.RE
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::discretization::backend::mfem::ScalarBoundaryTrace::ScalarBoundaryTrace (std::shared_ptr< const \fBDofSelection\fP > rows, const \fBDofMap\fP & input, std::shared_ptr< const ::mfem::SparseMatrix > interpolation)\fR [private]\fP"
.PP
Publish the completed matrix together with the bindings defining its coordinates\&.
.SH "Member Function Documentation"
.PP
.SS "const \fBDofMap\fP & serif::discretization::backend::mfem::ScalarBoundaryTrace::binding () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Return the borrowed input coefficient binding\&.
.SS "const::mfem::SparseMatrix & serif::discretization::backend::mfem::ScalarBoundaryTrace::interpolation () const\fR [nodiscard]\fP"
.PP
Return the interpolation matrix after checking its borrowed discretization\&.
.SS "const \fBDofSelection\fP & serif::discretization::backend::mfem::ScalarBoundaryTrace::rows () const\fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Return the owned selection defining the interpolation row ordering\&.
.SS "void serif::discretization::backend::mfem::ScalarBoundaryTrace::validate () const"
.PP
Reject stale mesh topology, finite-element bindings, or domain and boundary labels\&.
.SH "Friends And Related Symbol Documentation"
.PP
.SS "\fBScalarBoundaryTrace\fP \fBdetail::build_boundary_trace\fP (std::shared_ptr< const \fBDofSelection\fP > , const \fBDofMap\fP & , const ::mfem::FiniteElementSpace * )\fR [friend]\fP"
.SH "Member Data Documentation"
.PP
.SS "const \fBDofMap\fP& serif::discretization::backend::mfem::ScalarBoundaryTrace::m_binding\fR [private]\fP"
.SS "std::shared_ptr<const ::mfem::SparseMatrix> serif::discretization::backend::mfem::ScalarBoundaryTrace::m_interpolation\fR [private]\fP"
.SS "std::shared_ptr<const \fBDofSelection\fP> serif::discretization::backend::mfem::ScalarBoundaryTrace::m_rows\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.