.TH "serif::mapping::ElementCompactificationData" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::mapping::ElementCompactificationData \- A class representing the compactification data for a finite element, including the finite element and degrees of freedom\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <data\&.hpp>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBElementCompactificationData\fP (const mfem::FiniteElement &element, const mfem::Vector &dofs)"
.br
.RI "Constructs an \fBElementCompactificationData\fP object with the given finite element and degrees of freedom\&. "
.ti -1c
.RI "const mfem::FiniteElement & \fBget_element\fP () const noexcept"
.br
.RI "Returns the finite element associated with the compactification data\&. "
.ti -1c
.RI "const mfem::Vector & \fBget_dofs\fP () const noexcept"
.br
.RI "Returns the degrees of freedom for the compactification data\&. "
.ti -1c
.RI "int \fBget_dof_count\fP () const noexcept"
.br
.RI "Returns the degree of freedom count for the compactification data\&. "
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "const mfem::FiniteElement * \fBm_element\fP"
.br
.RI "Pointer to the finite element associated with the compactification data\&. "
.ti -1c
.RI "mfem::Vector \fBm_dofs\fP"
.br
.RI "\fBVector\fP representing the degrees of freedom for the compactification data\&. "
.in -1c
.SH "Detailed Description"
.PP 
A class representing the compactification data for a finite element, including the finite element and degrees of freedom\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::mapping::ElementCompactificationData::ElementCompactificationData (const mfem::FiniteElement & element, const mfem::Vector & dofs)"

.PP
Constructs an \fBElementCompactificationData\fP object with the given finite element and degrees of freedom\&. 
.PP
\fBParameters\fP
.RS 4
\fIelement\fP The finite element associated with the compactification data\&. 
.br
\fIdofs\fP The vector containing the degrees of freedom for the compactification data\&.
.RE
.PP
\fBExceptions\fP
.RS 4
\fIstd::invalid_argument\fP if the finite element is not a scalar finite element, does not provide a gradient, or has zero or negative degrees of freedom, or if the size of the dofs vector does not match the finite element's degree of freedom count\&. 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "int serif::mapping::ElementCompactificationData::get_dof_count () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the degree of freedom count for the compactification data\&. 
.PP
\fBReturns\fP
.RS 4
The degree of freedom count for the compactification data\&. 
.RE
.PP

.SS "const mfem::Vector & serif::mapping::ElementCompactificationData::get_dofs () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the degrees of freedom for the compactification data\&. 
.PP
\fBReturns\fP
.RS 4
A constant reference to the vector of degrees of freedom\&. 
.RE
.PP

.SS "const mfem::FiniteElement & serif::mapping::ElementCompactificationData::get_element () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the finite element associated with the compactification data\&. 
.PP
\fBReturns\fP
.RS 4
A constant reference to the finite element\&. 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "mfem::Vector serif::mapping::ElementCompactificationData::m_dofs\fR [private]\fP"

.PP
\fBVector\fP representing the degrees of freedom for the compactification data\&. 
.SS "const mfem::FiniteElement* serif::mapping::ElementCompactificationData::m_element\fR [private]\fP"

.PP
Pointer to the finite element associated with the compactification data\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.