serif::mapping::ElementCompactificationData Class Reference

A class representing the compactification data for a finite element, including the finite element and degrees of freedom. More...

#include <data.hpp>

Public Member Functions
	ElementCompactificationData (const mfem::FiniteElement &element, const mfem::Vector &dofs)
	Constructs an ElementCompactificationData object with the given finite element and degrees of freedom.
const mfem::FiniteElement &	get_element () const noexcept
	Returns the finite element associated with the compactification data.
const mfem::Vector &	get_dofs () const noexcept
	Returns the degrees of freedom for the compactification data.
int	get_dof_count () const noexcept
	Returns the degree of freedom count for the compactification data.

Private Attributes
const mfem::FiniteElement *	m_element
	Pointer to the finite element associated with the compactification data.
mfem::Vector	m_dofs
	Vector representing the degrees of freedom for the compactification data.

Detailed Description

A class representing the compactification data for a finite element, including the finite element and degrees of freedom.

Constructor & Destructor Documentation

ElementCompactificationData()

serif::mapping::ElementCompactificationData::ElementCompactificationData	(	const mfem::FiniteElement &	element,
		const mfem::Vector &	dofs )

Constructs an ElementCompactificationData object with the given finite element and degrees of freedom.

Parameters

element	The finite element associated with the compactification data.
dofs	The vector containing the degrees of freedom for the compactification data.

Exceptions

std::invalid_argument

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.

Member Function Documentation

get_dof_count()

int serif::mapping::ElementCompactificationData::get_dof_count ( ) const

nodiscardnoexcept

Returns the degree of freedom count for the compactification data.

Returns

The degree of freedom count for the compactification data.

get_dofs()

const mfem::Vector & serif::mapping::ElementCompactificationData::get_dofs ( ) const

nodiscardnoexcept

Returns the degrees of freedom for the compactification data.

Returns

A constant reference to the vector of degrees of freedom.

get_element()

const mfem::FiniteElement & serif::mapping::ElementCompactificationData::get_element ( ) const

nodiscardnoexcept

Returns the finite element associated with the compactification data.

Returns

A constant reference to the finite element.

Member Data Documentation

m_dofs

mfem::Vector serif::mapping::ElementCompactificationData::m_dofs

private

Vector representing the degrees of freedom for the compactification data.

m_element

const mfem::FiniteElement* serif::mapping::ElementCompactificationData::m_element

private

Pointer to the finite element associated with the compactification data.

---

The documentation for this class was generated from the following files:

• src/include/serif/backend/mfem/mapping/data.hpp
• src/lib/serif/backend/mfem/mapping/data.cpp