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

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

.in +1c
.ti -1c
.RI "\fBElementDisplacementData\fP (const mfem::FiniteElement &element, mfem::Vector &displacement_dofs)"
.br
.RI "Constructs an \fBElementDisplacementData\fP object with the given finite element and displacement degrees of freedom\&. "
.ti -1c
.RI "const mfem::FiniteElement & \fBget_element\fP () const noexcept"
.br
.RI "Returns the finite element associated with the displacement data\&. "
.ti -1c
.RI "const mfem::DenseMatrix & \fBget_dof_matrix\fP () const noexcept"
.br
.RI "Returns the degree of freedom matrix for the displacement data\&. "
.ti -1c
.RI "int \fBget_dimension\fP () const noexcept"
.br
.RI "Returns the dimension of the displacement data\&. "
.ti -1c
.RI "int \fBget_dof_count\fP () const noexcept"
.br
.RI "Returns the degree of freedom count for the displacement 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 displacement data\&. "
.ti -1c
.RI "mfem::DenseMatrix \fBm_dof_matrix\fP"
.br
.RI "Matrix representing the degrees of freedom for the displacement data\&. "
.ti -1c
.RI "int \fBm_dimension\fP"
.br
.RI "The dimension of the displacement data (number of components)\&. "
.in -1c
.SH "Detailed Description"
.PP 
A class representing the displacement data for a finite element, including the finite element, degree of freedom matrix, and dimension\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::mapping::ElementDisplacementData::ElementDisplacementData (const mfem::FiniteElement & element, mfem::Vector & displacement_dofs)"

.PP
Constructs an \fBElementDisplacementData\fP object with the given finite element and displacement degrees of freedom\&. 
.PP
\fBParameters\fP
.RS 4
\fIelement\fP The finite element associated with the displacement data\&. 
.br
\fIdisplacement_dofs\fP The element vector of displacement degrees of freedom, ordered by nodes within each component as MFEM element vdofs are\&.
.RE
.PP
\fBExceptions\fP
.RS 4
\fIstd::invalid_argument\fP if the finite element has zero or negative degrees of freedom, or if the size of the displacement_dofs vector is not a positive multiple of the element's degree of freedom count\&.
.RE
.PP
The dof matrix is populated such that for row i and column j, with n total dofs, dof_matrix(i, j) = displacement_dofs(i + j * n)\&. 
.SH "Member Function Documentation"
.PP 
.SS "int serif::mapping::ElementDisplacementData::get_dimension () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the dimension of the displacement data\&. 
.PP
\fBReturns\fP
.RS 4
The dimension of the displacement data\&. 
.RE
.PP

.SS "int serif::mapping::ElementDisplacementData::get_dof_count () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

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

.SS "const mfem::DenseMatrix & serif::mapping::ElementDisplacementData::get_dof_matrix () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the degree of freedom matrix for the displacement data\&. 
.PP
\fBReturns\fP
.RS 4
A constant reference to the degree of freedom matrix\&. 
.RE
.PP

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

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

.SH "Member Data Documentation"
.PP 
.SS "int serif::mapping::ElementDisplacementData::m_dimension\fR [private]\fP"

.PP
The dimension of the displacement data (number of components)\&. 
.SS "mfem::DenseMatrix serif::mapping::ElementDisplacementData::m_dof_matrix\fR [private]\fP"

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

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

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