docs(docs): built docs

Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,64 @@
.TH "src/include/serif/backend/mfem/operators/element_evaluation.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/include/serif/backend/mfem/operators/element_evaluation.hpp
.SH SYNOPSIS
.br
.PP
\fR#include <array>\fP
.br
\fR#include <cmath>\fP
.br
\fR#include <span>\fP
.br
\fR#include 'serif/utils/error/nonfinite\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/operand_evaluation\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/element_data\&.hpp'\fP
.br
\fR#include 'serif/backend/mfem/operators/workspace\&.hpp'\fP
.br
\fR#include 'serif/operators/plan\&.hpp'\fP
.br
.SS "Namespaces"
.in +1c
.ti -1c
.RI "namespace \fBserif\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::backend\fP"
.br
.ti -1c
.RI "namespace \fBserif::operators::backend::mfem\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename ContributionT, std::size_t Count> void \fBserif::operators::backend::mfem::element_residual\fP (const \fBElementData\fP< Count > &data, \fB::mfem::Vector\fP &result, \fBBasisWorkspace\fP &workspace)"
.br
.RI "Integrate the cached scalar/vector physics against its actual test operation\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename ContributionT, bool Fields, bool Geometry> void \fBserif::operators::backend::mfem::finish_element_action\fP (const \fBElementData\fP< \fBEquationPlan\fP< EquationT >::operand_count > &data, const ::mfem::DenseMatrix &geometry_derivatives, \fBWorkspace\fP &workspace, \fB::mfem::Vector\fP &result)"
.br
.RI "Finish an element action from its field part (workspace\&.quadrature_values) and, with Geometry, the displacement samples (workspace\&.displacement_samples): contract the geometry derivatives and integrate\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename ContributionT, bool Fields = true, bool Geometry = true> void \fBserif::operators::backend::mfem::element_jacobian_action\fP (const \fBElementData\fP< \fBEquationPlan\fP< EquationT >::operand_count > &data, const ::mfem::DenseMatrix &geometry_derivatives, const std::array< \fBdiscretization::backend::mfem::DofMap::Elements\fP, \fBEquationPlan\fP< EquationT >::column_count > &columns, const std::array< const \fB::mfem::Vector\fP *, \fBEquationPlan\fP< EquationT >::column_count > &directions, const \fBdiscretization::backend::mfem::DofMap::Elements\fP &displacement_binding, const \fB::mfem::Vector\fP &displacement_direction, \fBWorkspace\fP &workspace, \fB::mfem::Vector\fP &result)"
.br
.RI "Apply the accepted field derivatives and local displacement derivatives\&. "
.ti -1c
.RI "template<VolumeEquation EquationT, typename ContributionT> void \fBserif::operators::backend::mfem::element_geometry_actions\fP (const \fBElementData\fP< \fBEquationPlan\fP< EquationT >::operand_count > &data, const ::mfem::DenseMatrix &geometry_derivatives, const \fBdiscretization::backend::mfem::DofMap::Elements\fP &displacement_binding, std::span< const \fB::mfem::Vector\fP *const > displacement_directions, \fBWorkspace\fP &workspace, std::span<\fB::mfem::Vector\fP *const > results)"
.br
.RI "element_jacobian_action<false, true> for several displacement directions of one element\&. "
.in -1c
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.